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

The SyncActionNode is an helper derived class that explicitly forbids the status RUNNING and doesn't require an implementation of halt() More...

#include <action_node.h>

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

Public Member Functions

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

The SyncActionNode is an helper derived class that explicitly forbids the status RUNNING and doesn't require an implementation of halt()

Definition at line 50 of file action_node.h.

Constructor & Destructor Documentation

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

Definition at line 176 of file action_node.cpp.

BT::SyncActionNode::~SyncActionNode ( )
overridedefault

Member Function Documentation

NodeStatus BT::SyncActionNode::executeTick ( )
overridevirtual

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

Reimplemented from BT::ActionNodeBase.

Definition at line 180 of file action_node.cpp.

virtual void BT::SyncActionNode::halt ( )
inlinefinaloverridevirtual

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

Implements BT::TreeNode.

Definition at line 59 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