Class ObdSignal

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

Information about signal messages using the on-board diagnostics (OBD) II protocol in a vehicle.

See Also:

  • Method Details

    • pidResponseLength

      public final Integer pidResponseLength()

      The length of the requested data.

      Returns:
      The length of the requested data.

    • serviceMode

      public final Integer serviceMode()

      The mode of operation (diagnostic service) in a message.

      Returns:
      The mode of operation (diagnostic service) in a message.

    • pid

      public final Integer pid()

      The diagnostic code used to request data from a vehicle for this signal.

      Returns:
      The diagnostic code used to request data from a vehicle for this signal.

    • scaling

      public final Double scaling()

      A multiplier used to decode the message.

      Returns:
      A multiplier used to decode the message.

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

    • startByte

      public final Integer startByte()

      Indicates the beginning of the message.

      Returns:
      Indicates the beginning of the message.

    • byteLength

      public final Integer byteLength()

      The length of a message.

      Returns:
      The length of a message.

    • bitRightShift

      public final Integer bitRightShift()

      The number of positions to shift bits in the message.

      Returns:
      The number of positions to shift bits in the message.

    • bitMaskLength

      public final Integer bitMaskLength()

      The number of bits to mask in a message.

      Returns:
      The number of bits to mask in a message.

    • isSigned

      public final Boolean isSigned()

      Determines whether the message is signed (true) or not (false). If it's signed, the message can represent both positive and negative numbers. The isSigned parameter only applies to the INTEGER raw signal type, and it doesn't affect the FLOATING_POINT raw signal type. The default value is false.

      Returns:
      Determines whether the message is signed (true) or not (false). If it's signed, the message can represent both positive and negative numbers. The isSigned parameter only applies to the INTEGER raw signal type, and it doesn't affect the FLOATING_POINT raw signal type. The default value is false.

    • signalValueType

      public final SignalValueType signalValueType()

      The value type of the signal. The default value is INTEGER.

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

      Returns:
      The value type of the signal. The default value is INTEGER.
      See Also:

    • signalValueTypeAsString

      public final String signalValueTypeAsString()

      The value type of the signal. The default value is INTEGER.

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

      Returns:
      The value type of the signal. The default value is INTEGER.
      See Also:

    • toBuilder

      public ObdSignal.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<ObdSignal.Builder,ObdSignal>
      Returns:
      a builder for type T

    • builder

      public static ObdSignal.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ObdSignal.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.