Class Index Cross Index Namespace Index

Class FrameCPP::Version_3_4_5::TOC

This class represents frame file table of contents .
Contained in: FrameCPP::Version_3_4_5
Derived from: FrameCPP::Version_3_4_5::Base
Derived by: FrameCPP::Version_3_4_5::FrameWriterTOC FrameCPP::Version_3_4_5::TOCReader

#include "../../../../../lib/framecpp/src/Version3_4_5/toc.hh"


public function member index:

TOC(); Default Constructor.
TOC(const TOC& eof); Copy Constructor.
virtual ~TOC();
virtual INT_2U getClassId() const;
inline const std::vector<REAL_8>& getDt() const; Get frame durations
inline const std::vector<INT_8U>& getFirstADCPosition() const; Get first ADC positions
inline const std::vector<INT_8U>& getFirstMsgPosition() const; Get first message structure positions
inline const std::vector<INT_8U>& getFirstSerPosition() const; Get first serial data structure positions
inline const std::vector<INT_8U>& getFirstTablePosition() const; Get first raw data referenced table positions
inline const std::vector<INT_4U>& getFrame() const; Get frame numbers
inline unsigned long getFrameNumber() const; Get the total number of frames in file
inline const std::vector<Time>& getGTime() const; Get frame time stamps
inline const std::vector<INT_8U>& getPositionH() const; Get frame header positions
inline const std::vector<INT_4S>& getRuns(unsigned long idx) const; Get run numbers
static SH getSH(); Constructs the Structure Header for this class.
static SH getSH4(); Constructs frame data version 4 Structure Header for this class
inline INT_2S getULeapS() const; Get leap seconds from the first frame in file
const TOC& operator =(const TOC& eof); Assignment Operator.
 

protected function member index:

static TOC* read(Input& in); Skips TOC structure in an Input object.
static TOC* read4(Input& in); Skips TOC structure in an Input object.
TOC* reallyRead(Input& in); Reads an TOC object from an Input object.
virtual void write(Output& out) const; Writes an TOC object to an Output object.
 

Description:



Function Member Descriptions:


FrameCPP::Version_3_4_5::TOC::TOC - Default Constructor.


TOC();

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::TOC::TOC - Copy Constructor.


TOC(const TOC& eof);
This performs a deep copy of the object.

Parameters:
ParameterDescription
const TOC& tocObject to be copied.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::TOC::~TOC


virtual ~TOC();



FrameCPP::Version_3_4_5::TOC::getClassId


virtual INT_2U getClassId() const;

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::TOC::getDt - Get frame durations


inline const std::vector<REAL_8>& getDt() const;



FrameCPP::Version_3_4_5::TOC::getFirstADCPosition - Get first ADC positions


inline const std::vector<INT_8U>& getFirstADCPosition() const;



FrameCPP::Version_3_4_5::TOC::getFirstMsgPosition - Get first message structure positions


inline const std::vector<INT_8U>& getFirstMsgPosition() const;



FrameCPP::Version_3_4_5::TOC::getFirstSerPosition - Get first serial data structure positions


inline const std::vector<INT_8U>& getFirstSerPosition() const;



FrameCPP::Version_3_4_5::TOC::getFirstTablePosition - Get first raw data referenced table positions


inline const std::vector<INT_8U>& getFirstTablePosition() const;



FrameCPP::Version_3_4_5::TOC::getFrame - Get frame numbers


inline const std::vector<INT_4U>& getFrame() const;



FrameCPP::Version_3_4_5::TOC::getFrameNumber - Get the total number of frames in file


inline unsigned long getFrameNumber() const;



FrameCPP::Version_3_4_5::TOC::getGTime - Get frame time stamps


inline const std::vector<Time>& getGTime() const;



FrameCPP::Version_3_4_5::TOC::getPositionH - Get frame header positions


inline const std::vector<INT_8U>& getPositionH() const;



FrameCPP::Version_3_4_5::TOC::getRuns - Get run numbers


inline const std::vector<INT_4S>& getRuns(unsigned long idx) const;



FrameCPP::Version_3_4_5::TOC::getSH - Constructs the Structure Header for this class.


static SH getSH();

Return value:
SH- TOC structure header.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::TOC::getSH4 - Constructs frame data version 4 Structure Header for this class


static SH getSH4();

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::TOC::getULeapS - Get leap seconds from the first frame in file


inline INT_2S getULeapS() const;



FrameCPP::Version_3_4_5::TOC::operator = - Assignment Operator.


const TOC& operator =(const TOC& eof);

