yasmin_ros.get_parameters_state.GetParametersState Class Reference

Inheritance diagram for yasmin_ros.get_parameters_state.GetParametersState:

Collaboration diagram for yasmin_ros.get_parameters_state.GetParametersState:

Public Member Functions
None	__init__ (self, Dict[str, Any] parameters, Node node=None)
str	execute (self, Blackboard blackboard)

Protected Attributes
	_parameters = parameters
	_node = node if node else YasminNode.get_instance()

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.

Attributes:
    _parameters (Dict[str, Any]): Map of parameters to retrieve, where the key is the parameter name
        and the value is the default value.
    _node (Node): Shared pointer to the ROS 2 node.

Constructor & Destructor Documentation

__init__()

None yasmin_ros.get_parameters_state.GetParametersState.__init__	(		self,
		Dict[str, Any]	parameters,
		Node	node = None )

Constructs a GetParametersState with a map of parameters.

Args:
    parameters (Dict[str, Any]): A map of parameter names to their default values.
    node (Node, optional): A shared pointer to the ROS 2 node.

Member Function Documentation

execute()

str yasmin_ros.get_parameters_state.GetParametersState.execute	(		self,
		Blackboard	blackboard )

Executes the state to retrieve parameters.

Args:
    blackboard (Blackboard): A reference to the Yasmin blackboard.

Returns:
    str: A string representing the outcome of the execution.

Member Data Documentation

_node

yasmin_ros.get_parameters_state.GetParametersState._node = node if node else YasminNode.get_instance()

protected

_parameters

yasmin_ros.get_parameters_state.GetParametersState._parameters = parameters

protected

---

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

• yasmin_ros/yasmin_ros/get_parameters_state.py