Module types 

Parameter types for ROS 2 compatible parameter handling

This module provides types for representing ROS 2 parameters including scalar values, arrays, and parameter descriptors.

Structs

CapacityExceeded

A value does not fit the compile-time parameter capacity (issue 0323).

FloatingPointRange

Floating point range constraints for parameters

IntegerRange

Integer range constraints for parameters

NodeFlags

A per-node bool, bounded by the key’s own range.

NodeKey

Which node a parameter belongs to.

Parameter

A named parameter with value and optional descriptor

ParameterDescriptor

Parameter descriptor containing metadata

Enums

ParameterRange

Range constraints for a parameter

ParameterType

ROS 2 parameter types

ParameterValue

Parameter value container

SetParameterResult

Result of setting a parameter

Constants

IMPLIED_STORE_SLOTS

Slots of the parameter store this build KNOWS the image builds: MAX_PARAMETERS when the contract declares a parameter, the bringup declares param_services, or the launch seeds a <param> (NROS_PARAM_STORE); 0 otherwise. phase-382 W3’.

MAX_ARRAY_LEN

Maximum length for array parameters (set via NROS_MAX_ARRAY_LEN, default 32).

MAX_BYTE_ARRAY_LEN

Maximum length for byte array parameters (set via NROS_MAX_BYTE_ARRAY_LEN, default 256).

MAX_PARAMETERS

Maximum number of parameters the server can store (set via NROS_MAX_PARAMETERS, default 32).

MAX_PARAM_CONSTRAINTS_LEN

Maximum length for a parameter’s additional_constraints, in bytes (set via NROS_MAX_PARAM_CONSTRAINTS_LEN, default 0 = no constraint text). phase-417 W4.a.

MAX_PARAM_DESCRIPTION_LEN

Maximum length for a parameter description, in bytes (set via NROS_MAX_PARAM_DESCRIPTION_LEN, default 256; 0 = no descriptions). phase-446 F2.

MAX_PARAM_NAME_LEN

Maximum length for parameter names (set via NROS_MAX_PARAM_NAME_LEN, default 64).

MAX_STRING_VALUE_LEN

Maximum length for parameter string values (set via NROS_MAX_STRING_VALUE_LEN, default 256).

PARAM_EVENTS_DEPTH

History depth of each node’s /parameter_events publisher (set via NROS_PARAM_EVENTS_DEPTH; default 1000 on a hosted target, 1 otherwise). phase-491 W3.

Traits

ParameterVariant

Trait for types that can be used as typed parameters

Functions

fit_description

phase-446 F2 – store as much of text as dst holds, cut at a UTF-8 character boundary. Returns whether anything was cut.