parameterDescriptor QML Value Type

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

Properties

• additionalConstraints : string
• description : string
• dynamicTyping : bool
• floatingPointRange : list<floatingPointRange>
• integerRange : list<integerRange>
• name : string
• readOnly : bool
• type : uint8_t

Detailed Description

parameterDescriptor is a structured value type usable in QML. It maps directly to the rcl_interfaces::msg::ParameterDescriptor ROS 2 message type.

Construct a parameterDescriptor in QML by assigning a JavaScript object whose keys are its component properties, or by setting those properties individually.

See also ParameterDescriptorPublisher and ParameterDescriptorSubscriber.

Property Documentation

additionalConstraints : string

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.

description : string

Description of the parameter, visible from introspection tools.

dynamicTyping : bool

If true, the parameter is allowed to change type.

floatingPointRange : list<floatingPointRange>

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

integerRange : list<integerRange>

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

name : string

The name of the parameter.

readOnly : bool

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

type : uint8_t

Enum values are defined in the `ParameterType.msg` message.