The SequenceStarNode is used to tick children in an ordered sequence. If any child returns RUNNING, previous children are not ticked again. More...
#include <sequence_star_node.h>
Inheritance diagram for BT::SequenceStarNode:
Public Member Functions | |
| virtual void | halt () override |
| SequenceStarNode (const std::string &name) | |
| virtual | ~SequenceStarNode () 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 TreeNode * | child (unsigned index) const |
| const std::vector< TreeNode * > & | children () const |
| unsigned | childrenCount () const |
| ControlNode (const std::string &name, const NodeConfiguration &config) | |
| void | haltChildren (unsigned i) |
| call halt() for all the children in the range [i, childrenCount() ) More... | |
| virtual NodeType | type () const overridefinal |
| virtual | ~ControlNode () override=default |
| Public Member Functions inherited from BT::TreeNode | |
| const NodeConfiguration & | config () const |
| virtual BT::NodeStatus | executeTick () |
| The method that should be used to invoke tick() and setStatus();. More... | |
| template<typename T > | |
| Result | getInput (const std::string &key, T &destination) const |
| template<typename T > | |
| Optional< T > | getInput (const std::string &key) const |
| bool | isHalted () const |
| const std::string & | name () const |
| Name of the instance, not the type. More... | |
| const std::string & | registrationName () const |
| registrationName is the ID used by BehaviorTreeFactory to create an instance. More... | |
| template<typename T > | |
| Result | setOutput (const std::string &key, const T &value) |
| 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 (std::string name, NodeConfiguration config) | |
| 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... | |
Private Attributes | |
| unsigned int | current_child_idx_ |
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 Optional< StringView > | getRemappedKey (StringView port_name, StringView remapping_value) |
| static bool | isBlackboardPointer (StringView str) |
| static StringView | stripBlackboardPointer (StringView str) |
| Protected Member Functions inherited from BT::TreeNode | |
| void | modifyPortsRemapping (const PortsRemapping &new_remapping) |
| void | setRegistrationID (StringView ID) |
| Protected Attributes inherited from BT::ControlNode | |
| std::vector< TreeNode * > | children_nodes_ |
Detailed Description
The SequenceStarNode is used to tick children in an ordered sequence. If any child returns RUNNING, previous children are not ticked again.
- If all the children return SUCCESS, this node returns SUCCESS.
- If a child returns RUNNING, this node returns RUNNING. Loop is NOT restarted, the same running child will be ticked again.
- If a child returns FAILURE, stop the loop and return FAILURE. Loop is NOT restarted, the same running child will be ticked again.
Definition at line 35 of file sequence_star_node.h.
Constructor & Destructor Documentation
| BT::SequenceStarNode::SequenceStarNode | ( | const std::string & | name | ) |
Definition at line 19 of file sequence_star_node.cpp.
|
overridevirtualdefault |
Member Function Documentation
|
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 71 of file sequence_star_node.cpp.
|
overrideprivatevirtual |
Method to be implemented by the user.
Implements BT::TreeNode.
Definition at line 26 of file sequence_star_node.cpp.
Member Data Documentation
|
private |
Definition at line 46 of file sequence_star_node.h.
The documentation for this class was generated from the following files: