Public Member Functions | List of all members
BT::ActionNodeBase Class Reference

#include <action_node.h>

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

Public Member Functions

 ActionNodeBase (const std::string &name, const NodeParameters &parameters=NodeParameters())
 
virtual NodeStatus executeTick () override
 The method that will be executed to invoke tick(); and setStatus();. More...
 
virtual NodeType type () const overridefinal
 
 ~ActionNodeBase () override=default
 
- Public Member Functions inherited from BT::LeafNode
 LeafNode (const std::string &name, const NodeParameters &parameters)
 
virtual ~LeafNode () 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
 
virtual void halt ()=0
 The method used to interrupt the execution of a RUNNING node. More...
 
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
 

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

IMPORTANT: to avoid unexpected behaviors when Sequence (not SequenceStar) is used an Action that returned SUCCESS or FAILURE will not be ticked again unless setStatus(IDLE) is called first (reset the Action).

Usually the parent node takes care of this for you.

Definition at line 30 of file action_node.h.

Constructor & Destructor Documentation

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

Definition at line 19 of file action_node.cpp.

BT::ActionNodeBase::~ActionNodeBase ( )
overridedefault

Member Function Documentation

NodeStatus BT::ActionNodeBase::executeTick ( )
overridevirtual

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

Reimplemented from BT::TreeNode.

Reimplemented in BT::CoroActionNode, BT::AsyncActionNode, and BT::SyncActionNode.

Definition at line 24 of file action_node.cpp.

virtual NodeType BT::ActionNodeBase::type ( ) const
inlinefinaloverridevirtual

Implements BT::TreeNode.

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