Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
BT::ParallelNode Class Reference

The ParallelNode execute all its children concurrently, but not in separate threads! More...

#include <parallel_node.h>

Inheritance diagram for BT::ParallelNode:
Inheritance graph
[legend]

Public Member Functions

size_t failureThreshold () const
 
virtual void halt () override
 
 ParallelNode (const std::string &name)
 
 ParallelNode (const std::string &name, const NodeConfig &config)
 
void setFailureThreshold (int threshold)
 
void setSuccessThreshold (int threshold)
 
size_t successThreshold () const
 
 ~ParallelNode () override=default
 
- Public Member Functions inherited from BT::ControlNode
void addChild (TreeNode *child)
 The method used to add nodes to the children vector. More...
 
const TreeNodechild (size_t index) const
 
const std::vector< TreeNode * > & children () const
 
size_t childrenCount () const
 
 ControlNode (const std::string &name, const NodeConfig &config)
 
void haltChild (size_t i)
 
void haltChildren ()
 same as resetChildren() More...
 
void haltChildren (size_t first)
 
void resetChildren ()
 
virtual NodeType type () const override final
 
virtual ~ControlNode () override=default
 
- Public Member Functions inherited from BT::TreeNode
const NodeConfigconfig () const
 
void emitWakeUpSignal ()
 Notify that the tree should be ticked again() More...
 
virtual BT::NodeStatus executeTick ()
 The method that should be used to invoke tick() and setStatus();. More...
 
const std::string & fullPath () const
 
template<typename T >
Expected< T > getInput (const std::string &key) const
 
template<typename T >
Result getInput (const std::string &key, T &destination) const
 
template<typename T >
Expected< StampedValue< T > > getInputStamped (const std::string &key) const
 
template<typename T >
Expected< TimestampgetInputStamped (const std::string &key, T &destination) const
 getInputStamped is similar to getInput(dey, destination), but it returne also the Timestamp object, that can be used to check if a value was updated and when. More...
 
AnyPtrLocked getLockedPortContent (const std::string &key)
 getLockedPortContent should be used when: More...
 
StringView getRawPortValue (const std::string &key) const
 
void haltNode ()
 
bool isHalted () const
 
const std::string & name () const
 Name of the instance, not the type. More...
 
TreeNodeoperator= (const TreeNode &other)=delete
 
TreeNodeoperator= (TreeNode &&other) noexcept
 
const std::string & registrationName () const
 registrationName is the ID used by BehaviorTreeFactory to create an instance. More...
 
bool requiresWakeUp () const
 
template<typename T >
Result setOutput (const std::string &key, const T &value)
 setOutput modifies the content of an Output port More...
 
void setPostTickFunction (PostTickCallback callback)
 
void setPreTickFunction (PreTickCallback callback)
 
void setTickMonitorCallback (TickMonitorCallback callback)
 
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 TreeNode &other)=delete
 
 TreeNode (std::string name, NodeConfig config)
 TreeNode main constructor. More...
 
 TreeNode (TreeNode &&other) noexcept
 
uint16_t UID () const
 
BT::NodeStatus waitValidStatus ()
 
virtual ~TreeNode ()
 

Static Public Member Functions

static PortsList providedPorts ()
 
- Static Public Member Functions inherited from BT::TreeNode
static Expected< StringViewgetRemappedKey (StringView port_name, StringView remapped_port)
 
template<class DerivedT , typename... ExtraArgs>
static std::unique_ptr< TreeNodeInstantiate (const std::string &name, const NodeConfig &config, ExtraArgs... args)
 
static bool isBlackboardPointer (StringView str, StringView *stripped_pointer=nullptr)
 Check a string and return true if it matches the pattern: {...}. More...
 
static StringView stripBlackboardPointer (StringView str)
 

Private Member Functions

void clear ()
 
virtual BT::NodeStatus tick () override
 Method to be implemented by the user. More...
 

Private Attributes

std::set< size_t > completed_list_
 
size_t failure_count_ = 0
 
int failure_threshold_
 
bool read_parameter_from_ports_
 
size_t success_count_ = 0
 
int success_threshold_
 

Static Private Attributes

static constexpr const char * THRESHOLD_FAILURE = "failure_count"
 
static constexpr const char * THRESHOLD_SUCCESS = "success_count"
 

Additional Inherited Members

- Public Types inherited from BT::TreeNode
using PostTickCallback = std::function< NodeStatus(TreeNode &, NodeStatus)>
 
using PreTickCallback = std::function< NodeStatus(TreeNode &)>
 
typedef std::shared_ptr< TreeNodePtr
 
using StatusChangeCallback = StatusChangeSignal::CallableFunction
 
using StatusChangeSignal = Signal< TimePoint, const TreeNode &, NodeStatus, NodeStatus >
 
using StatusChangeSubscriber = StatusChangeSignal::Subscriber
 
using TickMonitorCallback = std::function< void(TreeNode &, NodeStatus, std::chrono::microseconds)>
 
