Package software.amazon.awscdk.services.iotfleetwise

Interface CfnDecoderManifest.SignalDecodersItemsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDecoderManifest.SignalDecodersItemsProperty.Jsii$Proxy

Enclosing class:

CfnDecoderManifest

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

Information about a signal decoder.

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.*;
 SignalDecodersItemsProperty signalDecodersItemsProperty = SignalDecodersItemsProperty.builder()
         .fullyQualifiedName("fullyQualifiedName")
         .interfaceId("interfaceId")
         .type("type")
         // the properties below are optional
         .canSignal(CanSignalProperty.builder()
                 .factor("factor")
                 .isBigEndian("isBigEndian")
                 .isSigned("isSigned")
                 .length("length")
                 .messageId("messageId")
                 .offset("offset")
                 .startBit("startBit")
                 // the properties below are optional
                 .name("name")
                 .build())
         .obdSignal(ObdSignalProperty.builder()
                 .byteLength("byteLength")
                 .offset("offset")
                 .pid("pid")
                 .pidResponseLength("pidResponseLength")
                 .scaling("scaling")
                 .serviceMode("serviceMode")
                 .startByte("startByte")
                 // the properties below are optional
                 .bitMaskLength("bitMaskLength")
                 .bitRightShift("bitRightShift")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDecoderManifest.SignalDecodersItemsProperty.Builder	builder()
default Object	getCanSignal()	(Optional) Information about a single controller area network (CAN) signal and the messages it receives and transmits.
String	getFullyQualifiedName()	The fully qualified name of a signal decoder as defined in a vehicle model.
String	getInterfaceId()	The ID of a network interface that specifies what network protocol a vehicle follows.
default Object	getObdSignal()	(Optional) Information about signal messages using the on-board diagnostics (OBD) II protocol in a vehicle.
String	getType()	The network protocol for the vehicle.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFullyQualifiedName

@Stability(Stable)
@NotNull
String getFullyQualifiedName()

The fully qualified name of a signal decoder as defined in a vehicle model.

getInterfaceId

@Stability(Stable)
@NotNull
String getInterfaceId()

The ID of a network interface that specifies what network protocol a vehicle follows.

getType

@Stability(Stable)
@NotNull
String getType()

The network protocol for the vehicle.

For example, CAN_SIGNAL specifies a protocol that defines how data is communicated between electronic control units (ECUs). OBD_SIGNAL specifies a protocol that defines how self-diagnostic data is communicated between ECUs.

getCanSignal

@Stability(Stable)
@Nullable
default Object getCanSignal()

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

getObdSignal

@Stability(Stable)
@Nullable
default Object getObdSignal()

(Optional) Information about signal messages using the on-board diagnostics (OBD) II protocol in a vehicle.

builder

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

Returns:

a CfnDecoderManifest.SignalDecodersItemsProperty.Builder of CfnDecoderManifest.SignalDecodersItemsProperty