#include <decorator_node.h>

Inheritance diagram for BT::DecoratorNode:

[legend]

Public Member Functions
TreeNode *	child ()

const TreeNode *	child () const

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

NodeStatus	executeTick () override
	The method that should be used to invoke tick() and setStatus();. More...

virtual void	halt () override
	The method used to interrupt the execution of this node. More...

void	haltChild ()
	Same as resetChild() More...

void	resetChild ()

void	setChild (TreeNode *child)

virtual NodeType	type () const override

virtual	~DecoratorNode () override=default

Public Member Functions inherited from BT::TreeNode
const NodeConfiguration &	config () const

void	emitStateChanged ()

template<typename T >
Optional< T >	getInput (const std::string &key) const

template<typename T >
Result	getInput (const std::string &key, T &destination) 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

Protected Attributes
TreeNode *	child_node_

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

Definition at line 8 of file decorator_node.h.

Constructor & Destructor Documentation

◆ DecoratorNode()

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

Definition at line 18 of file decorator_node.cpp.

◆ ~DecoratorNode()

virtual BT::DecoratorNode::~DecoratorNode ( )

overridevirtualdefault

Member Function Documentation

◆ child() [1/2]

TreeNode* BT::DecoratorNode::child ( )

◆ child() [2/2]

TreeNode * BT::DecoratorNode::child ( ) const

Definition at line 37 of file decorator_node.cpp.

◆ executeTick()

NodeStatus BT::DecoratorNode::executeTick ( )

overridevirtual

The method that should be used to invoke tick() and setStatus();.

Reimplemented from BT::TreeNode.

Definition at line 77 of file decorator_node.cpp.

◆ halt()

void BT::DecoratorNode::halt ( )

overridevirtual

The method used to interrupt the execution of this node.

Implements BT::TreeNode.

Reimplemented in BT::RepeatNode, BT::RetryNode, and BT::DelayNode.

Definition at line 32 of file decorator_node.cpp.

◆ haltChild()

void BT::DecoratorNode::haltChild ( )

Same as resetChild()

Definition at line 47 of file decorator_node.cpp.

◆ resetChild()

void BT::DecoratorNode::resetChild ( )

Set the status of the child to IDLE. also send a halt() signal to a RUNNING child

Definition at line 52 of file decorator_node.cpp.

◆ setChild()

void BT::DecoratorNode::setChild ( TreeNode * child )

Definition at line 22 of file decorator_node.cpp.

◆ type()

virtual NodeType BT::DecoratorNode::type ( ) const

inlineoverridevirtual

Implements BT::TreeNode.

Reimplemented in BT::SubtreePlusNode, and BT::SubtreeNode.

Definition at line 30 of file decorator_node.h.

Member Data Documentation

◆ child_node_

TreeNode* BT::DecoratorNode::child_node_

protected

Definition at line 11 of file decorator_node.h.

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

Public Member Functions

Protected Attributes

Additional Inherited Members