- Protected Types inherited from BT::TreeNode
using PostScripts = std::array< ScriptFunction, size_t(PostCond::COUNT_)>
 
using PreScripts = std::array< ScriptFunction, size_t(PreCond::COUNT_)>
 
- Protected Member Functions inherited from BT::TreeNode
NodeConfigconfig ()
 
void modifyPortsRemapping (const PortsRemapping &new_remapping)
 
template<typename T >
parseString (const std::string &str) const
 
PostScriptspostConditionsScripts ()
 
PreScriptspreConditionsScripts ()
 
void resetStatus ()
 Set the status to IDLE. More...
 
void setRegistrationID (StringView ID)
 
void setStatus (NodeStatus new_status)
 setStatus changes the status of the node. it will throw if you try to change the status to IDLE, because your parent node should do that, not the user! More...
 
void setWakeUpInstance (std::shared_ptr< WakeUpSignal > instance)
 
- Protected Attributes inherited from BT::ControlNode
std::vector< TreeNode * > children_nodes_
 

Detailed Description

The ParallelNode execute all its children concurrently, but not in separate threads!

Even if this may look similar to ReactiveSequence, this Control Node is the only one that can have multiple children RUNNING at the same time.

The Node is completed either when the THRESHOLD_SUCCESS or THRESHOLD_FAILURE number is reached (both configured using ports).

If any of the thresholds is reached, and other children are still running, they will be halted.

Note that threshold indexes work as in Python: https://www.i2tutorials.com/what-are-negative-indexes-and-why-are-they-used/

Therefore -1 is equivalent to the number of children.

Definition at line 40 of file parallel_node.h.

Constructor & Destructor Documentation

◆ ParallelNode() [1/2]

BT::ParallelNode::ParallelNode ( const std::string &  name)

Definition at line 24 of file parallel_node.cpp.

◆ ParallelNode() [2/2]

BT::ParallelNode::ParallelNode ( const std::string &  name,
const NodeConfig config 
)

Definition at line 33 of file parallel_node.cpp.

◆ ~ParallelNode()

BT::ParallelNode::~ParallelNode ( )
overridedefault

Member Function Documentation

◆ clear()

void BT::ParallelNode::clear ( )
private

Definition at line 134 of file parallel_node.cpp.

◆ failureThreshold()

size_t BT::ParallelNode::failureThreshold ( ) const

Definition at line 159 of file parallel_node.cpp.

◆ halt()

void BT::ParallelNode::halt ( )
overridevirtual

The method used to interrupt the execution of a RUNNING node. Only Async nodes that may return RUNNING should implement it.

Reimplemented from BT::ControlNode.

Definition at line 141 of file parallel_node.cpp.

◆ providedPorts()

static PortsList BT::ParallelNode::providedPorts ( )
inlinestatic

Definition at line 47 of file parallel_node.h.

◆ setFailureThreshold()

void BT::ParallelNode::setFailureThreshold ( int  threshold)

Definition at line 176 of file parallel_node.cpp.

◆ setSuccessThreshold()

void BT::ParallelNode::setSuccessThreshold ( int  threshold)

Definition at line 171 of file parallel_node.cpp.

◆ successThreshold()

size_t BT::ParallelNode::successThreshold ( ) const

Definition at line 147 of file parallel_node.cpp.

◆ tick()

NodeStatus BT::ParallelNode::tick ( )
overrideprivatevirtual

Method to be implemented by the user.

Implements BT::TreeNode.

Definition at line 40 of file parallel_node.cpp.

Member Data Documentation

◆ completed_list_

std::set<size_t> BT::ParallelNode::completed_list_
private

Definition at line 70 of file parallel_node.h.

◆ failure_count_

size_t BT::ParallelNode::failure_count_ = 0
private

Definition at line 73 of file parallel_node.h.

◆ failure_threshold_

int BT::ParallelNode::failure_threshold_
private

Definition at line 68 of file parallel_node.h.

◆ read_parameter_from_ports_

bool BT::ParallelNode::read_parameter_from_ports_
private

Definition at line 75 of file parallel_node.h.

◆ success_count_

size_t BT::ParallelNode::success_count_ = 0
private

Definition at line 72 of file parallel_node.h.

◆ success_threshold_

int BT::ParallelNode::success_threshold_
private

Definition at line 67 of file parallel_node.h.

◆ THRESHOLD_FAILURE

constexpr const char * BT::ParallelNode::THRESHOLD_FAILURE = "failure_count"
staticconstexprprivate

Definition at line 77 of file parallel_node.h.

◆ THRESHOLD_SUCCESS

constexpr const char * BT::ParallelNode::THRESHOLD_SUCCESS = "success_count"
staticconstexprprivate

Definition at line 76 of file parallel_node.h.


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


behaviortree_cpp_v4
Author(s): Davide Faconti
autogenerated on Fri Jun 28 2024 02:20:09