Package software.amazon.awscdk.services.iotfleetwise

Interface CfnDecoderManifest.CanSignalProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDecoderManifest.CanSignalProperty.Jsii$Proxy

Enclosing class:

CfnDecoderManifest

@Stability(Stable)
public static interface CfnDecoderManifest.CanSignalProperty
extends software.amazon.jsii.JsiiSerializable

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iotfleetwise.*;
 CanSignalProperty canSignalProperty = CanSignalProperty.builder()
         .factor("factor")
         .isBigEndian("isBigEndian")
         .isSigned("isSigned")
         .length("length")
         .messageId("messageId")
         .offset("offset")
         .startBit("startBit")
         // the properties below are optional
         .name("name")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignal.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDecoderManifest.CanSignalProperty.Builder	A builder for CfnDecoderManifest.CanSignalProperty
static final class	CfnDecoderManifest.CanSignalProperty.Jsii$Proxy	An implementation for CfnDecoderManifest.CanSignalProperty

Method Summary

Modifier and Type	Method	Description
static CfnDecoderManifest.CanSignalProperty.Builder	builder()
String	getFactor()	A multiplier used to decode the CAN message.
String	getIsBigEndian()	Whether the byte ordering of a CAN message is big-endian.
String	getIsSigned()	Whether the message data is specified as a signed value.
String	getLength()	How many bytes of data are in the message.
String	getMessageId()	The ID of the message.
default String	getName()	(Optional) The name of the signal.
String	getOffset()	The offset used to calculate the signal value.
String	getStartBit()	Indicates the beginning of the CAN message.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFactor

@Stability(Stable)
@NotNull
String getFactor()

A multiplier used to decode the CAN message.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignal.html#cfn-iotfleetwise-decodermanifest-cansignal-factor

getIsBigEndian

@Stability(Stable)
@NotNull
String getIsBigEndian()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignal.html#cfn-iotfleetwise-decodermanifest-cansignal-isbigendian

getIsSigned

@Stability(Stable)
@NotNull
String getIsSigned()

Whether the message data is specified as a signed value.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignal.html#cfn-iotfleetwise-decodermanifest-cansignal-issigned

getLength

@Stability(Stable)
@NotNull
String getLength()

How many bytes of data are in the message.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignal.html#cfn-iotfleetwise-decodermanifest-cansignal-length

getMessageId

@Stability(Stable)
@NotNull
String getMessageId()

The ID of the message.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignal.html#cfn-iotfleetwise-decodermanifest-cansignal-messageid

getOffset

@Stability(Stable)
@NotNull
String getOffset()

The offset used to calculate the signal value.

Combined with factor, the calculation is value = raw_value * factor + offset .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignal.html#cfn-iotfleetwise-decodermanifest-cansignal-offset

getStartBit

@Stability(Stable)
@NotNull
String getStartBit()

Indicates the beginning of the CAN message.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignal.html#cfn-iotfleetwise-decodermanifest-cansignal-startbit

getName

@Stability(Stable)
@Nullable
default String getName()

(Optional) The name of the signal.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignal.html#cfn-iotfleetwise-decodermanifest-cansignal-name

builder

@Stability(Stable)
static CfnDecoderManifest.CanSignalProperty.Builder builder()

Returns:

a CfnDecoderManifest.CanSignalProperty.Builder of CfnDecoderManifest.CanSignalProperty