BT::ParallelNode Class Reference

#include <parallel_node.h>

Inheritance diagram for BT::ParallelNode:

Public Member Functions
virtual void	halt () override
	The method used to interrupt the execution of a RUNNING node. More...
	ParallelNode (const std::string &name, int threshold)
	ParallelNode (const std::string &name, const NodeParameters &params)
void	setThresholdM (unsigned int threshold_M)
unsigned int	thresholdM ()
	~ParallelNode ()=default
Public Member Functions inherited from BT::ControlNode
void	addChild (TreeNode *child)
const TreeNode *	child (unsigned index) const
const std::vector< TreeNode * > &	children () const
unsigned int	childrenCount () const
	ControlNode (const std::string &name, const NodeParameters &parameters)
void	haltChildren (int i)
virtual NodeType	type () const overridefinal
virtual	~ControlNode () override=default
Public Member Functions inherited from BT::TreeNode
const Blackboard::Ptr &	blackboard () const
virtual BT::NodeStatus	executeTick ()
	The method that will be executed to invoke tick(); and setStatus();. More...
template<typename T >
BT::optional< T >	getParam (const std::string &key) const
template<typename T >
bool	getParam (const std::string &key, T &destination) const
const NodeParameters &	initializationParameters () const
bool	isHalted () const
const std::string &	name () const
const std::string &	registrationName () const
	registrationName is the ID used by BehaviorTreeFactory to create an instance. More...
void	setBlackboard (const Blackboard::Ptr &bb)
void	setStatus (NodeStatus new_status)
NodeStatus	status () const
StatusChangeSubscriber	subscribeToStatusChange (StatusChangeCallback callback)
	subscribeToStatusChange is used to attach a callback to a status change. When StatusChangeSubscriber goes out of scope (it is a shared_ptr) the callback is unsubscribed automatically. More...
	TreeNode (const std::string &name, const NodeParameters &parameters)
	TreeNode main constructor. More...
uint16_t	UID () const
BT::NodeStatus	waitValidStatus ()
virtual	~TreeNode ()=default

Static Public Member Functions
static const NodeParameters &	requiredNodeParameters ()
Static Public Member Functions inherited from BT::TreeNode
static bool	isBlackboardPattern (StringView str)

Private Member Functions
virtual BT::NodeStatus	tick () override
	Method to be implemented by the user. More...

Private Attributes
unsigned int	failure_childred_num_
bool	read_parameter_from_blackboard_
unsigned int	success_childred_num_
unsigned int	threshold_

Static Private Attributes
static constexpr const char *	THRESHOLD_KEY = "threshold"

Additional Inherited Members
Public Types inherited from BT::TreeNode
typedef std::shared_ptr< TreeNode >	Ptr
using	StatusChangeCallback = StatusChangeSignal::CallableFunction
using	StatusChangeSignal = Signal< TimePoint, const TreeNode &, NodeStatus, NodeStatus >
using	StatusChangeSubscriber = StatusChangeSignal::Subscriber
Protected Member Functions inherited from BT::TreeNode
void	initializeOnce ()
void	setRegistrationName (const std::string &registration_name)
	registrationName() is set by the BehaviorTreeFactory More...
Protected Attributes inherited from BT::ControlNode
std::vector< TreeNode * >	children_nodes_

Detailed Description

Definition at line 21 of file parallel_node.h.

Constructor & Destructor Documentation

BT::ParallelNode::ParallelNode	(	const std::string &	name,
		int	threshold
	)

Definition at line 21 of file parallel_node.cpp.

BT::ParallelNode::ParallelNode	(	const std::string &	name,
		const NodeParameters &	params
	)

Definition at line 29 of file parallel_node.cpp.

BT::ParallelNode::~ParallelNode ( )

default

Member Function Documentation

void BT::ParallelNode::halt ( )

overridevirtual

The method used to interrupt the execution of a RUNNING node.

Reimplemented from BT::ControlNode.

Definition at line 100 of file parallel_node.cpp.

static const NodeParameters& BT::ParallelNode::requiredNodeParameters ( )

inlinestatic

Definition at line 29 of file parallel_node.h.

void BT::ParallelNode::setThresholdM

(

unsigned int

threshold_M

)

Definition at line 112 of file parallel_node.cpp.

unsigned int BT::ParallelNode::thresholdM

(

)

Definition at line 107 of file parallel_node.cpp.

NodeStatus BT::ParallelNode::tick ( )

overrideprivatevirtual

Method to be implemented by the user.

Implements BT::TreeNode.

Definition at line 44 of file parallel_node.cpp.

Member Data Documentation

unsigned int BT::ParallelNode::failure_childred_num_

private

Definition at line 45 of file parallel_node.h.

bool BT::ParallelNode::read_parameter_from_blackboard_

private

Definition at line 47 of file parallel_node.h.

unsigned int BT::ParallelNode::success_childred_num_

private

Definition at line 44 of file parallel_node.h.

unsigned int BT::ParallelNode::threshold_

private

Definition at line 43 of file parallel_node.h.

constexpr const char * BT::ParallelNode::THRESHOLD_KEY = "threshold"

staticprivate

Definition at line 48 of file parallel_node.h.

---

The documentation for this class was generated from the following files:

• parallel_node.h
• parallel_node.cpp