Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
DummyNodes::SleepNode Class Reference

#include <dummy_nodes.h>

Inheritance diagram for DummyNodes::SleepNode:
Inheritance graph
[legend]

Public Member Functions

void onHalted () override
 
NodeStatus onRunning () override
 method invoked by an action in the RUNNING state. More...
 
NodeStatus onStart () override
 
 SleepNode (const std::string &name, const BT::NodeConfiguration &config)
 
- Public Member Functions inherited from BT::StatefulActionNode
void halt () override final
 
 StatefulActionNode (const std::string &name, const NodeConfiguration &config)
 
NodeStatus tick () override final
 Method to be implemented by the user. More...
 
- Public Member Functions inherited from BT::ActionNodeBase
 ActionNodeBase (const std::string &name, const NodeConfiguration &config)
 
virtual NodeType type () const override final
 
 ~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
 
void emitStateChanged ()
 
virtual BT::NodeStatus executeTick ()
 The method that should be used to invoke tick() and setStatus();. More...
 
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)
 
void setPostTickOverrideFunction (PostTickOverrideCallback callback)
 
void setPreTickOverrideFunction (PreTickOverrideCallback 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 (std::string name, NodeConfiguration config)
 TreeNode main constructor. More...
 
uint16_t UID () const
 
BT::NodeStatus waitValidStatus ()
 
virtual ~TreeNode ()=default
 

Static Public Member Functions

static BT::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 Attributes

std::chrono::system_clock::time_point deadline_
 

Additional Inherited Members

- Public Types inherited from BT::TreeNode
using PostTickOverrideCallback = std::function< Optional< NodeStatus >(TreeNode &, NodeStatus, NodeStatus)>
 
using PreTickOverrideCallback = std::function< Optional< NodeStatus >(TreeNode &, NodeStatus)>
 
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 resetStatus ()
 Equivalent to setStatus(NodeStatus::IDLE) More...
 
void setRegistrationID (StringView ID)
 
void setStatus (NodeStatus new_status)
 
void setWakeUpInstance (std::shared_ptr< WakeUpSignal > instance)
 

Detailed Description

Definition at line 72 of file dummy_nodes.h.

Constructor & Destructor Documentation

◆ SleepNode()

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

Definition at line 75 of file dummy_nodes.h.

Member Function Documentation

◆ onHalted()

void DummyNodes::SleepNode::onHalted ( )
inlineoverridevirtual

when the method halt() is called and the action is RUNNING, this method is invoked. This is a convenient place todo a cleanup, if needed.

Implements BT::StatefulActionNode.

Definition at line 114 of file dummy_nodes.h.

◆ onRunning()

NodeStatus DummyNodes::SleepNode::onRunning ( )
inlineoverridevirtual

method invoked by an action in the RUNNING state.

Implements BT::StatefulActionNode.

Definition at line 103 of file dummy_nodes.h.

◆ onStart()

NodeStatus DummyNodes::SleepNode::onStart ( )
inlineoverridevirtual

method to be called at the beginning. If it returns RUNNING, this becomes an asychronous node.

Implements BT::StatefulActionNode.

Definition at line 85 of file dummy_nodes.h.

◆ providedPorts()

static BT::PortsList DummyNodes::SleepNode::providedPorts ( )
inlinestatic

Definition at line 79 of file dummy_nodes.h.

Member Data Documentation

◆ deadline_

std::chrono::system_clock::time_point DummyNodes::SleepNode::deadline_
private

Definition at line 121 of file dummy_nodes.h.


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


behaviortree_cpp_v3
Author(s): Michele Colledanchise, Davide Faconti
autogenerated on Mon Jul 3 2023 02:50:15