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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceObdSignal.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description IntegerbitMaskLength()The number of bits to mask in a message.IntegerbitRightShift()The number of positions to shift bits in the message.static ObdSignal.Builderbuilder()IntegerbyteLength()The length of a message.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()Doubleoffset()The offset used to calculate the signal value.Integerpid()The diagnostic code used to request data from a vehicle for this signal.IntegerpidResponseLength()The length of the requested data.Doublescaling()A multiplier used to decode the message.List<SdkField<?>>sdkFields()static Class<? extends ObdSignal.Builder>serializableBuilderClass()IntegerserviceMode()The mode of operation (diagnostic service) in a message.IntegerstartByte()Indicates the beginning of the message.ObdSignal.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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.
-
toBuilder
public ObdSignal.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ObdSignal.Builder,ObdSignal>
-
builder
public static ObdSignal.Builder builder()
-
serializableBuilderClass
public static Class<? extends ObdSignal.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-