Class Index Cross Index Namespace Index

Class FrameCPP::Version_3_4_5::Summary

This class represents summary 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/summary.hh"


public function member index:

Summary(); Default Constructor.
Summary(const Summary& summary); Copy Constructor.
Summary(const std::string& name, const std::string& comment, const std::string& test, const Time& gtime);
virtual ~Summary();
virtual INT_2U getClassId() const;
inline const std::string& getComment() const; Gets the comment.
inline const Time& getGTime() const; Get message GPS time.
const std::string& getName() const;
static SH getSH(); Constructs the Structure Header for this class.
static SH getSH3(); Get frame data format version 3 Structure Header
static SH getSH4(); Get frame data format version 4 Structure Header
inline const std::string& getTest() const; Gets the statistical test(s) used on raw data.
inline bool operator !=(const Summary& summary) const; Not-equal comparison.
const Summary& operator +=(const Summary& summary); Assignment operator.
const Summary& operator =(const Summary& summary); Assignment Operator.
bool operator ==(const Summary& summary) const; Equal comparison.
inline MomentsContainer& refMoments(); Gets the container holding the statistical descriptors.
inline const MomentsContainer& refMoments() const; Gets the container holding the statistical descriptors.
inline TableContainer& refTable(); Gets the container holding table data.
inline const TableContainer& refTable() const; Gets the container holding table data.
 

private function member index:

static Summary* read(FrameReaderBase& in); Reads a Summary object from an FrameReaderBase object.
static Summary* read3(FrameReaderBase& in); Frame version 3 read method.
static Summary* read4(FrameReaderBase& in); Frame version 4 read method.
virtual void write(Output& out) const; Writes a Summary object to an Output object.
 

Description:

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


Function Member Descriptions:


FrameCPP::Version_3_4_5::Summary::Summary - Default Constructor.


Summary();
This creates a Summary object with the following properties:

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::Summary::Summary - Copy Constructor.


Summary(const Summary& summary);

Parameters:
ParameterDescription
const Summary& summarySummary data object to be copied.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::Summary::Summary


Summary(const std::string& name, const std::string& comment, const std::string& test, const Time& gtime);
Constructor

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::Summary::~Summary


virtual ~Summary();

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::Summary::getClassId


virtual INT_2U getClassId() const;

Exceptions:
ExceptionDescription
None.



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


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

Return value:
const std::string&- Summary data comment.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Summary::getGTime - Get message GPS time.


inline const Time& getGTime() const;

Return value:
const Time&- GPS time.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Summary::getName


const std::string& getName() const;



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


static SH getSH();

Return value:
SH- Summary data structure header.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed



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


static SH getSH3();

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed



FrameCPP::Version_3_4_5::Summary::getSH4 - Get frame data format version 4 Structure Header


static SH getSH4();

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed



FrameCPP::Version_3_4_5::Summary::getTest - Gets the statistical test(s) used on raw data.


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

Return value:
const std::string&- Tests.

Exceptions:
ExceptionDescription
None.
None.



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


inline bool operator !=(const Summary& summary) const;

Parameters:
ParameterDescription
const Summary& summaryThe object to compare with.

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

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Summary::operator += - Assignment operator.


const Summary& operator +=(const Summary& summary);

Parameters:
ParameterDescription
const Summary& summaryThe object to be added.

Return value:
const Summary&This object.


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


const Summary& operator =(const Summary& summary);

Parameters:
ParameterDescription
const Summary& summary

Return value:
const Summary&

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



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


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

Parameters:
ParameterDescription
const Summary& summaryThe object to compare with.

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

Exceptions:
ExceptionDescription
None.



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


static Summary* 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:
Summary*- Newly created.

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



FrameCPP::Version_3_4_5::Summary::read3 - Frame version 3 read method.


static Summary* read3(FrameReaderBase& in);

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



FrameCPP::Version_3_4_5::Summary::read4 - Frame version 4 read method.


static Summary* read4(FrameReaderBase& in);

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



FrameCPP::Version_3_4_5::Summary::refMoments - Gets the container holding the statistical descriptors.


inline MomentsContainer& refMoments();

Return value:
MomentsContainer&- Moments.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Summary::refMoments - Gets the container holding the statistical descriptors.


inline const MomentsContainer& refMoments() const;

Return value:
const MomentsContainer&- Moments.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Summary::refTable - Gets the container holding table data.


inline TableContainer& refTable();

Return value:
TableContainer< Table >&- Table.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Summary::refTable - Gets the container holding table data.


inline const TableContainer& refTable() const;

Return value:
const TableContainer&- Table.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Summary::write - Writes a Summary object to an Output object.


virtual void write(Output& out) const;

Parameters:
ParameterDescription
Output& out outData output object.

Exceptions:
ExceptionDescription
write_failureWrite failure occured.



Variable Member Descriptions:


FrameCPP::Version_3_4_5::Summary::mComment - Comment.

std::string mComment;

FrameCPP::Version_3_4_5::Summary::mGTime - GPS time

Time mGTime;

FrameCPP::Version_3_4_5::Summary::mMoments - Statistical descriptors.

MomentsContainer mMoments;

FrameCPP::Version_3_4_5::Summary::mName - Name of summary statistics.

std::string mName;

FrameCPP::Version_3_4_5::Summary::mTable - Additional summary information.

TableContainer mTable;

FrameCPP::Version_3_4_5::Summary::mTest - Statistical test(s) used on raw data.

std::string mTest;