Class ROS2PrimitiveMessageDefinition

java.lang.Object
software.amazon.awssdk.services.iotfleetwise.model.ROS2PrimitiveMessageDefinition
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ROS2PrimitiveMessageDefinition.Builder,ROS2PrimitiveMessageDefinition>
@Generated("software.amazon.awssdk:codegen") public final class ROS2PrimitiveMessageDefinition extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ROS2PrimitiveMessageDefinition.Builder,ROS2PrimitiveMessageDefinition>

Represents a ROS 2 compliant primitive type message of the complex data structure.

See Also:

  • Method Details

    • 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:

    • 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:

    • 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.

    • toBuilder

      public ROS2PrimitiveMessageDefinition.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ROS2PrimitiveMessageDefinition.Builder,ROS2PrimitiveMessageDefinition>
      Returns:
      a builder for type T

    • builder

      public static ROS2PrimitiveMessageDefinition.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ROS2PrimitiveMessageDefinition.Builder> serializableBuilderClass()

    • hashCode

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

    • equals

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

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.