Class Index | Cross Index | Namespace Index |
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. |
This creates a Summary object with the following properties:
- none = "none"
- comment = ""
- test = ""
- gtimes = 0 seconds and 0 nanoseconds
- No other data.
Exceptions:
Exception | Description |
None. |
Parameters:
Parameter | Description |
const Summary& summary | Summary data object to be copied. |
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
Constructor
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
Exceptions:
Exception | Description |
None. |
Exceptions:
Exception | Description |
None. |
Return value:
const std::string&- Summary data comment.
Exceptions:
Exception | Description |
None. | |
None. |
Return value:
const Time&- GPS time.
Exceptions:
Exception | Description |
None. | |
None. |
Return value:
SH- Summary data structure header.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed |
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed |
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed |
Return value:
const std::string&- Tests.
Exceptions:
Exception | Description |
None. | |
None. |
Parameters:
Parameter | Description |
const Summary& summary | The object to compare with. |
Return value:
bool- True if the objects are not equal.
Exceptions:
Exception | Description |
None. | |
None. |
Parameters:
Parameter | Description |
const Summary& summary | The object to be added. |
Return value:
const Summary&This object.
Parameters:
Parameter | Description |
const Summary& summary |
Return value:
const Summary&
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
Determines whether two Summary objects are equal. For this comparison, all of the data is compared.
Parameters:
Parameter | Description |
const Summary& summary | 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:
Summary*- Newly created.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
read_failure | Read failure occured. |
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
read_failure | Read failure occured. |
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
read_failure | Read failure occured. |
Return value:
MomentsContainer&- Moments.
Exceptions:
Exception | Description |
None. | |
None. |
Return value:
const MomentsContainer&- Moments.
Exceptions:
Exception | Description |
None. | |
None. |
Return value:
TableContainer< Table >&- Table.
Exceptions:
Exception | Description |
None. | |
None. |
Return value:
const TableContainer&- Table.
Exceptions:
Exception | Description |
None. | |
None. |
Parameters:
Parameter | Description |
Output& out out | Data output object. |
Exceptions:
Exception | Description |
write_failure | Write failure occured. |