Struct aws_sdk_iotfleetwise::types::CanSignal

#[non_exhaustive]
pub struct CanSignal {
    pub message_id: i32,
    pub is_big_endian: bool,
    pub is_signed: bool,
    pub start_bit: i32,
    pub offset: f64,
    pub factor: f64,
    pub length: i32,
    pub name: Option<String>,
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

message_id: i32

The ID of the message.

is_big_endian: bool

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

is_signed: bool

Whether the message data is specified as a signed value.

start_bit: i32

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.

offset: f64

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

factor: f64

A multiplier used to decode the CAN message.

length: i32

How many bytes of data are in the message.

name: Option<String>

The name of the signal.

Implementations

impl CanSignal

pub fn message_id(&self) -> i32

The ID of the message.

pub fn is_big_endian(&self) -> bool

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

pub fn is_signed(&self) -> bool

Whether the message data is specified as a signed value.

pub fn start_bit(&self) -> i32

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.

pub fn offset(&self) -> f64

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

pub fn factor(&self) -> f64

A multiplier used to decode the CAN message.

pub fn length(&self) -> i32

How many bytes of data are in the message.

pub fn name(&self) -> Option<&str>

The name of the signal.

impl CanSignal

pub fn builder() -> CanSignalBuilder

Creates a new builder-style object to manufacture CanSignal.

Trait Implementations

impl Clone for CanSignal

fn clone(&self) -> CanSignal

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CanSignal

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CanSignal

fn eq(&self, other: &CanSignal) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CanSignal