Package software.amazon.awssdk.services.iotfleetwise.model

Class CanSignal

java.lang.Object

software.amazon.awssdk.services.iotfleetwise.model.CanSignal

All Implemented Interfaces:

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

@Generated("software.amazon.awssdk:codegen")
public final class CanSignal
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CanSignal.Builder,CanSignal>

Information about a single controller area network (CAN) signal and the messages it receives and transmits.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CanSignal.Builder

Method Summary

Modifier and Type	Method	Description
static CanSignal.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Double	factor()	A multiplier used to decode the CAN message.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	isBigEndian()	Whether the byte ordering of a CAN message is big-endian.
Boolean	isSigned()	Whether the message data is specified as a signed value.
Integer	length()	How many bytes of data are in the message.
Integer	messageId()	The ID of the message.
String	name()	The name of the signal.
Double	offset()	The offset used to calculate the signal value.
List<SdkField<?>>	sdkFields()
static Class<? extends CanSignal.Builder>	serializableBuilderClass()
Integer	startBit()	Indicates the beginning of the CAN signal.
CanSignal.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

messageId

public final Integer messageId()

The ID of the message.

Returns:

The ID of the message.

isBigEndian

public final Boolean isBigEndian()

Whether the byte ordering of a CAN message is big-endian.

Returns:

Whether the byte ordering of a CAN message is big-endian.

isSigned

public final Boolean isSigned()

Whether the message data is specified as a signed value.

Returns:

Whether the message data is specified as a signed value.

startBit

public final Integer startBit()

Indicates the beginning of the CAN signal. This should always be the least significant bit (LSB).

This value might be different from the value in a DBC file. For little endian signals, startBit is the same value as in the DBC file. For big endian signals in a DBC file, the start bit is the most significant bit (MSB). You will have to calculate the LSB instead and pass it as the startBit.

Returns:

Indicates the beginning of the CAN signal. This should always be the least significant bit (LSB).

This value might be different from the value in a DBC file. For little endian signals, startBit is the same value as in the DBC file. For big endian signals in a DBC file, the start bit is the most significant bit (MSB). You will have to calculate the LSB instead and pass it as the startBit.

offset

public final Double offset()

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

Returns:

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

factor

public final Double factor()

A multiplier used to decode the CAN message.

Returns:

A multiplier used to decode the CAN message.

length

public final Integer length()

How many bytes of data are in the message.

Returns:

How many bytes of data are in the message.

name

public final String name()

The name of the signal.

Returns:

The name of the signal.

toBuilder

public CanSignal.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CanSignal.Builder,CanSignal>

builder

public static CanSignal.Builder builder()

serializableBuilderClass

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