Struct rosidl_runtime_c__type_description__FieldType

• Defined in File field_type__struct.h

Struct Documentation

struct rosidl_runtime_c__type_description__FieldType

Struct defined in msg/FieldType in the package type_description_interfaces.

Represents the type of a field and related meta-data.

Public Members

uint8_t type_id

Identifying number for the type of the field, using one of the above constants.

uint64_t capacity

Only used when the type is an array or a bounded sequence. In the case of an array, this is the fixed capacity of the array. In the case of a bounded sequence, this is the maximum capacity of the sequence. In all other cases this field is unused.

uint64_t string_capacity

Only used when the type is a fixed or bounded string/wstring, or a array/sequence of those. In the case of a fixed string/wstring, it is the fixed length of the string. In the case of a bounded string/wstring, it is the maximum capacity of the string. In the case of an array/sequence of fixed string/wstring, it is the fixed length of the strings. In the case of an array/sequence of bounded string/wstring, it is the maximum capacity of the strings. It is not currently possible to have different string capacities per element in the array/sequence.

rosidl_runtime_c__String nested_type_name

Only used when the type is a nested type or array/sequence of nested types. This is limited to 255 characters. TODO(wjwwood): this 255 character limit was chosen due to this being the limit for DDSI-RTPS based middlewares, which is the most commonly used right now. We lack a ROS 2 specific limit in our design documents, but we should update this and/or link to the design doc when that is available.