Struct CRFrame

pub struct CRFrame {
    pub index: HashMap<String, (u64, CRFrameObjectType)>,
    pub bytestorage: Vec<u8>,
    pub tof_paddles: Arc<HashMap<u8, TofPaddle>>,
    pub trk_strips: Arc<HashMap<u32, TrackerStrip>>,
    pub trk_masks: Arc<HashMap<u32, TrackerStripMask>>,
    pub trk_ped: Arc<HashMap<u32, TrackerStripPedestal>>,
    pub trk_tf: Arc<HashMap<u32, TrackerStripTransferFunction>>,
    pub trk_cmn: Arc<HashMap<u32, TrackerStripCmnNoise>>,
    pub do_trk_calib: bool,
    pub subtract_trk_cmn: bool,
}

The central data container of the caraspace suite.

A CRFrame can hold multiple CRFrameObjects and is basically a little sclerite of the entire skeleton.

Fields

index: HashMap<String, (u64, CRFrameObjectType)>

bytestorage: Vec<u8>

tof_paddles: Arc<HashMap<u8, TofPaddle>>

trk_strips: Arc<HashMap<u32, TrackerStrip>>

trk_masks: Arc<HashMap<u32, TrackerStripMask>>

trk_ped: Arc<HashMap<u32, TrackerStripPedestal>>

trk_tf: Arc<HashMap<u32, TrackerStripTransferFunction>>

trk_cmn: Arc<HashMap<u32, TrackerStripCmnNoise>>

do_trk_calib: bool

TRK calibration - convert to energy

subtract_trk_cmn: bool

TRK subtract CMN

Implementations

impl CRFrame

pub fn new() -> Self

pub fn serialize_index(&self) -> Vec<u8>

pub fn parse_index( stream: &Vec<u8>, pos: &mut usize, ) -> HashMap<String, (u64, CRFrameObjectType)>

pub fn delete(&self, name: &str) -> Result<CRFrame, SerializationError>

Delete a CRFrameObject by this name from the frame

To delete multiple objects, delete calls can be chained

Arguments:

• name : The name of the FrameObject to delte (must be in index)

Returns:

A complete copy of self, without the given object.

pub fn put<T: Serialization + Frameable>(&mut self, object: T, name: &str)

Store any eligible object in the frame

Eligible object must implement the “Frameable” trait

pub fn has(&self, name: &str) -> bool

Check if the frame contains an object with the given name

Arguments:

• name : The name of the object as it appears in the index

pub fn get_telemetry_event_names(&self) -> Vec<&str>

A list of TelemetryEvents (fka MergedEvent) in the frame

pub fn get_fobject( &self, name: &str, ) -> Result<CRFrameObject, SerializationError>

pub fn get<T: Serialization + Frameable>( &self, name: &str, ) -> Result<T, SerializationError>

pub fn show_frame(&self) -> String

A verbose display of the frame content

Trait Implementations

impl Clone for CRFrame

fn clone(&self) -> CRFrame

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl DataReader<CRFrame> for CRReader

fn prime_next_file(&mut self) -> Option<usize>

Get the next file ready

fn get_header0(&self) -> u8

fn get_header1(&self) -> u8

fn get_file_idx(&self) -> usize

The current index corresponding to the file the reader is currently working on

fn set_file_idx(&mut self, file_idx: usize)

Set a new file idx corresponding to a file the reader is currently working on

fn get_filenames(&self) -> &Vec<String>

Return all filenames the reader is primed with

fn set_cursor(&mut self, pos: usize)

Manage the internal cursor attribute

fn set_file_reader(&mut self, reader: BufReader<File>)

reset a new reader

fn read_next(&mut self) -> Option<CRFrame>

Get the next frame/packet from the stream. Can be used to implement iterators

fn get_current_filename(&self) -> Option<&str>

The name of the file the reader is currently working on

fn first(&mut self) -> Option<T>

Get the first entry in all of the files the reader is primed with

fn last(&mut self) -> Option<T>

Get the last entry in all of the files the reader is primed with

fn rewind(&mut self) -> Result<()>

Rewind the current file and set the file index to the first file, so data can be read again from the beginning

impl Debug for CRFrame

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

Formats the value using the given formatter.

impl Default for CRFrame

fn default() -> Self

Returns the “default value” for a type.

impl Display for CRFrame

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

Formats the value using the given formatter.

impl Serialization for CRFrame

fn from_bytestream( stream: &Vec<u8>, pos: &mut usize, ) -> Result<Self, SerializationError>

Decode a serializable from a bytestream

fn to_bytestream(&self) -> Vec<u8>

Encode a serializable to a bytestream

const HEAD: u16 = 43_690u16

Byte marker to mark beginning of payload

const TAIL: u16 = 21_845u16

Byte marker to mark end of payload

const SIZE: usize = 0usize

The SIZE is the size of the serialized bytestream INCLUDING 4 bytes for head and tail bytes. In case the struct does NOT HAVE a fixed size, SIZE will be 0 (so default value of the trait

fn verify_fixed( stream: &Vec<u8>, pos: &mut usize, ) -> Result<(), SerializationError>

Verify that the serialized representation of the struct has the correct size, including header + footer.

fn from_bytestream_alt( bytestream: &Vec<u8>, pos: &mut usize, ) -> Result<Self, SerializationError>

where Self: Sized,

Decode a serializable from a bytestream. This provides an alternative method to get the packet. If not implemented, it will be the same as from_bytestream.