Interface CfnDecoderManifest.CanSignalProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

@Stability(Stable) public static interface CfnDecoderManifest.CanSignalProperty extends
(Optional) Information about a single controller area network (CAN) signal and the messages it receives and transmits.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 CanSignalProperty canSignalProperty = CanSignalProperty.builder()
         // the properties below are optional
  • Method Details

    • getFactor

      @Stability(Stable) @NotNull String getFactor()
      A multiplier used to decode the CAN message.
    • getIsBigEndian

      @Stability(Stable) @NotNull String getIsBigEndian()
      Whether the byte ordering of a CAN message is big-endian.
    • getIsSigned

      @Stability(Stable) @NotNull String getIsSigned()
      Whether the message data is specified as a signed value.
    • getLength

      @Stability(Stable) @NotNull String getLength()
      How many bytes of data are in the message.
    • getMessageId

      @Stability(Stable) @NotNull String getMessageId()
      The ID of the message.
    • 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 .

    • getStartBit

      @Stability(Stable) @NotNull String getStartBit()
      Indicates the beginning of the CAN message.
    • getName

      @Stability(Stable) @Nullable default String getName()
      (Optional) The name of the signal.
    • builder

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