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

The SetBlackboard is action used to store a string into an entry of the Blackboard specified in "output_key". More...

#include <set_blackboard_node.h>

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

Public Member Functions

 SetBlackboard (const std::string &name, const NodeConfiguration &config)
 
- Public Member Functions inherited from BT::SyncActionNode
virtual NodeStatus executeTick () override
 throws if the derived class return RUNNING. More...
 
virtual void halt () overridefinal
 You don't need to override this. More...
 
 SyncActionNode (const std::string &name, const NodeConfiguration &config)
 
 ~SyncActionNode () override=default
 
- 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
 
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)
 
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 (std::string name, NodeConfiguration config)
 TreeNode main constructor. More...
 
uint16_t UID () const
 
BT::NodeStatus waitValidStatus ()
 
virtual ~TreeNode ()=default
 

Static Public Member Functions

static PortsList providedPorts ()
 
- 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)
 

Private Member Functions

virtual BT::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
 
- Protected Member Functions inherited from BT::TreeNode
void modifyPortsRemapping (const PortsRemapping &new_remapping)
 
void setRegistrationID (StringView ID)
 

Detailed Description

The SetBlackboard is action used to store a string into an entry of the Blackboard specified in "output_key".

Example usage:

<SetBlackboard value="42" output_key="the_answer">

Will store the string "42" in the entry with key "the_answer".

Definition at line 30 of file set_blackboard_node.h.

Constructor & Destructor Documentation

BT::SetBlackboard::SetBlackboard ( const std::string &  name,
const NodeConfiguration config 
)
inline

Definition at line 33 of file set_blackboard_node.h.

Member Function Documentation

static PortsList BT::SetBlackboard::providedPorts ( )
inlinestatic

Definition at line 39 of file set_blackboard_node.h.

virtual BT::NodeStatus BT::SetBlackboard::tick ( )
inlineoverrideprivatevirtual

Method to be implemented by the user.

Implements BT::TreeNode.

Definition at line 46 of file set_blackboard_node.h.


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


behaviortree_cpp
Author(s): Michele Colledanchise, Davide Faconti
autogenerated on Sat Jun 8 2019 18:04:06