Skip to content

ROS2PrimitiveMessageDefinition

Source code in docs_src/capo_iotfleetwise/types/ros2_primitive_message_definition.py 
15
16
17
18
19
20
21
22
23
class ROS2PrimitiveMessageDefinition(TypedDict, closed=True):
    primitive_type: "capo_iotfleetwise.types.ros2_primitive_type.ROS2PrimitiveType"
    """<p>The primitive type (integer, floating point, boolean, etc.) for the ROS 2 primitive message definition.</p>"""
    offset: NotRequired["capo_iotfleetwise.types.double.double"]
    """<p>The offset used to calculate the signal value. Combined with scaling, the calculation is <code>value = raw_value * scaling + offset</code>.</p>"""
    scaling: NotRequired["capo_iotfleetwise.types.double.double"]
    """<p>A multiplier used to decode the message.</p>"""
    upper_bound: NotRequired["capo_iotfleetwise.types.max_string_size.maxStringSize"]
    """<p>An optional attribute specifying the upper bound for <code>STRING</code> and <code>WSTRING</code>.</p>"""

offset instance-attribute 

offset: NotRequired[double]

The offset used to calculate the signal value. Combined with scaling, the calculation is value = raw_value * scaling + offset.

primitive_type instance-attribute 

primitive_type: ROS2PrimitiveType

The primitive type (integer, floating point, boolean, etc.) for the ROS 2 primitive message definition.

scaling instance-attribute 

scaling: NotRequired[double]

A multiplier used to decode the message.

upper_bound instance-attribute 

upper_bound: NotRequired[maxStringSize]

An optional attribute specifying the upper bound for STRING and WSTRING.