FrWriter

class FrWriter

DMT frame writer API.

Public Methods
FrWriter(void): Default (Null) constructor
FrWriter(const char* Name, int Run): Construct and connect to destination file
~FrWriter(void): Destructor
void setDebug(int debug=0): Set the debug flag.
void addChannel(const char* Name, TSeries** TSptr=0): Add a channel to the request list.
void rmChannel(const char* Name): Remove a channel from the request list.
int open(const char* File, bool toc=false): Open a file.
int open(FrameCPP::Output* writer): Open a file specified by a framewriter.
void close(void): Close the current data file.
int writeFrame(void): Fill the requested TSeries.
int buildFrame(const Time& Start=0, const Interval& dT=0.0): Create a data frame from the data.
void addProcSeries(const char* Name, const TSeries& TS): Add a pre-processed data structure to the frame.
void addRawSeries(const char* Name, const TSeries& TS): Add an ADC data structure.
void addSeries(const char* Name, const TSeries& TS): Add an ADC data structure.
int getDebug(void) const: Get the debug flag.
const char* getFile(void) const: Get the input file name.
const FrameCPP::Frame* getFrame(void) const: Get a pointer to the current frame header.
string getFrameID(void) const: Copy a Frame ID into the specified string.
Time getTime(void) const: Get the Start time.
ostream& list(ostream& out) const: List requested channels.
void copyDetectors(const FrameCPP::Frame& f): Copy detector information.
void copyHistory(const FrameCPP::Frame& f): Copy history information.
void copyAuxData(const FrameCPP::Frame& f): Copy auxillary data.
void addRawAdc(const FrameCPP::Frame& f, const char* Name): Copy adc data.
void addRawAdc(const FrameCPP::AdcData& adc): Copy adc data.

Documentation

FrWriter methods are used to create frames from TSeries objects and other data. THe FrWriter API is used as follows. A frame writer is created and then opened with the open() method. Any TSeries that are to be written to all output frames are introoduced to the frame writer with the addChannel() function. For each frame to be written user must build the frame with buildFrame(), add any additional TSeries data with addSeries() or other data using the FrameCPP API and the frame pointer from getFrame() and write it out with writeFrame(). After all frames have been written, the frame writer is closed with close() and/or deleted.

FrWriter(void)

Default (Null) constructor

FrWriter(const char* Name, int Run)

Construct and connect to destination file. Any frame name may be used. The run number should follow the frame standard run number convention.

Parameters:: Name - Frame name.
Current - run number.

~FrWriter(void)

Destructor

void setDebug(int debug=0)

If the debug flag is set, explanatory messages will be printed when an error is encountered.

void addChannel(const char* Name, TSeries** TSptr=0)

The specified channel is added to the list of channels to be processed by buildFrame. A channel may be included in the list only once. Subsequent calls to addChannel will replace the original request. TSptr specifies the location of a pointer to the data. Note that the data are not copied until buildFrame is called. Core must be taken that the specified pointer (TSptr) must therefore still exists and points to valid data at the time buildFrame is called. The data are written with the same type as the TSeries.