software.amazon.awssdk.services.iotfleetwise.model

Class ObdSignal

java.lang.Object

software.amazon.awssdk.services.iotfleetwise.model.ObdSignal

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ObdSignal.Builder,ObdSignal>

@Generated(value="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 and Description
static interface	ObdSignal.Builder

Method Summary

Modifier and Type	Method and Description
Integer	bitMaskLength() The number of bits to mask in a message.
Integer	bitRightShift() The number of positions to shift bits in the message.
static ObdSignal.Builder	builder()
Integer	byteLength() The length of a message.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Double	offset() The offset used to calculate the signal value.
Integer	pid() The diagnostic code used to request data from a vehicle for this signal.
Integer	pidResponseLength() The length of the requested data.
Double	scaling() A multiplier used to decode the message.
List<SdkField<?>>	sdkFields()
static Class<? extends ObdSignal.Builder>	serializableBuilderClass()
Integer	serviceMode() The mode of operation (diagnostic service) in a message.
Integer	startByte() Indicates the beginning of the message.
ObdSignal.Builder	toBuilder()
String	toString() 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:

toBuilder in interface ToCopyableBuilder<ObdSignal.Builder,ObdSignal>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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