Parameters:
ParameterDescription
const TOC& tocObject to be assigned.

Return value:
const TOC&- This TOC object.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::TOC::read - Skips TOC structure in an Input object.


static TOC* read(Input& in);
This method skips over the TOC. It is not read here.

Parameters:
ParameterDescription
Input& inInput data stream object.

Return value:
TOC*- Always return zero.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.
read_failureFailed to skip over the TOC.



FrameCPP::Version_3_4_5::TOC::read4 - Skips TOC structure in an Input object.


static TOC* read4(Input& in);

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.
read_failureFailed to skip over the TOC.



FrameCPP::Version_3_4_5::TOC::reallyRead - Reads an TOC object from an Input object.


TOC* reallyRead(Input& in);
This method is used to read the table of contents.

Parameters:
ParameterDescription
Input& inInput stream object.

Return value:
0absent or corrupt TOC; this -- everything was fine.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.
read_failureRead failed.



FrameCPP::Version_3_4_5::TOC::write - Writes an TOC object to an Output object.


virtual void write(Output& out) const;

Parameters:
ParameterDescription
Output& out outOutpu stream object.

Exceptions:
ExceptionDescription
write_failureWrite failed.



Variable Member Descriptions:


FrameCPP::Version_3_4_5::TOC::GTime - frame times

std::vector<Time> GTime;

FrameCPP::Version_3_4_5::TOC::SHid - structure IDs

std::vector<INT_2U> SHid;

FrameCPP::Version_3_4_5::TOC::SHname - structure names

std::vector<std::string> SHname;

FrameCPP::Version_3_4_5::TOC::ULeapS - from the first FrameH in the file

INT_2S ULeapS;

FrameCPP::Version_3_4_5::TOC::adcNamePositionMap -

adcNamePositionMap_type adcNamePositionMap;

FrameCPP::Version_3_4_5::TOC::dataQuality - from the first FrameH in the file

std::vector<INT_4U> dataQuality;

FrameCPP::Version_3_4_5::TOC::detectorNamePositionMap - Detector

std::map< std::string, INT_8U > detectorNamePositionMap;
Maps Detector name into its position


FrameCPP::Version_3_4_5::TOC::dt - frame durations

std::vector<REAL_8> dt;

FrameCPP::Version_3_4_5::TOC::eventNamePositionMap -

std::map< std::string, std::vector< TOC::eventAttr > > eventNamePositionMap;

FrameCPP::Version_3_4_5::TOC::frame - frame numbers

std::vector<INT_4U> frame;

FrameCPP::Version_3_4_5::TOC::position - offset in a file to frame header structure's first byte

std::vector<INT_8U> position;

FrameCPP::Version_3_4_5::TOC::positionADC - for the first ADC structure in each frame

std::vector<INT_8U> positionADC;

FrameCPP::Version_3_4_5::TOC::positionMsg - for the first message in each frame

std::vector<INT_8U> positionMsg;

FrameCPP::Version_3_4_5::TOC::positionSer - for the first serial data structure in each frame

std::vector<INT_8U> positionSer;

FrameCPP::Version_3_4_5::TOC::positionTable - for the first refernced from RawData table in each frame

std::vector<INT_8U> positionTable;

FrameCPP::Version_3_4_5::TOC::procNamePositionMap - Post-processed data

std::map< std::string, std::vector<INT_8U> > procNamePositionMap;
Maps proc name onto the std::vector of positions. One position per name per frame.


FrameCPP::Version_3_4_5::TOC::runs - frame run numbers

std::vector<INT_4S> runs;

FrameCPP::Version_3_4_5::TOC::serNamePositionMap - Serial data

std::map< std::string, std::vector<INT_8U> > serNamePositionMap;
Maps Serial name onto the std::vector of positions. One position per name per frame.


FrameCPP::Version_3_4_5::TOC::simEventNamePositionMap - Simulated Event Data

std::map< std::string, std::vector< TOC::eventAttr > > simEventNamePositionMap;

FrameCPP::Version_3_4_5::TOC::simNamePositionMap - Simulated data

std::map< std::string, std::vector<INT_8U> > simNamePositionMap;
Maps simulated data name on the std::vector of positions One position per name per frame


FrameCPP::Version_3_4_5::TOC::statNamePositionMap -

statNamePositionMap_type statNamePositionMap;

FrameCPP::Version_3_4_5::TOC::sumNamePositionMap - Summary data

std::map< std::string, std::vector<INT_8U> > sumNamePositionMap;
Maps Serial name onto the std::vector of positions. One position per name per frame.