This is the message to communicate a parameter's descriptor. More...

Public Member Functions
	__init__ (self, name="", type=0, description="", additional_constraints="", read_only=False, dynamic_typing=False, floating_point_range=None, integer_range=None)

Public Attributes
	additional_constraints
	Plain English description of additional constraints which cannot be expressed with the available constraints, e.g.

	description
	Description of the parameter, visible from introspection tools.

	dynamic_typing
	If true, the parameter is allowed to change type.

	floating_point_range
	FloatingPointRange consists of a from_value, a to_value, and a step.

	integer_range
	IntegerRange consists of a from_value, a to_value, and a step.

	name
	The name of the parameter.

	read_only
	If 'true' then the value cannot change after it has been initialized.

	type
	Enum values are defined in `Parameter.Type`.

Detailed Description

This is the message to communicate a parameter's descriptor.

Stand-in for ROS2 `rcl_interfaces.msg.ParameterDescriptor` in ROS1.

Definition at line 217 of file parameter.py.

Constructor & Destructor Documentation

◆ init()

rosros.rclify.parameter.ParameterDescriptor.__init__	(	self,
		name = `""`,
		type = `0`,
		description = `""`,
		additional_constraints = `""`,
		read_only = `False`,
		dynamic_typing = `False`,
		floating_point_range = `None`,
		integer_range = `None`
	)

Definition at line 219 of file parameter.py.

Member Data Documentation

◆ additional_constraints

rosros.rclify.parameter.ParameterDescriptor.additional_constraints

Plain English description of additional constraints which cannot be expressed with the available constraints, e.g.

"only prime numbers". By convention, this should only be used to clarify constraints which cannot be completely expressed with the parameter constraints below.

Definition at line 231 of file parameter.py.

◆ description

rosros.rclify.parameter.ParameterDescriptor.description

Description of the parameter, visible from introspection tools.

Definition at line 226 of file parameter.py.

◆ dynamic_typing

rosros.rclify.parameter.ParameterDescriptor.dynamic_typing

If true, the parameter is allowed to change type.

Definition at line 235 of file parameter.py.

◆ floating_point_range

rosros.rclify.parameter.ParameterDescriptor.floating_point_range

FloatingPointRange consists of a from_value, a to_value, and a step.

Mutually exclusive with `integer_range`.

Definition at line 238 of file parameter.py.

◆ integer_range

rosros.rclify.parameter.ParameterDescriptor.integer_range

IntegerRange consists of a from_value, a to_value, and a step.

Mutually exclusive with `floating_point_range`.

Definition at line 241 of file parameter.py.

◆ name

rosros.rclify.parameter.ParameterDescriptor.name

The name of the parameter.

Definition at line 222 of file parameter.py.

◆ read_only

rosros.rclify.parameter.ParameterDescriptor.read_only

If 'true' then the value cannot change after it has been initialized.

Definition at line 233 of file parameter.py.

◆ type

rosros.rclify.parameter.ParameterDescriptor.type

Enum values are defined in `Parameter.Type`.

Definition at line 224 of file parameter.py.

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

rosros/rclify/parameter.py

Public Member Functions

Public Attributes