The SequenceNode is used to tick children in an ordered sequence. If any child returns RUNNING, previous children will NOT be ticked again. More...
#include <sequence_node.h>
Public Member Functions | |
| virtual void | halt () override |
| SequenceNode (const std::string &name) | |
| virtual | ~SequenceNode () 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 SequenceNode is used to tick children in an ordered sequence. If any child returns RUNNING, previous children will NOT be 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. Restart the loop only if (reset_on_failure == true)
Definition at line 34 of file sequence_node.h.
Constructor & Destructor Documentation
| BT::SequenceNode::SequenceNode | ( | const std::string & | name | ) |
Definition at line 21 of file sequence_node.cpp.
| virtual BT::SequenceNode::~SequenceNode | ( | ) | [override, virtual] |
Member Function Documentation
| void BT::SequenceNode::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 28 of file sequence_node.cpp.
| NodeStatus BT::SequenceNode::tick | ( | ) | [override, private, virtual] |
Method to be implemented by the user.
Implements BT::TreeNode.
Definition at line 34 of file sequence_node.cpp.
Member Data Documentation
unsigned int BT::SequenceNode::current_child_idx_ [private] |
Definition at line 44 of file sequence_node.h.
The documentation for this class was generated from the following files: