class TrendChan

Make trend frames.

Inheritance:

Public Fields

typedef TrendAcc::count_t	count_t Data type for data counts
typedef TrendAcc::math_t	math_t Arithmetic data type
typedef float	trend_t TSeries data type

Public Methods

static bool	validName (const std::string& chan, std::string& monid) Check for valid name.
	TrendChan (void) Default Constructor
	TrendChan (const TrendChan& x) Copy Constructor
explicit	TrendChan (const char* Name, Interval nAvg) Constructor
	~TrendChan () Destructor
TrendChan&	operator= (const TrendChan& x) Assignment operator
TrendChan&	operator+= (const TrendChan& x) Addition operator
std::ostream&	dump (std::ostream& os) const Dump the channel status
std::string	getName (void) const Return the base name of the trend channel time series to be generated
Time	getEndTime (void) const Return the end of the time series
long	getNSample (const Time& tStart, const Time& tStop) const Get the number of samples in the current frame
bool	isEmpty (void) const Test for trended data.
void	addData (const TSeries& ts) add a single point.
void	addData (const Time& t, math_t point) add a single point.
void	clear (void) Clear all data
void	discard (const Time& t) remove data from front of trend.
void	extend (const Time& t) Extend time series.
const TSeries&	refAvgSeries (void) const Get a reference to the current average value series
const TSeries&	refMaxSeries (void) const Get a reference to the current maximum entry series
const TSeries&	refMinSeries (void) const Get a reference to the current minimum entry series
const TSeries&	refNSeries (void) const Get a reference to the current entry count series
const TSeries&	refRmsSeries (void) const Get a reference to the current RMS series
void	setData (const TSeries& Avg) Set the portion of the current trend covered by the argument series to the argument data
void	setData (const TSeries& Avg, const TSeries& Rms, const TSeries& Min, const TSeries& Max, const TSeries& Num) Set the portion of the current trend covered by the argument series to the argument data
void	setName (const char* Name) Set the trend name.
void	setReadout (Dacc& In) Ancillary read functions
void	startFrame (const Time& start) Start a new trend frame.
void	synch (const Time& t=Time(0)) Synchronize trend series to current data.
void	write (FrWriter& writer) Write data to a frame

typedef TrendAcc::count_t count_t

Data type for data counts

typedef TrendAcc::math_t math_t

Arithmetic data type

typedef float trend_t

TSeries data type

static bool validName(const std::string& chan, std::string& monid)

Check that the specified string is a valid DMT trend channel name.

Returns:

true if name is valid.

Parameters:

chan - Channel name string to be tested

TrendChan(void)

Default Constructor

TrendChan(const TrendChan& x)

Copy Constructor

explicit TrendChan(const char* Name, Interval nAvg)

Constructor

~TrendChan()

Destructor

TrendChan& operator=(const TrendChan& x)

Assignment operator

TrendChan& operator+=(const TrendChan& x)

Addition operator

std::ostream& dump(std::ostream& os) const

Dump the channel status

std::string getName(void) const

Return the base name of the trend channel time series to be generated

Time getEndTime(void) const

Return the end of the time series

long getNSample(const Time& tStart, const Time& tStop) const

Get the number of samples in the current frame

bool isEmpty(void) const

Test whether any data has been trended.

Returns:

True if trend data exist.

void addData(const TSeries& ts)

Add a data point to the trend running average.

Parameters:

point - The value of the next element of a series.

void addData(const Time& t, math_t point)

Add a data point to the trend running average.

Parameters:

point - The value of the next element of a series.

void clear(void)

Clear all data

void discard(const Time& t)

Delete data up to (but not including) the specified time. Data are discarded from all time series in the trend channel.

Parameters:

t - new trend start-time.

void extend(const Time& t)

Extend all the trend series to the specified time.

Parameters:

t - new trend end-time.

const TSeries& refAvgSeries(void) const

Get a reference to the current average value series

const TSeries& refMaxSeries(void) const

Get a reference to the current maximum entry series

const TSeries& refMinSeries(void) const

Get a reference to the current minimum entry series

const TSeries& refNSeries(void) const

Get a reference to the current entry count series

const TSeries& refRmsSeries(void) const

Get a reference to the current RMS series

void setData(const TSeries& Avg)

Set the portion of the current trend covered by the argument series to the argument data. All data (mean, rms, min, max) are set to the same values and the number of averages is set to 1 over the same range.

void setData(const TSeries& Avg, const TSeries& Rms, const TSeries& Min, const TSeries& Max, const TSeries& Num)

Set the portion of the current trend covered by the argument series to the argument data

void setName(const char* Name)

Set the trend name and assign names to the constituent time series. When the trend is written these derived names will be used as the "ADC" names in the frame file.

Parameters:

Name - Name for the trend data.

void setReadout(Dacc& In)

Ancillary read functions

void startFrame(const Time& start)

Start accumulating a trend series. Any data alrady accumulated before the frame start time is discarded. The frame start time is saved.

void synch(const Time& t=Time(0))

Force current point into trend series, and pad the time series to the specified time.

Parameters:

t - Time to which the data will be padded.

void write(FrWriter& writer)

Write data to a frame

This class has no child classes.

Author:

John Zweizig.

Version:

1.0; Modified February 28, 2000.

alphabetic index hierarchy of classes

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

generated by doc++