Class Index Cross Index Namespace Index

Class FrameCPP::Version_3_4_5::StatData

This class represents static data.
Contained in: FrameCPP::Version_3_4_5
Derived from: FrameCPP::Version_3_4_5::Base
Derived by: none

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


public function member index:

StatData(); Default Constructor.
StatData(const StatData& statData); Copy Constructor.
StatData(const std::string& name, const std::string& comment, const std::string& representation, INT_4U timeStart, INT_4U timeEnd, INT_4U version); Constructor
~StatData(); Destructor.
virtual INT_2U getClassId() const;
inline const std::string& getComment() const; Gets the comment.
inline Detector* getDetector(); Gets the detector to shich this static data applies.
inline const Detector* getDetector() const; Gets the detector to shich this static data applies.
const std::string& getName() const;
inline const std::string& getRepresentation() const; Gets the representation.
static SH getSH(); Constructs the Structure Header for this class.
static SH getSH3(); Get frame data format version 3 Structure Header
inline INT_4U getTimeEnd() const; Gets the end time of static data validity.
inline INT_4U getTimeStart() const; Gets the start time of static data validity.
inline INT_4U getVersion() const; Gets the version number for this static data.
inline bool operator !=(const StatData& statData) const; Not-equal comparison.
const StatData& operator +=(const StatData& statData); += Operator.
const StatData& operator =(const StatData& statData); Assignment Operator.
bool operator ==(const StatData& statData) const; Equal comparison.
inline DataContainer& refData(); Get the container which contains the data.
inline const DataContainer& refData() const; Get the container which contains the data.
inline TableContainer& refTable(); Get the container holding the user-define table data.
inline const TableContainer& refTable() const; Get the container holding the user-define table data.
inline void setDetector(Detector* detector); Sets the Detector object to which this static data applies.
 

private function member index:

static StatData* read(FrameReaderBase& in); Reads a StatData object from an FrameReaderBase object.
static StatData* read3(FrameReaderBase& in); Read framecpp version 3 static data object.
virtual void write(Output& out) const; Writes an StatData object to an Output object.
 

Description:

It is modeled after the FrStatData structure in the Frame Specification, LIGO-T970130-B-E.


Function Member Descriptions:


FrameCPP::Version_3_4_5::StatData::StatData - Default Constructor.


StatData();
This creates an StatData object with the following properties:

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::StatData::StatData - Copy Constructor.


StatData(const StatData& statData);
This performs a deep copy of the object. However, since the StatData object does not own the Detector, a deep copy is NOT performed on this object.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::StatData::StatData - Constructor


StatData(const std::string& name, const std::string& comment, const std::string& representation, INT_4U timeStart, INT_4U timeEnd, INT_4U version);

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::StatData::~StatData - Destructor.


~StatData();
This method currently does nothing.

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::StatData::getClassId


virtual INT_2U getClassId() const;

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::StatData::getComment - Gets the comment.


inline const std::string& getComment() const;

Return value:
const std::string&

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::StatData::getDetector - Gets the detector to shich this static data applies.


inline Detector* getDetector();

Return value:
Detector*

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::StatData::getDetector - Gets the detector to shich this static data applies.


inline const Detector* getDetector() const;

Return value:
const Detector*

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::StatData::getName


const std::string& getName() const;



FrameCPP::Version_3_4_5::StatData::getRepresentation - Gets the representation.


inline const std::string& getRepresentation() const;

Return value:
const std::string&

Exceptions:
ExceptionDescription
None.
None.



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


static SH getSH();

Return value:
SH- Static Data structure header.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::StatData::getSH3 - Get frame data format version 3 Structure Header


static SH getSH3();
Constructs the Structure Header for this class.

Return value:
SH- Static Data structure header.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed



FrameCPP::Version_3_4_5::StatData::getTimeEnd - Gets the end time of static data validity.


inline INT_4U getTimeEnd() const;
This is the GPS time in integer seconds since the GPS standard epoch. If this is unknown it is set to zero.

Return value:
INT_4U

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::StatData::getTimeStart - Gets the start time of static data validity.


inline INT_4U getTimeStart() const;
This is GPS time in integer seconds since GPS standard epoch.

Return value:
INT_4U

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::StatData::getVersion - Gets the version number for this static data.


inline INT_4U getVersion() const;

Return value:
INT_4U

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::StatData::operator != - Not-equal comparison.


inline bool operator !=(const StatData& statData) const;

Parameters:
ParameterDescription
const StatData& statDataThe object to compare with.

Return value:
bool- True if the objects are not equal.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::StatData::operator += - += Operator.


const StatData& operator +=(const StatData& statData);

Parameters:
ParameterDescription
const StatData& statDataObject to be added.

Return value:
const StatData&- This object.


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


const StatData& operator =(const StatData& statData);

Parameters:
ParameterDescription
const StatData& statDataObject to be assigned.

Return value:
const StatData&- This object.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::StatData::operator == - Equal comparison.


bool operator ==(const StatData& statData) const;
Determines whether two StatData objects are equal. For this comparison, all of the data is compared.

Parameters:
ParameterDescription
const StatData& statDataThe object to compare with.

Return value:
bool- true if the objects are equal.

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::StatData::read - Reads a StatData object from an FrameReaderBase object.


static StatData* read(FrameReaderBase& in);
This method creates a dynamically allocated object.

*NOTE* This method allocates memory and returns a pointer to it. The user is responsible for freeing this memory.


Parameters:
ParameterDescription
FrameReaderBase& inInput data stream object.

Return value:
StatData*- Newly created.

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



FrameCPP::Version_3_4_5::StatData::read3 - Read framecpp version 3 static data object.


static StatData* read3(FrameReaderBase& in);

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



FrameCPP::Version_3_4_5::StatData::refData - Get the container which contains the data.


inline DataContainer& refData();

Return value:
DataContainer&

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::StatData::refData - Get the container which contains the data.


inline const DataContainer& refData() const;

Return value:
const DataContainer&

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::StatData::refTable - Get the container holding the user-define table data.


inline TableContainer& refTable();

Return value:
TableContainer&

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::StatData::refTable - Get the container holding the user-define table data.


inline const TableContainer& refTable() const;

Return value:
const TableContainer&

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::StatData::setDetector - Sets the Detector object to which this static data applies.


inline void setDetector(Detector* detector);

Parameters:
ParameterDescription
Detector* detector

Exceptions:
ExceptionDescription
None.
None.



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


virtual void write(Output& out) const;

Parameters:
ParameterDescription
Output& out outOutput data stream object.

Exceptions:
ExceptionDescription
write_failureWrite failure occured.



Variable Member Descriptions:


FrameCPP::Version_3_4_5::StatData::mComment - Comment.

std::string mComment;

FrameCPP::Version_3_4_5::StatData::mData - Data.

DataContainer mData;

FrameCPP::Version_3_4_5::StatData::mDetector - Detector with which this static data is associated.

Detector* mDetector;

FrameCPP::Version_3_4_5::StatData::mName - Static data name.

std::string mName;

FrameCPP::Version_3_4_5::StatData::mRepresentation - Type of static data beeing represented.

std::string mRepresentation;

FrameCPP::Version_3_4_5::StatData::mTable - Table.

TableContainer mTable;

FrameCPP::Version_3_4_5::StatData::mTimeEnd - End time of static data validity.

INT_4U mTimeEnd;

FrameCPP::Version_3_4_5::StatData::mTimeStart - Start time of static data validity.

INT_4U mTimeStart;

FrameCPP::Version_3_4_5::StatData::mVersion - Version numner for this static structure.

INT_4U mVersion;