software.amazon.awssdk.services.iotfleetwise.model

Interface CanSignal.Builder

All Superinterfaces:

Buildable, CopyableBuilder<CanSignal.Builder,CanSignal>, SdkBuilder<CanSignal.Builder,CanSignal>, SdkPojo

Enclosing class:

CanSignal

public static interface CanSignal.Builder
extends SdkPojo, CopyableBuilder<CanSignal.Builder,CanSignal>

Method Summary

Modifier and Type	Method and Description
CanSignal.Builder	factor(Double factor) A multiplier used to decode the CAN message.
CanSignal.Builder	isBigEndian(Boolean isBigEndian) Whether the byte ordering of a CAN message is big-endian.
CanSignal.Builder	isSigned(Boolean isSigned) Whether the message data is specified as a signed value.
CanSignal.Builder	length(Integer length) How many bytes of data are in the message.
CanSignal.Builder	messageId(Integer messageId) The ID of the message.
CanSignal.Builder	name(String name) The name of the signal.
CanSignal.Builder	offset(Double offset) The offset used to calculate the signal value.
CanSignal.Builder	startBit(Integer startBit) Indicates the beginning of the CAN signal.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

messageId

CanSignal.Builder messageId(Integer messageId)

The ID of the message.

Parameters:

messageId - The ID of the message.

Returns:

Returns a reference to this object so that method calls can be chained together.

isBigEndian

CanSignal.Builder isBigEndian(Boolean isBigEndian)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

isSigned

CanSignal.Builder isSigned(Boolean isSigned)

Whether the message data is specified as a signed value.

Parameters:

isSigned - Whether the message data is specified as a signed value.

Returns:

Returns a reference to this object so that method calls can be chained together.

startBit

CanSignal.Builder startBit(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

offset

CanSignal.Builder offset(Double offset)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

factor

CanSignal.Builder factor(Double factor)

A multiplier used to decode the CAN message.

Parameters:

factor - A multiplier used to decode the CAN message.

Returns:

Returns a reference to this object so that method calls can be chained together.

length

CanSignal.Builder length(Integer length)

How many bytes of data are in the message.

Parameters:

length - How many bytes of data are in the message.

Returns:

Returns a reference to this object so that method calls can be chained together.

name

CanSignal.Builder name(String name)

The name of the signal.

Parameters:

name - The name of the signal.

Returns:

Returns a reference to this object so that method calls can be chained together.