The SyncActionNode is an ActionNode that explicitly prevents the status RUNNING and doesn't require an implementation of halt(). More...

#include <action_node.h>

Inheritance diagram for BT::SyncActionNode:

[legend]

Public Member Functions
virtual NodeStatus	executeTick () override
	throws if the derived class return RUNNING. More...

virtual void	halt () override final
	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 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 NodeConfiguration &	config () const

void	emitStateChanged ()

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

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

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< StringView >	getRemappedKey (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	resetStatus ()
	Equivalent to setStatus(NodeStatus::IDLE) More...

void	setRegistrationID (StringView ID)

void	setStatus (NodeStatus new_status)

void	setWakeUpInstance (std::shared_ptr< WakeUpSignal > instance)

virtual BT::NodeStatus	tick ()=0
	Method to be implemented by the user. More...

Detailed Description

The SyncActionNode is an ActionNode that explicitly prevents the status RUNNING and doesn't require an implementation of halt().

Definition at line 52 of file action_node.h.

Constructor & Destructor Documentation

◆ SyncActionNode()

SyncActionNode::SyncActionNode	(	const std::string &	name,
		const NodeConfiguration &	config
	)

Definition at line 50 of file action_node.cpp.

◆ ~SyncActionNode()

BT::SyncActionNode::~SyncActionNode ( )

overridedefault

Member Function Documentation

◆ executeTick()

NodeStatus SyncActionNode::executeTick ( )

overridevirtual

throws if the derived class return RUNNING.

Reimplemented from BT::TreeNode.

Definition at line 54 of file action_node.cpp.

◆ halt()

virtual void BT::SyncActionNode::halt ( )

inlinefinaloverridevirtual

You don't need to override this.

Implements BT::TreeNode.

Definition at line 62 of file action_node.h.

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

Public Member Functions