Public Member Functions | Private Member Functions | List of all members
MyAsyncAction Class Reference
Inheritance diagram for MyAsyncAction:
Inheritance graph
[legend]

Public Member Functions

 MyAsyncAction (const std::string &name)
 
- Public Member Functions inherited from BT::CoroActionNode
 CoroActionNode (const std::string &name, const NodeConfiguration &config)
 
virtual NodeStatus executeTick () overridefinal
 The method that should be used to invoke tick() and setStatus();. More...
 
void halt () override
 
void setStatusRunningAndYield ()
 Use this method to return RUNNING and temporary "pause" the Action. More...
 
virtual ~CoroActionNode () override
 
- Public Member Functions inherited from BT::ActionNodeBase
 ActionNodeBase (const std::string &name, const NodeConfiguration &config)
 
virtual NodeType type () const overridefinal
 
 ~ActionNodeBase () override=default
 
- Public Member Functions inherited from BT::LeafNode
 LeafNode (const std::string &name, const NodeConfiguration &config)
 
virtual ~LeafNode () override=default
 
- Public Member Functions inherited from BT::TreeNode
const NodeConfigurationconfig () const
 
template<typename T >
Result getInput (const std::string &key, T &destination) const
 
template<typename T >
Optional< T > getInput (const std::string &key) const
 
StringView getRawPortValue (const std::string &key) const
 
bool isHalted () const
 
const std::string & name () const
 Name of the instance, not the type. More...
 
const std::string & registrationName () const
 registrationName is the ID used by BehaviorTreeFactory to create an instance. More...
 
template<typename T >
Result setOutput (const std::string &key, const T &value)
 
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 (std::string name, NodeConfiguration config)
 TreeNode main constructor. More...
 
uint16_t UID () const
 
BT::NodeStatus waitValidStatus ()
 
virtual ~TreeNode ()=default
 

Private Member Functions

void cleanup (bool halted)
 
void halt () override
 
NodeStatus tick () override
 Method to be implemented by the user. More...
 

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 Optional< StringViewgetRemappedKey (StringView port_name, StringView remapping_value)
 
static bool isBlackboardPointer (StringView str)
 
static StringView stripBlackboardPointer (StringView str)
 
- Protected Member Functions inherited from BT::TreeNode
void modifyPortsRemapping (const PortsRemapping &new_remapping)
 
void setRegistrationID (StringView ID)
 
void setStatus (NodeStatus new_status)
 
- Protected Attributes inherited from BT::CoroActionNode
std::unique_ptr< Pimpl_p
 

Detailed Description

In this tutorial, we demonstrate how to use the CoroActionNode, which should be preferred over AsyncActionNode when the functions you use are non-blocking.

Definition at line 12 of file t09_async_actions_coroutines.cpp.

Constructor & Destructor Documentation

MyAsyncAction::MyAsyncAction ( const std::string &  name)
inline

Definition at line 15 of file t09_async_actions_coroutines.cpp.

Member Function Documentation

void MyAsyncAction::cleanup ( bool  halted)
inlineprivate

Definition at line 70 of file t09_async_actions_coroutines.cpp.

void MyAsyncAction::halt ( )
inlineoverrideprivatevirtual

The method used to interrupt the execution of a RUNNING node. Only Async nodes that may return RUNNING should implement it.

Implements BT::TreeNode.

Definition at line 80 of file t09_async_actions_coroutines.cpp.

NodeStatus MyAsyncAction::tick ( )
inlineoverrideprivatevirtual

Method to be implemented by the user.

Implements BT::TreeNode.

Definition at line 27 of file t09_async_actions_coroutines.cpp.


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


behaviotree_cpp_v3
Author(s): Michele Colledanchise, Davide Faconti
autogenerated on Tue May 4 2021 02:56:25