Package software.amazon.awscdk.cfnpropertymixins.services.iotfleetwise

Interface CfnDecoderManifestPropsMixin.CanSignalProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDecoderManifestPropsMixin.CanSignalProperty.Jsii$Proxy

Enclosing class:

CfnDecoderManifestPropsMixin

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

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.cfnpropertymixins.services.iotfleetwise.*;
 CanSignalProperty canSignalProperty = CanSignalProperty.builder()
         .factor("factor")
         .isBigEndian("isBigEndian")
         .isSigned("isSigned")
         .length("length")
         .messageId("messageId")
         .name("name")
         .offset("offset")
         .signalValueType("signalValueType")
         .startBit("startBit")
         .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	CfnDecoderManifestPropsMixin.CanSignalProperty.Builder	A builder for CfnDecoderManifestPropsMixin.CanSignalProperty
static final class	CfnDecoderManifestPropsMixin.CanSignalProperty.Jsii$Proxy	An implementation for CfnDecoderManifestPropsMixin.CanSignalProperty

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFactor

@Stability(Stable)
@Nullable
default 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)
@Nullable
default 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)
@Nullable
default 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)
@Nullable
default 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)
@Nullable
default 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

getName

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

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

getOffset

@Stability(Stable)
@Nullable
default 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

getSignalValueType

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

The value type of the signal.

The default value is INTEGER .

See Also:

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

getStartBit

@Stability(Stable)
@Nullable
default 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

builder

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

Returns:

a CfnDecoderManifestPropsMixin.CanSignalProperty.Builder of CfnDecoderManifestPropsMixin.CanSignalProperty