WhileDoElse must have exactly 2 or 3 children. It is a REACTIVE node of IfThenElseNode. More...
#include <while_do_else_node.h>
Public Member Functions | |
| virtual void | halt () override |
| WhileDoElseNode (const std::string &name) | |
| virtual | ~WhileDoElseNode () 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 (size_t index) const |
| const std::vector< TreeNode * > & | children () const |
| size_t | childrenCount () const |
| ControlNode (const std::string &name, const NodeConfiguration &config) | |
| void | haltChild (size_t i) |
| void | haltChildren () |
| void | haltChildren (size_t first) |
| 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 |
| StringView | getRawPortValue (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) |
| 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... | |
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) |
| void | setStatus (NodeStatus new_status) |
| Protected Attributes inherited from BT::ControlNode | |
| std::vector< TreeNode * > | children_nodes_ |
Detailed Description
WhileDoElse must have exactly 2 or 3 children. It is a REACTIVE node of IfThenElseNode.
The first child is the "statement" that is executed at each tick
If result is SUCCESS, the second child is executed.
If result is FAILURE, the third child is executed.
If the 2nd or 3d child is RUNNING and the statement changes, the RUNNING child will be stopped before starting the sibling.
Definition at line 34 of file while_do_else_node.h.
Constructor & Destructor Documentation
| BT::WhileDoElseNode::WhileDoElseNode | ( | const std::string & | name | ) |
Definition at line 19 of file while_do_else_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 25 of file while_do_else_node.cpp.
|
overrideprivatevirtual |
Method to be implemented by the user.
Implements BT::TreeNode.
Definition at line 30 of file while_do_else_node.cpp.
The documentation for this class was generated from the following files: