Struct sttp::transport::CompactMeasurement

pub struct CompactMeasurement { /* private fields */ }

Represents a compact Measurement for transmission or reception in the STTP API.

Implementations

impl CompactMeasurement

pub fn new(
    signal_index_cache: Arc<SignalIndexCache>,
    include_time: bool,
    use_millisecond_resolution: bool
) -> Self

Creates a new CompactMeasurement.

pub fn include_time(&self) -> bool

Gets flag that determines if time is serialized into measurement binary image.

pub fn get_binary_length(&mut self) -> usize

Gets the length of the CompactMeasurement.

pub fn get_timestamp_c2(&self) -> u16

Gets offset compressed millisecond-resolution 2-byte timestamp.

pub fn get_timestamp_c4(&self) -> u32

Gets offset compressed tick-resolution 4-byte timestamp.

pub fn get_compact_state_flags(&self) -> u8

Gets byte level compact state flags with encoded time index and base time offset bits.

pub fn set_compact_state_flags(&mut self, value: u8)

Sets byte level compact state flags with encoded time index and base time offset bits.

pub fn get_runtime_id(&self) -> i32

Gets the 4-byte run-time signal index for this measurement.

pub fn set_runtime_id(&mut self, signal_index: i32)

Sets the 4-byte run-time signal index for this measurement.

pub fn decode(&mut self, buffer: &[u8]) -> Result<usize, Box<dyn Error>>

parses a CompactMeasurement from the specified byte buffer.

Trait Implementations

impl Clone for CompactMeasurement

fn clone(&self) -> CompactMeasurement

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CompactMeasurement

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

Formats the value using the given formatter.

impl Display for CompactMeasurement

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

Formats the value using the given formatter.

impl Measurement for CompactMeasurement

fn signal_id(&self) -> Uuid

Gets measurement’s globally unique identifier.

fn set_signal_id(&mut self, signal_id: Uuid)

Sets measurement’s globally unique identifier.

fn value(&self) -> f64

Gets instantaneous value of the measurement.

fn set_value(&mut self, value: f64)

Sets instantaneous value of the measurement.

fn timestamp(&self) -> Ticks

Gets the STTP uint64 timestamp, in ticks, that measurement was taken.

fn set_timestamp(&mut self, timestamp: Ticks)

Sets the STTP uint64 timestamp, in ticks, that measurement was taken.

fn flags(&self) -> StateFlags

Gets flags indicating the state of the measurement as reported by the device that took it.

fn set_flags(&mut self, flags: StateFlags)

Sets flags indicating the state of the measurement as reported by the device that took it.

fn timestamp_value(&self) -> u64

Gets the integer-based time from a Measurement ticks-based timestamp, i.e., the 62-bit time value excluding any leap-second flags.

fn datetime(&self) -> DateTime<Utc>

Gets Measurement ticks-based timestamp as a standard Rust DateTime value.

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

Formats the Measurement using a default formatter.