Inheritance diagram for SimpleCoroAction:

[legend]

Public Member Functions
virtual void	halt () override

void	setRequiredTime (Millisecond ms)

	SimpleCoroAction (milliseconds timeout, bool will_fail, const std::string &node_name, const BT::NodeConfig &config)

bool	wasHalted ()

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

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

void	setStatusRunningAndYield ()
	Use this method to return RUNNING and temporary "pause" the Action. More...

void	tickImpl ()

virtual	~CoroActionNode () override

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

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

Public Attributes
bool	will_fail_

Protected Member Functions
virtual BT::NodeStatus	tick () override
	Method to be implemented by the user. More...

Protected Member Functions inherited from BT::CoroActionNode
void	destroyCoroutine ()

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)

Private Attributes
bool	halted_

Timepoint	start_time_

std::chrono::milliseconds	timeout_

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

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)

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 Attributes inherited from BT::CoroActionNode
std::unique_ptr< Pimpl >	_p

Detailed Description

Definition at line 12 of file gtest_coroutines.cpp.

Constructor & Destructor Documentation

◆ SimpleCoroAction()

SimpleCoroAction::SimpleCoroAction	(	milliseconds	timeout,
		bool	will_fail,
		const std::string &	node_name,
		const BT::NodeConfig &	config
	)

inline

Definition at line 15 of file gtest_coroutines.cpp.

Member Function Documentation

◆ halt()

virtual void SimpleCoroAction::halt ( )

inlineoverridevirtual

You may want to override this method. But still, remember to call this implementation too.

Example:

void MyAction::halt()
{
    // do your stuff here
    CoroActionNode::halt();
}

Reimplemented from BT::CoroActionNode.

Definition at line 23 of file gtest_coroutines.cpp.

◆ setRequiredTime()

void SimpleCoroAction::setRequiredTime ( Millisecond ms )

inline

Definition at line 36 of file gtest_coroutines.cpp.

◆ tick()

virtual BT::NodeStatus SimpleCoroAction::tick ( )

inlineoverrideprotectedvirtual

Method to be implemented by the user.

Implements BT::TreeNode.

Definition at line 42 of file gtest_coroutines.cpp.

◆ wasHalted()

bool SimpleCoroAction::wasHalted ( )

inline

Definition at line 31 of file gtest_coroutines.cpp.

Member Data Documentation

◆ halted_

bool SimpleCoroAction::halted_

private

Definition at line 70 of file gtest_coroutines.cpp.

◆ start_time_

Timepoint SimpleCoroAction::start_time_

private

Definition at line 69 of file gtest_coroutines.cpp.

◆ timeout_

std::chrono::milliseconds SimpleCoroAction::timeout_

private

Definition at line 68 of file gtest_coroutines.cpp.

◆ will_fail_

bool SimpleCoroAction::will_fail_

Definition at line 65 of file gtest_coroutines.cpp.

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

gtest_coroutines.cpp

Public Member Functions

Public Attributes

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SimpleCoroAction()

Member Function Documentation

◆ halt()

◆ setRequiredTime()

◆ tick()

◆ wasHalted()

Member Data Documentation

◆ halted_

◆ start_time_

◆ timeout_

◆ will_fail_