The SequenceStarNode is used to execute a sequence of children. If any child returns RUNNING, previous children are not ticked again. More...
#include <sequence_star_node.h>
Public Member Functions | |
| virtual void | halt () override |
| The method used to interrupt the execution of a RUNNING node. | |
| SequenceStarNode (const std::string &name, bool reset_on_failure=true) | |
| SequenceStarNode (const std::string &name, const NodeParameters ¶ms) | |
| virtual | ~SequenceStarNode () override |
Static Public Member Functions | |
| static const NodeParameters & | requiredNodeParameters () |
Private Member Functions | |
| virtual BT::NodeStatus | tick () override |
| Method to be implemented by the user. | |
Private Attributes | |
| unsigned int | current_child_idx_ |
| bool | read_parameter_from_blackboard_ |
| bool | reset_on_failure_ |
Static Private Attributes | |
| static constexpr const char * | RESET_PARAM = "reset_on_failure" |
Detailed Description
The SequenceStarNode is used to execute a sequence of children. 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 returns FAILURE. Restart the loop only if (reset_on_failure == true)
Definition at line 35 of file sequence_star_node.h.
Constructor & Destructor Documentation
| BT::SequenceStarNode::SequenceStarNode | ( | const std::string & | name, |
| bool | reset_on_failure = true |
||
| ) |
Definition at line 21 of file sequence_star_node.cpp.
| BT::SequenceStarNode::SequenceStarNode | ( | const std::string & | name, |
| const NodeParameters & | params | ||
| ) |
Definition at line 30 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.
Reimplemented from BT::ControlNode.
Definition at line 104 of file sequence_star_node.cpp.
| static const NodeParameters& BT::SequenceStarNode::requiredNodeParameters | ( | ) | [inline, static] |
Definition at line 47 of file sequence_star_node.h.
| NodeStatus BT::SequenceStarNode::tick | ( | ) | [override, private, virtual] |
Method to be implemented by the user.
Implements BT::TreeNode.
Definition at line 44 of file sequence_star_node.cpp.
Member Data Documentation
unsigned int BT::SequenceStarNode::current_child_idx_ [private] |
Definition at line 54 of file sequence_star_node.h.
bool BT::SequenceStarNode::read_parameter_from_blackboard_ [private] |
Definition at line 57 of file sequence_star_node.h.
bool BT::SequenceStarNode::reset_on_failure_ [private] |
Definition at line 55 of file sequence_star_node.h.
constexpr const char * BT::SequenceStarNode::RESET_PARAM = "reset_on_failure" [static, private] |
Definition at line 58 of file sequence_star_node.h.
The documentation for this class was generated from the following files: