Class Index Cross Index Namespace Index

Class FrameCPP::Version_3_4_5::History

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


public function member index:

History(); Default Constructor.
History(const History& history); Copy Constructor.
History(const std::string& name, INT_4U time, const std::string& comment); Constructor.
virtual ~History();
virtual INT_2U getClassId() const;
inline const std::string& getComment() const; Get the program name and relevant comments needed to define post-processing.
const std::string& getName() const;
static SH getSH3(); Constructs the Structure Header for this class.
inline INT_4U getTime() const; Gets the time of post-processing.
inline bool operator !=(const History& history) const; Not-equal comparison.
const History& operator +=(const History& history); += Operator.
const History& operator =(const History& history); Assignment Operator.
bool operator ==(const History& history) const; Equal comparison.
 

private function member index:

static History* read3(FrameReaderBase& in); Reads a History object from an FrameReaderBase object.
virtual void write(Output& out) const; Writes a History object to an Output object.
 

Description:

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


Function Member Descriptions:


FrameCPP::Version_3_4_5::History::History - Default Constructor.


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

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::History::History - Copy Constructor.


History(const History& history);
This performs a deep copy of the object.

Parameters:
ParameterDescription
const History& historyObject to be copied.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::History::History - Constructor.


History(const std::string& name, INT_4U time, const std::string& comment);

Parameters:
ParameterDescription
const std::string& nameName of history record.
INT_4U timeTime of post-processing.
const std::string& commentProgram name and relevant comment needed to define post-processing.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::History::~History


virtual ~History();

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::History::getClassId


virtual INT_2U getClassId() const;

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::History::getComment - Get the program name and relevant comments needed to define post-processing.


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

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

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::History::getName


const std::string& getName() const;



FrameCPP::Version_3_4_5::History::getSH3 - Constructs the Structure Header for this class.


static SH getSH3();

Return value:
SH- History Structure header.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::History::getTime - Gets the time of post-processing.


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

Return value:
INT_4U- Time

Exceptions:
ExceptionDescription
None.
None.



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


inline bool operator !=(const History& history) const;

Parameters:
ParameterDescription
const History& historyThe object to compare with.

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

Exceptions:
ExceptionDescription
None.



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


const History& operator +=(const History& history);

Parameters:
ParameterDescription
const History& historyObject to be added.

Return value:
const History&- This object.


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


const History& operator =(const History& history);

Parameters:
ParameterDescription
const History& historyObject to be assigned.

Return value:
const History&- This object.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



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


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

Parameters:
ParameterDescription
const History& historyThe object to compare with.

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

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::History::read3 - Reads a History object from an FrameReaderBase object.


static History* read3(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:
History*- Newly created.

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



FrameCPP::Version_3_4_5::History::write - Writes a History 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::History::mComment - oProgram name and relevant comment needed to define post-processing.

std::string mComment;

FrameCPP::Version_3_4_5::History::mName - Name of history record.

std::string mName;

FrameCPP::Version_3_4_5::History::mTime - Time of post-processing.

INT_4U mTime;