The SequenceNode is used to execute a sequence of children. If any child returns RUNNING, previous children will be ticked again. More...
#include <sequence_node.h>
Inheritance diagram for BT::SequenceNode:
Public Member Functions | |
| SequenceNode (const std::string &name) | |
| virtual | ~SequenceNode () override=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 ¶meters) | |
| virtual void | halt () override |
| The method used to interrupt the execution of a RUNNING node. More... | |
| 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 ¶meters) | |
| TreeNode main constructor. More... | |
| uint16_t | UID () const |
| BT::NodeStatus | waitValidStatus () |
| virtual | ~TreeNode ()=default |
Private Member Functions | |
| virtual BT::NodeStatus | tick () override |
| Method to be implemented by the user. More... | |
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 |
| Static Public Member Functions inherited from BT::TreeNode | |
| static bool | isBlackboardPattern (StringView str) |
| Protected Member Functions inherited from BT::TreeNode | |
| void | initializeOnce () |
| void | setRegistrationName (const std::string ®istration_name) |
| registrationName() is set by the BehaviorTreeFactory More... | |
| Protected Attributes inherited from BT::ControlNode | |
| std::vector< TreeNode * > | children_nodes_ |
Detailed Description
The SequenceNode is used to execute a sequence of children. If any child returns RUNNING, previous children will be ticked again.
- If all the children return SUCCESS, this node returns SUCCESS.
- If a child returns RUNNING, this node returns RUNNING. The loop is restarted, but already completed children are not halted. This generally implies that ConditionNode are ticked again.
- If a child returns FAILURE, stop the loop and returns FAILURE.
Definition at line 34 of file sequence_node.h.
Constructor & Destructor Documentation
| BT::SequenceNode::SequenceNode | ( | const std::string & | name | ) |
Definition at line 18 of file sequence_node.cpp.
|
overridevirtualdefault |
Member Function Documentation
|
overrideprivatevirtual |
Method to be implemented by the user.
Implements BT::TreeNode.
Definition at line 24 of file sequence_node.cpp.
The documentation for this class was generated from the following files: