Public Member Functions | Protected Attributes | List of all members
BT::DecoratorNode Class Reference

#include <decorator_node.h>

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

Public Member Functions

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...
 
virtual void halt () override
 The method used to interrupt the execution of a RUNNING node. 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
 

Protected Attributes

TreeNodechild_node_
 

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
 
- Static Public Member Functions inherited from BT::TreeNode
static bool isBlackboardPattern (StringView str)
 
- Protected Member Functions inherited from BT::TreeNode
void initializeOnce ()
 
void setRegistrationName (const std::string &registration_name)
 registrationName() is set by the BehaviorTreeFactory More...
 
virtual BT::NodeStatus tick ()=0
 Method to be implemented by the user. More...
 

Detailed Description

Definition at line 8 of file decorator_node.h.

Constructor & Destructor Documentation

BT::DecoratorNode::DecoratorNode ( const std::string &  name,
const NodeParameters parameters 
)

Definition at line 17 of file decorator_node.cpp.

virtual BT::DecoratorNode::~DecoratorNode ( )
overridevirtualdefault

Member Function Documentation

const TreeNode * BT::DecoratorNode::child ( ) const

Definition at line 41 of file decorator_node.cpp.

TreeNode * BT::DecoratorNode::child ( )

Definition at line 46 of file decorator_node.cpp.

NodeStatus BT::DecoratorNode::executeTick ( )
overridevirtual

The method that will be executed to invoke tick(); and setStatus();.

Reimplemented from BT::TreeNode.

Definition at line 71 of file decorator_node.cpp.

void BT::DecoratorNode::halt ( )
overridevirtual

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

Implements BT::TreeNode.

Reimplemented in BT::RepeatNode, and BT::RetryNode.

Definition at line 35 of file decorator_node.cpp.

void BT::DecoratorNode::haltChild ( )

Definition at line 51 of file decorator_node.cpp.

void BT::DecoratorNode::setChild ( TreeNode child)

Definition at line 25 of file decorator_node.cpp.

virtual NodeType BT::DecoratorNode::type ( ) const
inlineoverridevirtual

Implements BT::TreeNode.

Reimplemented in BT::DecoratorSubtreeNode.

Definition at line 30 of file decorator_node.h.

Member Data Documentation

TreeNode* BT::DecoratorNode::child_node_
protected

Definition at line 11 of file decorator_node.h.


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


behaviortree_cpp
Author(s): Michele Colledanchise, Davide Faconti
autogenerated on Sat Feb 2 2019 04:01:55