moveit_pro::behaviors::GetTextFromUser Class Reference

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_pro::behaviors::GetTextFromUser:

Collaboration diagram for moveit_pro::behaviors::GetTextFromUser:

Public Member Functions
	GetTextFromUser (const std::string &name, const BT::NodeConfiguration &config, const std::shared_ptr< BehaviorContext > &shared_resources)
	Construct a new GetTextFromUser object.
Public Member Functions inherited from moveit_pro::behaviors::AsyncBehaviorBase
	AsyncBehaviorBase (const std::string &name, const BT::NodeConfiguration &config, const std::shared_ptr< BehaviorContext > &shared_resources)
	~AsyncBehaviorBase () override=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_pro::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
Protected Member Functions inherited from moveit_pro::behaviors::AsyncBehaviorBase
void	notifyCanHalt ()
	Called when runAsync() finishes to notify onHalted() that the async process has finished.
Protected Attributes inherited from moveit_pro::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()

moveit_pro::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

Member Function Documentation

metadata()

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

static

Returns metadata for this Behavior.

Returns

BT::KeyValueVector The Behavior metadata.

providedPorts()

BT::PortsList moveit_pro::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:

• get_text_from_user.hpp
• get_text_from_user.cpp