yasmin_ros::GetParametersState Class Reference

State that retrieves parameters from the ROS 2 parameter server. More...

#include <get_parameters_state.hpp>

Inheritance diagram for yasmin_ros::GetParametersState:

Collaboration diagram for yasmin_ros::GetParametersState:

Public Types
using	Parameters = std::unordered_map<std::string, std::any>
	Type alias for a map of parameters.

Public Member Functions
	GetParametersState (const Parameters &parameters, rclcpp::Node::SharedPtr node=nullptr)
	Shared pointer type for GetParametersState.
std::string	execute (yasmin::Blackboard::SharedPtr blackboard) override
	Executes the state to retrieve parameters.
Public Member Functions inherited from yasmin::State
	State (const Outcomes &outcomes)
	Shared pointer type for State.
virtual	~State ()
	Virtual destructor.
Blackboard::SharedPtr	get_parameters_blackboard () const
	Gets the private parameter blackboard of this state.
bool	is_idle () const noexcept
	Checks if the state is idle.
bool	is_running () const noexcept
	Checks if the state is currently running.
bool	is_canceled () const noexcept
	Checks if the state has been canceled.
bool	is_completed () const noexcept
	Checks if the state has completed execution.
std::string	operator() (Blackboard::SharedPtr blackboard)
	Executes the state and returns the outcome.
virtual void	configure ()
	Configures the state before execution.
virtual void	cancel_state ()
	Cancels the current state execution.
Outcomes const &	get_outcomes () const noexcept
	Gets the set of possible outcomes for this state.
void	set_description (const std::string &description)
	Sets the description for this state.
const std::string &	get_description () const
	Gets the description of this state.
void	set_outcome_description (const std::string &outcome, const std::string &description)
	Sets a human-readable description for an outcome.
const std::string &	get_outcome_description (const std::string &outcome) const
	Gets the human-readable description for an outcome.
const std::unordered_map< std::string, std::string > &	get_outcome_descriptions () const
	Gets all outcome descriptions.
void	add_input_key (const BlackboardKeyInfo &key_info)
	Adds an input key to the state's metadata.
void	add_input_key (const std::string &key_name)
	Adds an input key with a name only.
void	add_input_key (const std::string &key_name, const std::string &description)
	Adds an input key with a name and description.
template<typename T>
void	add_input_key (const std::string &key_name, const std::string &description, T default_value)
	Adds an input key with a name, default value and description.
void	add_output_key (const BlackboardKeyInfo &key_info)
	Adds an output key to the state's metadata.
void	add_output_key (const std::string &key_name)
	Adds an output key with a name only.
void	add_output_key (const std::string &key_name, const std::string &description)
	Adds an output key with a name and description.
const std::vector< BlackboardKeyInfo > &	get_input_keys () const
	Gets the input keys metadata.
const std::vector< BlackboardKeyInfo > &	get_output_keys () const
	Gets the output keys metadata.
void	declare_parameter (const BlackboardKeyInfo &parameter_info)
	Declares a parameter in the state metadata.
void	declare_parameter (const std::string &parameter_name)
	Declares a parameter with a name only.
void	declare_parameter (const std::string &parameter_name, const std::string &description)
	Declares a parameter with a name and description.
template<typename T>
void	declare_parameter (const std::string &parameter_name, const std::string &description, T default_value)
	Declares a parameter with a name, description, and default value.
bool	has_parameter (const std::string &parameter_name) const
	Checks if a parameter exists in the state-local parameter storage.
template<typename T>
T	get_parameter (const std::string &parameter_name) const
	Gets a parameter from the state-local parameter storage.
template<typename T>
void	set_parameter (const std::string &parameter_name, T value)
	Sets a parameter in the state-local parameter storage.
bool	is_parameter_declared (const std::string &parameter_name) const
	Checks whether a parameter was declared in the state metadata.
void	copy_parameter_from (const State &source_state, const std::string &source_parameter_name, const std::string &target_parameter_name)
	Copies a parameter value from another state.
const std::vector< BlackboardKeyInfo > &	get_parameters () const
	Gets the declared parameter metadata.
const StateMetadata &	get_metadata () const
	Gets the complete state metadata.
virtual std::string	to_string () const
	Converts the state to a string representation.

Private Attributes
std::unordered_map< std::string, std::any >	parameters_
rclcpp::Node::SharedPtr	node_
	Shared pointer to the ROS 2 node.

Additional Inherited Members
Protected Attributes inherited from yasmin::State
Outcomes	outcomes
	The possible outcomes of this state.

Detailed Description

State that retrieves parameters from the ROS 2 parameter server.

This state retrieves parameters from the ROS 2 parameter server and stores them in the blackboard.

Member Typedef Documentation

Parameters

using yasmin_ros::GetParametersState::Parameters = std::unordered_map<std::string, std::any>

Type alias for a map of parameters.

Constructor & Destructor Documentation

GetParametersState()

GetParametersState::GetParametersState	(	const Parameters &	parameters,
		rclcpp::Node::SharedPtr	node = nullptr )

Shared pointer type for GetParametersState.

Constructs a GetParametersState with a map of parameters.

Parameters

parameters	A map of parameter names to their default values.
node	A shared pointer to the ROS 2 node.

Member Function Documentation

execute()

std::string GetParametersState::execute ( yasmin::Blackboard::SharedPtr blackboard )

overridevirtual

Executes the state to retrieve parameters.

Parameters

blackboard

A reference to the Yasmin blackboard.

Returns

A string representing the outcome of the execution.

Reimplemented from yasmin::State.

Member Data Documentation

node_

rclcpp::Node::SharedPtr yasmin_ros::GetParametersState::node_

private

Shared pointer to the ROS 2 node.

parameters_

std::unordered_map<std::string, std::any> yasmin_ros::GetParametersState::parameters_

private

Map of parameters to retrieve, where the key is the parameter name and the value is the default value.

---

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

• yasmin_ros/include/yasmin_ros/get_parameters_state.hpp
• yasmin_ros/src/yasmin_ros/get_parameters_state.cpp