class Channel

Channel list entry for Dacc

Public Methods

Channel(void)

Default Constructor

Channel(const char* name, TSeries** ctlvar, uint_t decim=0)

Construct a channel object

Channel(const Channel& data)

Copy constructor

const Channel& operator=(const Channel& data)

Assignment operator

~Channel()

Destroy a channel entry

bool EqName(const char *name) const

Compare the name

bool getDebug() const

Get the debug flag

uint_t getDecim() const

Get the decimation factor

Time getLast() const

Get the end time

const char* getName() const

Get the channel name

void setAccumulate(bool Acc=true)

Set channel accumulation mode

void setDebug(bool yorn)

Set/clear the debug flag

void allocate(Interval Stride)

Allocate an output TSeries with a specified length

int FillSeries(const FrameCPP::Frame* frame, Interval off, Interval dT)

Fill time series from a frame in memory.

int FillSeries(const FrameCPP::AdcData* adc, const Time& t0, Interval off, Interval dT)

Fill time series from an adcData object.

const TSeries* refSeries(void) const

Reference the TSeries

Channel(void)

Default Constructor

Channel(const char* name, TSeries** ctlvar, uint_t decim=0)

Construct a channel object. Construct an object given a channel name, an output pointer address and a decimation factor.

Channel(const Channel& data)

Copy constructor. Construct a channel object identical to an already existing one.

const Channel& operator=(const Channel& data)

Assignment operator. Copy a channel object to an existing object.

~Channel()

Destroy a channel entry

bool EqName(const char *name) const

Compare the name. EqName() returns true if the channel name is the same as the argument.

bool getDebug() const

Get the debug flag. getDebug() returns the debug flag. When the debug flag is set, Channel methods print messages to cerr any time an error occurs.

uint_t getDecim() const

Get the decimation factor. getDecim() returns the decimation factor.

Time getLast() const

Get the end time. getLast() returns the time of the last sample added to the channel time series.

const char* getName() const

Get the channel name. getName() returns a pointer to the channel name string.

void setAccumulate(bool Acc=true)

Set channel accumulation mode. setAccumulate() sets/clears the accumulate mode for the channel. If accumulate mode is set, the data will be appended to the TSeries. By default the TSeries data are reset with each call to FillData().

void setDebug(bool yorn)

Set/clear the debug flag. The debug flag is set as specified.

void allocate(Interval Stride)

Allocate an output TSeries with a specified length. The user TSeries data vector is expanded to accommodate data over a specified time interval.

int FillSeries(const FrameCPP::Frame* frame, Interval off, Interval dT)

Data from the specified frame are (optionally) decimated and copied into the data vector(s).

Returns:

0	Successful completion
-1	Frame start not contiguous to previous data
-2	Sample rate isn't compatible with previous data.
-3	Requested data not found in current frame
-5	Frame data are not self-consistent.
-6	TSeries is not allocated.
-7	Unsupported data type

Parameters:

frame - Pointer to frame containing data to be read.
off - Time offset to tstart of data.
dT - Time interval to be read in.

int FillSeries(const FrameCPP::AdcData* adc, const Time& t0, Interval off, Interval dT)

Data from the specified adc block are (optionally) decimated and copied into the data vector(s).

Returns:

0	Successful completion
-1	Frame start not contiguous to previous data
-2	Sample rate isn't compatible with previous data.
-3	Requested data not found in current frame
-5	Frame data are not self-consistent.
-6	TSeries is not allocated.
-7	Unsupported data type

Parameters:

adc - Pointer to AdcData containing data.
t0 - Start time for data unpacking.
off - Time offset to tstart of data.
dT - Time interval to be read in.

const TSeries* refSeries(void) const

Reference the TSeries. Data from the specified frame are (optionally) decimated and copied into the data vector(s).

This class has no child classes.

alphabetic index hierarchy of classes

generated by doc++