rclpy.parameter module

class rclpy.parameter.Parameter(name, type_=None, value=None)

Bases: object

class Type(value)

Bases: Enum

An enumeration.

check(parameter_value)

classmethod from_parameter_value(parameter_value)

Get a Parameter.Type from a given variable.

Returns:

A Parameter.Type corresponding to the instance type of the given value.

Raises:

TypeError if the conversion to a type was not possible.

classmethod from_parameter_msg(param_msg)

get_parameter_value()

property name

to_parameter_msg()

property type_

property value

rclpy.parameter.parameter_value_to_python(parameter_value: rcl_interfaces.msg.ParameterValue)

Get the value for the Python builtin type from a rcl_interfaces/msg/ParameterValue object.

Returns the value member of the message based on the type member. Returns None if the parameter is “NOT_SET”.

Parameters:

parameter_value – The message to get the value from.

Raises:

RuntimeError – if the member type has an unexpected value.