Struct ChannelGroup 

pub struct ChannelGroup {
    pub id: usize,
    pub index: usize,
    pub data_group_index: usize,
    pub acquisition_name: String,
    pub sample_count: u64,
    pub channels: Vec<Channel>,
    pub source: Option<SourceInfo>,
    pub comment: String,
    /* private fields */
}

A channel group containing channels sampled together.

All channels in a channel group share the same time axis and have the same number of samples.

Fields

id: usize

Unique identifier for this channel group.

index: usize

Index of this channel group within its data group.

data_group_index: usize

Data group index this channel group belongs to.

acquisition_name: String

Acquisition name.

sample_count: u64

Number of samples (cycles).

channels: Vec<Channel>

Channels in this group.

source: Option<SourceInfo>

Source information.

comment: String

Comment/description.

Implementations

impl ChannelGroup

pub fn channel_count(&self) -> usize

Returns the number of channels in this group.

pub fn master_channel(&self) -> Option<&Channel>

Finds the master (time) channel in this group.

pub fn find_channel(&self, name: &str) -> Option<&Channel>

Finds a channel by name.

pub fn record_size(&self, rec_id_size: u8) -> usize

Returns the total record size including record ID and invalidation bytes.

pub fn data_bytes_len(&self) -> usize

Returns the number of channel-data bytes per record, excluding both the record ID and the invalidation bytes.

pub fn inval_bytes_len(&self) -> usize

Returns the number of invalidation bytes per record.

pub fn sample_reductions(&self) -> &[SampleReduction]

Returns the sample-reduction levels attached to this group.

Each describes a condensed view of the group’s data. The reduced values themselves cannot be read — see SampleReduction.

pub fn record_id(&self) -> u64

Returns the record ID identifying this group within an unsorted stream.

pub fn is_vlsd(&self) -> bool

Returns true if this group stores variable-length signal data rather than channel records.

pub fn is_bus_event(&self) -> bool

Returns true if this group holds logged bus traffic rather than measurements.

The frames themselves are read with crate::Mf4File::can_frames when the traffic is CAN.

pub fn is_plain_bus_event(&self) -> bool

Returns true if this group holds nothing but bus events.

The flag says no decoded signal channels share the group with the raw frames; it does not mean the frame fields themselves are stored in some reduced form. Every CANedge log in the test corpus sets it while carrying the full set of composition channels, so it is no obstacle to crate::Mf4File::can_frames and should not be used to decide whether a group is readable.

pub fn matches_offset(&self, offset: u64) -> bool

Returns true if this group’s block sits at offset in the file, which is how a variable-length channel names the group holding its payloads.

pub fn block_offset(&self) -> u64

Returns the file offset of this group’s CG block.

See DataGroup::block_offset for why an address is what is offered.

pub fn payload_size(&self) -> usize

Returns the size of a record’s own bytes, excluding any record ID.

This is the stride that applies once records have been separated from an interleaved stream, where the record ID is no longer present.

Trait Implementations

impl Clone for ChannelGroup

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChannelGroup

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

Formats the value using the given formatter.