Class Index | Cross Index | Namespace Index |
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. |
This creates a History object with the following properties:
- name = "none"
- time = 0
- comment = ""
Exceptions:
Exception | Description |
None. |
This performs a deep copy of the object.
Parameters:
Parameter | Description |
const History& history | Object to be copied. |
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
Parameters:
Parameter | Description |
const std::string& name | Name of history record. |
INT_4U time | Time of post-processing. |
const std::string& comment | Program name and relevant comment needed to define post-processing. |
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
Exceptions:
Exception | Description |
None. |
Exceptions:
Exception | Description |
None. |
Return value:
const std::string&- Comments.
Exceptions:
Exception | Description |
None. | |
None. |
Return value:
SH- History Structure header.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
This is the GPS time in integer seconds since the GPS standard epoch.
Return value:
INT_4U- Time
Exceptions:
Exception | Description |
None. | |
None. |
Parameters:
Parameter | Description |
const History& history | The object to compare with. |
Return value:
bool- True if the objects are not equal.
Exceptions:
Exception | Description |
None. |
Parameters:
Parameter | Description |
const History& history | Object to be added. |
Return value:
const History&- This object.
Parameters:
Parameter | Description |
const History& history | Object to be assigned. |
Return value:
const History&- This object.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
Determines whether two History objects are equal. For this comparison, all of the data is compared.
Parameters:
Parameter | Description |
const History& history | The object to compare with. |
Return value:
bool- true if the objects are equal.
Exceptions:
Exception | Description |
None. |
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:
Parameter | Description |
FrameReaderBase& in | Input data stream object. |
Return value:
History*- Newly created.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
read_failure | Read failure occured. |
Parameters:
Parameter | Description |
Output& out out | Output data stream object. |
Exceptions:
Exception | Description |
write_failure | write failure occured. |