Struct RunConfig

pub struct RunConfig {
    pub runid: u32,
    pub is_active: bool,
    pub nevents: u32,
    pub nseconds: u32,
    pub tof_op_mode: TofOperationMode,
    pub trigger_poisson_rate: u32,
    pub trigger_fixed_rate: u32,
    pub data_type: DataType,
    pub rb_buff_size: u16,
}

Readoutboard configuration for a specific run

Fields

runid: u32

an unique identifier for this run

is_active: bool

start/stop run

This might get deprecated in a future version!

nevents: u32

limit run to number of events

nseconds: u32

limit run time to number of seconds

tof_op_mode: TofOperationMode

tof operation mode - either “StreamAny”, “RequestReply” or “RBHighThroughput”

trigger_poisson_rate: u32

if different from 0, activate RB self trigger in poisson mode

trigger_fixed_rate: u32

if different from 0, activate RB self trigger with fixed rate setting

data_type: DataType

Either “Physics” or a calibration related data type, e.g. “VoltageCalibration”.

This might get deprecated in a future version!

rb_buff_size: u16

The value when the readout of the RB buffers is triggered. This number is in size of full events, which correspond to 18530 bytes. Maximum buffer size is a bit more than 3000 events. Smaller buffer allows for a more snappy reaction, but might require more CPU resources (on the board)

Implementations

impl RunConfig

pub fn new() -> Self

Trait Implementations

impl Clone for RunConfig

fn clone(&self) -> RunConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RunConfig

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

Formats the value using the given formatter.

impl Default for RunConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RunConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for RunConfig

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

Formats the value using the given formatter.

impl PartialEq for RunConfig

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

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

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 Serialization for RunConfig

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 = 29usize

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 from_bytestream( bytestream: &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

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.

impl Serialize for RunConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TofPackable for RunConfig

const TOF_PACKET_TYPE: TofPacketType = TofPacketType::RunConfig

const TOF_PACKET_TYPE_ALT: TofPacketType = TofPacketType::Unknown

fn pack(&self) -> TofPacket

where Self: Serialization,

Wrap myself in a TofPacket

impl Copy for RunConfig

impl StructuralPartialEq for RunConfig