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>
Public Member Functions | |
| virtual void | halt () override |
| SequenceStarNode (const std::string &name) | |
| virtual | ~SequenceStarNode () override |
Private Member Functions | |
| virtual BT::NodeStatus | tick () override |
| Method to be implemented by the user. | |
Private Attributes | |
| unsigned int | current_child_idx_ |
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.
| virtual BT::SequenceStarNode::~SequenceStarNode | ( | ) | [override, virtual] |
Member Function Documentation
| void BT::SequenceStarNode::halt | ( | ) | [override, virtual] |
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.
| NodeStatus BT::SequenceStarNode::tick | ( | ) | [override, private, virtual] |
Method to be implemented by the user.
Implements BT::TreeNode.
Definition at line 26 of file sequence_star_node.cpp.
Member Data Documentation
unsigned int BT::SequenceStarNode::current_child_idx_ [private] |
Definition at line 46 of file sequence_star_node.h.
The documentation for this class was generated from the following files: