Class ROS2PrimitiveMessageDefinition

    • Method Detail

      • primitiveType

        public final ROS2PrimitiveType primitiveType()

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

        If the service returns an enum value that is not available in the current SDK version, primitiveType will return ROS2PrimitiveType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from primitiveTypeAsString().

        Returns:
        The primitive type (integer, floating point, boolean, etc.) for the ROS 2 primitive message definition.
        See Also:
        ROS2PrimitiveType
      • primitiveTypeAsString

        public final String primitiveTypeAsString()

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

        If the service returns an enum value that is not available in the current SDK version, primitiveType will return ROS2PrimitiveType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from primitiveTypeAsString().

        Returns:
        The primitive type (integer, floating point, boolean, etc.) for the ROS 2 primitive message definition.
        See Also:
        ROS2PrimitiveType
      • offset

        public final Double offset()

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

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

        public final Double scaling()

        A multiplier used to decode the message.

        Returns:
        A multiplier used to decode the message.
      • upperBound

        public final Long upperBound()

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

        Returns:
        An optional attribute specifying the upper bound for STRING and WSTRING.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)