Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
BT::SequenceStarNode Class Reference

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>

Inheritance diagram for BT::SequenceStarNode:
Inheritance graph
[legend]

Public Member Functions

virtual void halt () override
 The method used to interrupt the execution of a RUNNING node. More...
 
 SequenceStarNode (const std::string &name, bool reset_on_failure=true)
 
 SequenceStarNode (const std::string &name, const NodeParameters &params)
 
virtual ~SequenceStarNode () override=default
 
- Public Member Functions inherited from BT::ControlNode
void addChild (TreeNode *child)
 
const TreeNodechild (unsigned index) const
 
const std::vector< TreeNode * > & children () const
 
unsigned int childrenCount () const
 
 ControlNode (const std::string &name, const NodeParameters &parameters)
 
void haltChildren (int i)
 
virtual NodeType type () const overridefinal
 
virtual ~ControlNode () override=default
 
- Public Member Functions inherited from BT::TreeNode
const Blackboard::Ptrblackboard () const
 
virtual BT::NodeStatus executeTick ()
 The method that will be executed to invoke tick(); and setStatus();. More...
 
template<typename T >
BT::optional< T > getParam (const std::string &key) const
 
template<typename T >
bool getParam (const std::string &key, T &destination) const
 
const NodeParametersinitializationParameters () const
 
bool isHalted () const
 
const std::string & name () const
 
const std::string & registrationName () const
 registrationName is the ID used by BehaviorTreeFactory to create an instance. More...
 
void setBlackboard (const Blackboard::Ptr &bb)
 
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 (const std::string &name, const NodeParameters &parameters)
 TreeNode main constructor. More...
 
uint16_t UID () const
 
BT::NodeStatus waitValidStatus ()
 
virtual ~TreeNode ()=default
 

Static Public Member Functions

static const NodeParametersrequiredNodeParameters ()
 
- Static Public Member Functions inherited from BT::TreeNode
static bool isBlackboardPattern (StringView str)
 

Private Member Functions

virtual BT::NodeStatus tick () override
 Method to be implemented by the user. More...
 

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"
 

Additional Inherited Members

- Public Types inherited from BT::TreeNode
typedef std::shared_ptr< TreeNodePtr
 
using StatusChangeCallback = StatusChangeSignal::CallableFunction
 
using StatusChangeSignal = Signal< TimePoint, const TreeNode &, NodeStatus, NodeStatus >
 
using StatusChangeSubscriber = StatusChangeSignal::Subscriber
 
- Protected Member Functions inherited from BT::TreeNode
void initializeOnce ()
 
void setRegistrationName (const std::string &registration_name)
 registrationName() is set by the BehaviorTreeFactory More...
 
- Protected Attributes inherited from BT::ControlNode
std::vector< TreeNode * > children_nodes_
 

Detailed Description

The SequenceStarNode is used to execute a sequence of children. If any child returns RUNNING, previous children are not ticked again.

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 ( )
overridevirtualdefault

Member Function Documentation

void BT::SequenceStarNode::halt ( )
overridevirtual

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 ( )
inlinestatic

Definition at line 47 of file sequence_star_node.h.

NodeStatus BT::SequenceStarNode::tick ( )
overrideprivatevirtual

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"
staticprivate

Definition at line 58 of file sequence_star_node.h.


The documentation for this class was generated from the following files:


behaviortree_cpp
Author(s): Michele Colledanchise, Davide Faconti
autogenerated on Sun Feb 3 2019 03:14:33