Transient Recorder Framework
Public Attributes | Friends | List of all members
TRArmInfo Class Reference

Information provided by the driver to the framework at the start of arming. More...

#include <TRArmInfo.h>

Inheritance diagram for TRArmInfo:

Public Attributes

double rate_for_display
 The driver MUST set this to the display sample rate. More...
 
bool custom_time_array_calc_inputs
 Enable custom sample number inputs for calculation of the time array. More...
 
int custom_time_array_num_pre_samples
 Custom number of pre-trigger samples for the time array. More...
 
int custom_time_array_num_post_samples
 Custom number of post-trigger samples for the time array. More...
 

Friends

class TRBaseDriver
 

Detailed Description

Information provided by the driver to the framework at the start of arming.

An instance of this is passed to the driver in TRBaseDriver::checkSettings where the driver should fill in the relevant data.

Member Data Documentation

double TRArmInfo::rate_for_display

The driver MUST set this to the display sample rate.

Notably, this will used for computing the time array.

bool TRArmInfo::custom_time_array_calc_inputs

Enable custom sample number inputs for calculation of the time array.

If this is true, than custom_time_array_num_pre_samples and custom_time_array_num_post_samples will be used to calculate the time array instead of the desired sample number settings. The default is false.

int TRArmInfo::custom_time_array_num_pre_samples

Custom number of pre-trigger samples for the time array.

The default is zero, and this is only relevant if custom_time_array_calc_inputs is true.

int TRArmInfo::custom_time_array_num_post_samples

Custom number of post-trigger samples for the time array.

The default is zero, and this is only relevant if custom_time_array_calc_inputs is true.


The documentation for this class was generated from the following file: