class Trend

Accumulate and write trend data frames.

Public Classes

enum TrendType

Enumerate trend types

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

Type of data contained in TSeries

Public Methods

Trend(const Trend& x)

Copy Constructor

explicit Trend(const char* Name, TrendType type=kSecond, count_t FrameL=0)

Constructor

~Trend()

Destructor

bool exists(const char* ChName) const

Test whether the specified channel has been defined

TrendChan& find(const char* ChName)

Find the entry for the specified channel

const TrendChan& find(const char* ChName) const

Get a constant reference to the entry dfor the specfied channel

std::string getName(void) const

Return the trend channel group name

std::string getFileName(void) const

Return the trend file name

void addChannel(const char* Name)

Add a trend channel.

void close(void)

Close the trend.

void open(void)

open the trend FrWriter.

void trendData(const char* Name, const TSeries& ts)

add a single point.

void trendData(const char* Name, const Time& t, math_t point)

add a single point.

void setFile(const char* Name)

Set the trend name.

void setFrameLen(int nSample)

Set the maximum number of samples in a frame.

void setIFO(const char* ifo)

Set IFO name.

void setName(const char* Name)

Set the trend channel group name.

void setSample(Interval time)

Set the sample interval

void setType(TrendType type)

Set the trend name.

typedef TrendAcc::count_t count_t

Data type for data counts

typedef TrendAcc::math_t math_t

Arithmetic data type

typedef float trend_t

Type of data contained in TSeries

enum TrendType

Enumerate trend types

Trend(const Trend& x)

Copy Constructor

explicit Trend(const char* Name, TrendType type=kSecond, count_t FrameL=0)

Constructor

~Trend()

Destructor

bool exists(const char* ChName) const

Test whether the specified channel has been defined

TrendChan& find(const char* ChName)

Find the entry for the specified channel

const TrendChan& find(const char* ChName) const

Get a constant reference to the entry dfor the specfied channel

std::string getName(void) const

Return the trend channel group name

std::string getFileName(void) const

Return the trend file name. The file name is either specified explicitly, or written to the data

void addChannel(const char* Name)

A channel is added to the trend channel list. Each trend channel list entry consists of a trend accumulator, and five time series containing accumulated entry count, mean, rms, minimum and maximum.

Parameters:

Name - Name of the new trend channel.

void close(void)

Write out the currently accumulated trend data and close the file.

void open(void)

Open the trend Frame writer.

void trendData(const char* Name, const TSeries& ts)

Add a data point to the trend running average.

Parameters:

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

void trendData(const char* Name, 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 setFile(const char* Name)

Set the trend file name.

Parameters:

Name - Name for the trend data.

void setFrameLen(int nSample)

Set the maximum number of trend samples to be written in a single frame.

Parameters:

nSample - Maximum number of samples to be written to a frame.

void setIFO(const char* ifo)

Set the interferometer ID. The interferometer ID is used as the first field of the trend frame file name.

Parameters:

ifo - IFO name.

void setName(const char* Name)

Set the trend channel group name. When the trend is written the name is used as a file extension and as a frame name.

Parameters:

Name - Name for the trend channel group.

void setSample(Interval time)

Set the sample interval for non-standard trends.

Parameters:

Name - Name for the trend data.

void setType(TrendType type)

Set the trend type and assigns an appropriate sample interval.

Parameters:

Name - Name for the trend data.

This class has no child classes.

Author:

John Zweizig.

Version:

1.1; Modified August 7, 2000.

alphabetic index hierarchy of classes

generated by doc++