class Channel

Channel list entry for Dacc

Inheritance:

Public Methods

	Channel (void) Default Constructor
	Channel (const char* name, TSeries** ctlvar, uint_type decim=0, ChanType t=kUnknown) Construct a channel object. Construct an object given a channel name, a decimation fator, an output pointer address and a channel type.
	Channel (const char* name, FSeries** ctlvar) Construct a channel object. Construct an object given a channel name, a decimation fator, an output pointer address and a channel type.
	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	Equal (const char *name, ChanType t=kUnknown) const Compare the name and type. Equal returns true if the channel name is the same as the argument and the channel type is the same, or the requested type is unknown.
bool	getDebug (void) 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_type	getDecim (void) const Get the decimation factor. getDecim() returns the decimation factor.
Time	getLast (void) const Get the end time. getLast() returns the time of the last sample added to the channel time series.
const char*	getName (void) const Get the channel name. getName() returns a pointer to the channel name string.
ChanType	getType (void) const Get the channel type. The channel type is returned. The type can be kUnknown if the type has not been specified and no data from this channel has been read, kRaw if the channel is a raw (Adc) data channel or kProcessed if the data are in a process data channel.
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::FrameH* frame, Interval off, Interval dT) Fill time series from a frame in memory.
int	FillSeries (const FrameCPP::FrAdcData* adc, const Time& t0, Interval off, Interval dT) Fill time series from an adcData object.
int	FillSeries (const FrameCPP::FrProcData* proc, const Time& t0, Interval off, Interval dT) Fill time series from an FrProcData object.
int	FillSeries (const FrameCPP::FrSimData* proc, const Time& t0, Interval off, Interval dT) Fill time series from an FrSimData object.
const TSeries*	refSeries (void) const Reference the TSeries.
const FSeries*	refFSeries (void) const Reference the FSeries.
void	reserve (Interval dT) resize the target series to accomodate the specified interval.

Channel(void)

Default Constructor

Channel(const char* name, TSeries** ctlvar, uint_type decim=0, ChanType t=kUnknown)

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

Channel(const char* name, FSeries** ctlvar)

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

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 Equal(const char *name, ChanType t=kUnknown) const

Compare the name and type. Equal returns true if the channel name is the same as the argument and the channel type is the same, or the requested type is unknown.

bool getDebug(void) 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_type getDecim(void) const

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

Time getLast(void) const

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

const char* getName(void) const

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

ChanType getType(void) const

Get the channel type. The channel type is returned. The type can be kUnknown if the type has not been specified and no data from this channel has been read, kRaw if the channel is a raw (Adc) data channel or kProcessed if the data are in a process data channel.

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::FrameH* 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::FrAdcData* 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 FrAdcData containing data.
t0 - Start time for data unpacking.
off - Time offset to tstart of data.
dT - Time interval to be read in.

int FillSeries(const FrameCPP::FrProcData* proc, const Time& t0, Interval off, Interval dT)

Data from the specified FrProcData 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:

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

int FillSeries(const FrameCPP::FrSimData* proc, const Time& t0, Interval off, Interval dT)

Data from the specified FrSimData 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:

proc - Pointer to FrSimData 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

A pointer to the filled time series is returned.

const FSeries* refFSeries(void) const

Return a pointer to the frequency series filled by the last call to FillSeries.

void reserve(Interval dT)

Sufficient space is reserved in the target time series to accomodate the specified interval. No action is taken if the sample rate is unknown (zero) or if the target series is a frequency series.

Parameters:

dT - Time interval for which space is to be reserved.

alphabetic index hierarchy of classes

Please send questions and comments to zweizig_j@ligo.caltech.edu

generated by doc++