Sleep for a certain amount of time. Consider also using the decorator <Delay> More...

#include <sleep_node.h>

Inheritance diagram for BT::SleepNode:

[legend]

Public Member Functions
void	onHalted () override

NodeStatus	onRunning () override
	method invoked when the action is already in the RUNNING state. More...

NodeStatus	onStart () override

	SleepNode (const std::string &name, const NodeConfig &config)

	~SleepNode () override

Public Member Functions inherited from BT::StatefulActionNode
bool	isHaltRequested () const

	StatefulActionNode (const std::string &name, const NodeConfig &config)

Public Member Functions inherited from BT::ActionNodeBase
	ActionNodeBase (const std::string &name, const NodeConfig &config)

virtual NodeType	type () const override final

	~ActionNodeBase () override=default

Public Member Functions inherited from BT::LeafNode
	LeafNode (const std::string &name, const NodeConfig &config)

virtual	~LeafNode () override=default

Public Member Functions inherited from BT::TreeNode
const NodeConfig &	config () 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< Timestamp >	getInputStamped (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...

TreeNode &	operator= (const TreeNode &other)=delete

TreeNode &	operator= (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

uint16_t	UID () const

BT::NodeStatus	waitValidStatus ()

virtual	~TreeNode ()

Static Public Member Functions
static PortsList	providedPorts ()

Static Public Member Functions inherited from BT::TreeNode
static Expected< StringView >	getRemappedKey (StringView port_name, StringView remapped_port)

template<class DerivedT , typename... ExtraArgs>
static std::unique_ptr< TreeNode >	Instantiate (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)

Private Attributes
std::mutex	delay_mutex_

TimerQueue	timer_

uint64_t	timer_id_

std::atomic_bool	timer_waiting_ = false

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< TreeNode >	Ptr

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)>

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::StatefulActionNode
void	halt () override final

NodeStatus	tick () override final
	Method to be implemented by the user. More...

Protected Member Functions inherited from BT::TreeNode
NodeConfig &	config ()

void	modifyPortsRemapping (const PortsRemapping &new_remapping)

template<typename T >
T	parseString (const std::string &str) const

PostScripts &	postConditionsScripts ()

PreScripts &	preConditionsScripts ()

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)

Detailed Description

Sleep for a certain amount of time. Consider also using the decorator <Delay>

Definition at line 15 of file sleep_node.h.

Constructor & Destructor Documentation

◆ SleepNode()

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

Definition at line 6 of file sleep_node.cpp.

◆ ~SleepNode()

BT::SleepNode::~SleepNode ( )

inlineoverride

Definition at line 20 of file sleep_node.h.

Member Function Documentation

◆ onHalted()

void BT::SleepNode::onHalted ( )

overridevirtual

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 44 of file sleep_node.cpp.

◆ onRunning()

NodeStatus BT::SleepNode::onRunning ( )

overridevirtual

method invoked when the action is already in the RUNNING state.

Implements BT::StatefulActionNode.

Definition at line 39 of file sleep_node.cpp.

◆ onStart()

NodeStatus BT::SleepNode::onStart ( )

overridevirtual

Method called once, when transitioning from the state IDLE. If it returns RUNNING, this becomes an asynchronous node.

Implements BT::StatefulActionNode.

Definition at line 10 of file sleep_node.cpp.

◆ providedPorts()

static PortsList BT::SleepNode::providedPorts ( )

inlinestatic

Definition at line 31 of file sleep_node.h.

Member Data Documentation

◆ delay_mutex_

std::mutex BT::SleepNode::delay_mutex_

private

Definition at line 41 of file sleep_node.h.

◆ timer_

TimerQueue BT::SleepNode::timer_

private

Definition at line 37 of file sleep_node.h.

◆ timer_id_

uint64_t BT::SleepNode::timer_id_

private

Definition at line 38 of file sleep_node.h.

◆ timer_waiting_

std::atomic_bool BT::SleepNode::timer_waiting_ = false

private

Definition at line 40 of file sleep_node.h.

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

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SleepNode()

◆ ~SleepNode()

Member Function Documentation

◆ onHalted()

◆ onRunning()

◆ onStart()

◆ providedPorts()

Member Data Documentation

◆ delay_mutex_

◆ timer_

◆ timer_id_

◆ timer_waiting_