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

#include <repeat_node.h>

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

Public Member Functions

 RepeatNode (const std::string &name, unsigned int NTries)
 
 RepeatNode (const std::string &name, const NodeParameters &params)
 
virtual ~RepeatNode () override=default
 
- Public Member Functions inherited from BT::DecoratorNode
const TreeNodechild () const
 
TreeNodechild ()
 
 DecoratorNode (const std::string &name, const NodeParameters &parameters)
 
NodeStatus executeTick () override
 The method that will be executed to invoke tick(); and setStatus();. More...
 
void haltChild ()
 
void setChild (TreeNode *child)
 
virtual NodeType type () const override
 
virtual ~DecoratorNode () override=default
 
- Public Member Functions inherited from BT::TreeNode
const Blackboard::Ptrblackboard () const
 
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

void halt () override
 The method used to interrupt the execution of a RUNNING node. More...
 
virtual NodeStatus tick () override
 Method to be implemented by the user. More...
 

Private Attributes

unsigned num_cycles_
 
bool read_parameter_from_blackboard_
 
unsigned try_index_
 

Static Private Attributes

static constexpr const char * NUM_CYCLES = "num_cycles"
 

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::DecoratorNode
TreeNodechild_node_
 

Detailed Description

Definition at line 21 of file repeat_node.h.

Constructor & Destructor Documentation

BT::RepeatNode::RepeatNode ( const std::string &  name,
unsigned int  NTries 
)

Definition at line 20 of file repeat_node.cpp.

BT::RepeatNode::RepeatNode ( const std::string &  name,
const NodeParameters params 
)

Definition at line 29 of file repeat_node.cpp.

virtual BT::RepeatNode::~RepeatNode ( )
overridevirtualdefault

Member Function Documentation

void BT::RepeatNode::halt ( )
overrideprivatevirtual

The method used to interrupt the execution of a RUNNING node.

Reimplemented from BT::DecoratorNode.

Definition at line 89 of file repeat_node.cpp.

static const NodeParameters& BT::RepeatNode::requiredNodeParameters ( )
inlinestatic

Definition at line 31 of file repeat_node.h.

NodeStatus BT::RepeatNode::tick ( )
overrideprivatevirtual

Method to be implemented by the user.

Implements BT::TreeNode.

Definition at line 44 of file repeat_node.cpp.

Member Data Documentation

constexpr const char * BT::RepeatNode::NUM_CYCLES = "num_cycles"
staticprivate

Definition at line 42 of file repeat_node.h.

unsigned BT::RepeatNode::num_cycles_
private

Definition at line 38 of file repeat_node.h.

bool BT::RepeatNode::read_parameter_from_blackboard_
private

Definition at line 41 of file repeat_node.h.

unsigned BT::RepeatNode::try_index_
private

Definition at line 39 of file repeat_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