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

#include <leaf_node.h>

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

Public Member Functions

 LeafNode (const std::string &name, const NodeConfig &config)
 
virtual ~LeafNode () override=default
 
- Public Member Functions inherited from BT::TreeNode
const NodeConfigconfig () const
 
void emitWakeUpSignal ()
 Notify that the tree should be ticked again() More...
 
virtual BT::NodeStatus executeTick ()
 The method that should be used to invoke tick() and setStatus();. More...
 
const std::string & fullPath () const
 
template<typename T >
Expected< T > getInput (const std::string &key) const
 
template<typename T >
Result getInput (const std::string &key, T &destination) const
 
template<typename T >
Expected< StampedValue< T > > getInputStamped (const std::string &key) const
 
template<typename T >
Expected< TimestampgetInputStamped (const std::string &key, T &destination) const
 getInputStamped is similar to getInput(dey, destination), but it returne also the Timestamp object, that can be used to check if a value was updated and when. More...
 
AnyPtrLocked getLockedPortContent (const std::string &key)
 getLockedPortContent should be used when: More...
 
StringView getRawPortValue (const std::string &key) const
 
void haltNode ()
 
bool isHalted () const
 
const std::string & name () const
 Name of the instance, not the type. More...
 
TreeNodeoperator= (const TreeNode &other)=delete
 
TreeNodeoperator= (TreeNode &&other) noexcept
 
const std::string & registrationName () const
 registrationName is the ID used by BehaviorTreeFactory to create an instance. More...
 
bool requiresWakeUp () const
 
template<typename T >
Result setOutput (const std::string &key, const T &value)
 setOutput modifies the content of an Output port More...
 
void setPostTickFunction (PostTickCallback callback)
 
void setPreTickFunction (PreTickCallback callback)
 
void setTickMonitorCallback (TickMonitorCallback callback)
 
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 TreeNode &other)=delete
 
 TreeNode (std::string name, NodeConfig config)
 TreeNode main constructor. More...
 
 TreeNode (TreeNode &&other) noexcept
 
virtual NodeType type () const =0
 
uint16_t UID () const
 
BT::NodeStatus waitValidStatus ()
 
virtual ~TreeNode ()
 

Additional Inherited Members

- Public Types inherited from BT::TreeNode
using PostTickCallback = std::function< NodeStatus(TreeNode &, NodeStatus)>
 
using PreTickCallback = std::function< NodeStatus(TreeNode &)>
 
typedef std::shared_ptr< TreeNodePtr
 
using StatusChangeCallback = StatusChangeSignal::CallableFunction
 
using StatusChangeSignal = Signal< TimePoint, const TreeNode &, NodeStatus, NodeStatus >
 
using StatusChangeSubscriber = StatusChangeSignal::Subscriber
 
using TickMonitorCallback = std::function< void(TreeNode &, NodeStatus, std::chrono::microseconds)>
 
- Static Public Member Functions inherited from BT::TreeNode
static Expected< StringViewgetRemappedKey (StringView port_name, StringView remapped_port)
 
template<class DerivedT , typename... ExtraArgs>
static std::unique_ptr< TreeNodeInstantiate (const std::string &name, const NodeConfig &config, ExtraArgs... args)
 
static bool isBlackboardPointer (StringView str, StringView *stripped_pointer=nullptr)
 Check a string and return true if it matches the pattern: {...}. More...
 
static StringView stripBlackboardPointer (StringView str)
 
- Protected Types inherited from BT::TreeNode
using PostScripts = std::array< ScriptFunction, size_t(PostCond::COUNT_)>
 
using PreScripts = std::array< ScriptFunction, size_t(PreCond::COUNT_)>
 
- Protected Member Functions inherited from BT::TreeNode
NodeConfigconfig ()
 
void modifyPortsRemapping (const PortsRemapping &new_remapping)
 
template<typename T >
parseString (const std::string &str) const
 
PostScriptspostConditionsScripts ()
 
PreScriptspreConditionsScripts ()
 
void resetStatus ()
 Set the status to IDLE. More...
 
void setRegistrationID (StringView ID)
 
void setStatus (NodeStatus new_status)
 setStatus changes the status of the node. it will throw if you try to change the status to IDLE, because your parent node should do that, not the user! More...
 
void setWakeUpInstance (std::shared_ptr< WakeUpSignal > instance)
 
virtual BT::NodeStatus tick ()=0
 Method to be implemented by the user. More...
 

Detailed Description

Definition at line 21 of file leaf_node.h.

Constructor & Destructor Documentation

◆ LeafNode()

BT::LeafNode::LeafNode ( const std::string &  name,
const NodeConfig config 
)
inline

Definition at line 25 of file leaf_node.h.

◆ ~LeafNode()

virtual BT::LeafNode::~LeafNode ( )
overridevirtualdefault

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


behaviortree_cpp_v4
Author(s): Davide Faconti
autogenerated on Fri Jun 28 2024 02:20:09