Gets text from user by sending a list of prompts with default values for each prompt. More...

#include <get_text_from_user.hpp>

Inheritance diagram for moveit_studio::behaviors::GetTextFromUser:

[legend]

Collaboration diagram for moveit_studio::behaviors::GetTextFromUser:

[legend]

Public Member Functions
	GetTextFromUser (const std::string &name, const BT::NodeConfiguration &config, const std::shared_ptr< BehaviorContext > &shared_resources)
	Construct a new GetTextFromUser object.

	GetTextFromUser (const std::string &name, const BT::NodeConfiguration &config, const std::shared_ptr< BehaviorContext > &shared_resources, std::unique_ptr< ClientInterfaceBase< RequestTextFromUser > > client_interface)
	Alternate constructor which can use an existing ClientInterfaceBase to support testing with a mock service client interface.

Public Member Functions inherited from moveit_studio::behaviors::ServiceClientBehaviorBase< RequestTextFromUser >
	ServiceClientBehaviorBase (const std::string &name, const BT::NodeConfiguration &config, const std::shared_ptr< BehaviorContext > &shared_resources)
	Constructs ServiceClientBehaviorBase using the RclcppClientInterface.

	ServiceClientBehaviorBase (const std::string &name, const BT::NodeConfiguration &config, const std::shared_ptr< BehaviorContext > &shared_resources, std::unique_ptr< ClientInterfaceBase< RequestTextFromUser > > client_interface)
	Constructs ServiceClientBehaviorBase using a user-provided implementation of ClientInterfaceBase.

virtual	~ServiceClientBehaviorBase ()=default

Public Member Functions inherited from moveit_studio::behaviors::AsyncBehaviorBase
	AsyncBehaviorBase (const std::string &name, const BT::NodeConfiguration &config, const std::shared_ptr< BehaviorContext > &shared_resources)

virtual	~AsyncBehaviorBase ()=default

BT::NodeStatus	onStart () override
	Required implementation of BT::StatefulActionNode::onStart().

BT::NodeStatus	onRunning () override
	Required implementation of BT::StatefulActionNode::onRunning().

void	onHalted () override
	Required implementation of BT::StatefulActionNode::onHalted().

void	resetStatus ()
	Resets the internal status of this node.

Public Member Functions inherited from moveit_studio::behaviors::SharedResourcesNode< BT::StatefulActionNode >
	SharedResourcesNode (const std::string &name, const BT::NodeConfiguration &config, const std::shared_ptr< BehaviorContext > &shared_resources)
	Constructor for SharedResourcesNode. Called by BT::BehaviorTreeFactory when creating a new behavior tree containing this node.

Static Public Member Functions
static BT::PortsList	providedPorts ()
	Returns list of ports for this Behavior.

static BT::KeyValueVector	metadata ()
	Returns metadata for this Behavior.

Additional Inherited Members
Static Public Attributes inherited from moveit_studio::behaviors::ServiceClientBehaviorBase< RequestTextFromUser >
static constexpr std::chrono::seconds	kTimeoutWaitForServiceServer

Protected Member Functions inherited from moveit_studio::behaviors::ServiceClientBehaviorBase< RequestTextFromUser >
virtual tl::expected< std::chrono::duration< double >, std::string >	getResponseTimeout ()
	Optional user-provided function to set the timeout used when waiting for the service response.

virtual tl::expected< std::chrono::duration< double >, std::string >	getWaitForServerAvailableTimeout ()
	Optional user-provided function to set the timeout used when waiting for the service server to be available.

virtual tl::expected< bool, std::string >	processResponse (const typename ServiceT::Response &)
	Optional user-provided function to process the service response after the service has finished.

tl::expected< void, std::string >	doHalt () override
	Handles halting logic which is specific to the service client behavior implementation.

Protected Member Functions inherited from moveit_studio::behaviors::AsyncBehaviorBase
void	notifyCanHalt ()
	Called when runAsync() finishes to notify onHalted() that the async process has finished.

Protected Attributes inherited from moveit_studio::behaviors::SharedResourcesNode< BT::StatefulActionNode >
std::shared_ptr< BehaviorContext >	shared_resources_

Detailed Description

Gets text from user by sending a list of prompts with default values for each prompt.

The prompts, values, and text_output ports should all be a vector of the same length.

Data Port Name	Port Type	Object Type
prompts	input	std::vector<std::string>
default_values	input	std::vector<std::string>
text_output	output	std::vector<std::string>

Constructor & Destructor Documentation

◆ GetTextFromUser() [1/2]

moveit_studio::behaviors::GetTextFromUser::GetTextFromUser	(	const std::string &	name,
		const BT::NodeConfiguration &	config,
		const std::shared_ptr< BehaviorContext > &	shared_resources
	)

explicit

Construct a new GetTextFromUser object.

Parameters

name	See SharedResourcesNode
config	See SharedResourcesNode
shared_resources	See SharedResourcesNode

◆ GetTextFromUser() [2/2]

moveit_studio::behaviors::GetTextFromUser::GetTextFromUser	(	const std::string &	name,
		const BT::NodeConfiguration &	config,
		const std::shared_ptr< BehaviorContext > &	shared_resources,
		std::unique_ptr< ClientInterfaceBase< RequestTextFromUser > >	client_interface
	)

explicit

Alternate constructor which can use an existing ClientInterfaceBase to support testing with a mock service client interface.

Parameters

name	See SharedResourcesNode
config	See SharedResourcesNode
shared_resources	See SharedResourcesNode
client_interface	unique_ptr to an instance of a class derived from ClientInterfaceBase. The Behavior will take ownership of the unique_ptr in this constructor.

Member Function Documentation

◆ metadata()

BT::KeyValueVector moveit_studio::behaviors::GetTextFromUser::metadata ( )

static

Returns metadata for this Behavior.

Returns: BT::KeyValueVector The Behavior metadata.

◆ providedPorts()

BT::PortsList moveit_studio::behaviors::GetTextFromUser::providedPorts ( )

static

Returns list of ports for this Behavior.

Returns: BT::PortsList The list of I/O Ports

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

Public Member Functions

Static Public Member Functions