Struct CanSignalBuilder

#[non_exhaustive]
pub struct CanSignalBuilder { /* private fields */ }

A builder for CanSignal.

Implementations

impl CanSignalBuilder

pub fn message_id(self, input: i32) -> Self

The ID of the message.

This field is required.

pub fn set_message_id(self, input: Option<i32>) -> Self

The ID of the message.

pub fn get_message_id(&self) -> &Option<i32>

The ID of the message.

pub fn is_big_endian(self, input: bool) -> Self

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

This field is required.

pub fn set_is_big_endian(self, input: Option<bool>) -> Self

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

pub fn get_is_big_endian(&self) -> &Option<bool>

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

pub fn is_signed(self, input: bool) -> Self

Determines whether the message is signed (true) or not (false). If it's signed, the message can represent both positive and negative numbers. The isSigned parameter only applies to the INTEGER raw signal type, and it doesn't affect the FLOATING_POINT raw signal type.

This field is required.

pub fn set_is_signed(self, input: Option<bool>) -> Self

Determines whether the message is signed (true) or not (false). If it's signed, the message can represent both positive and negative numbers. The isSigned parameter only applies to the INTEGER raw signal type, and it doesn't affect the FLOATING_POINT raw signal type.

pub fn get_is_signed(&self) -> &Option<bool>

Determines whether the message is signed (true) or not (false). If it's signed, the message can represent both positive and negative numbers. The isSigned parameter only applies to the INTEGER raw signal type, and it doesn't affect the FLOATING_POINT raw signal type.

pub fn start_bit(self, input: i32) -> Self

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.

This field is required.

pub fn set_start_bit(self, input: Option<i32>) -> Self

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 get_start_bit(&self) -> &Option<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, input: f64) -> Self

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

This field is required.

pub fn set_offset(self, input: Option<f64>) -> Self

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

pub fn get_offset(&self) -> &Option<f64>

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

pub fn factor(self, input: f64) -> Self

A multiplier used to decode the CAN message.

This field is required.

pub fn set_factor(self, input: Option<f64>) -> Self

A multiplier used to decode the CAN message.

pub fn get_factor(&self) -> &Option<f64>

A multiplier used to decode the CAN message.

pub fn length(self, input: i32) -> Self

How many bytes of data are in the message.

This field is required.

pub fn set_length(self, input: Option<i32>) -> Self

How many bytes of data are in the message.

pub fn get_length(&self) -> &Option<i32>

How many bytes of data are in the message.

pub fn name(self, input: impl Into<String>) -> Self

The name of the signal.

pub fn set_name(self, input: Option<String>) -> Self

The name of the signal.

pub fn get_name(&self) -> &Option<String>

The name of the signal.

pub fn signal_value_type(self, input: SignalValueType) -> Self

The value type of the signal. The default value is INTEGER.

pub fn set_signal_value_type(self, input: Option<SignalValueType>) -> Self

The value type of the signal. The default value is INTEGER.

pub fn get_signal_value_type(&self) -> &Option<SignalValueType>

The value type of the signal. The default value is INTEGER.

pub fn build(self) -> Result<CanSignal, BuildError>

Consumes the builder and constructs a CanSignal. This method will fail if any of the following fields are not set:

• offset
• factor

Trait Implementations

impl Clone for CanSignalBuilder

fn clone(&self) -> CanSignalBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CanSignalBuilder

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

Formats the value using the given formatter.

impl Default for CanSignalBuilder

fn default() -> CanSignalBuilder

Returns the “default value” for a type.

impl PartialEq for CanSignalBuilder

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for CanSignalBuilder