Class Index | Cross Index | Namespace Index |
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. |
This creates an StatData object with the following properties:
- name = "none"
- comment = ""
- representation = ""
- timeStart = 0
- timeEnd = 0
- version = 0
- detector = none (null pointer)
- No other data.
Exceptions:
Exception | Description |
None. |
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:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
This method currently does nothing.
Exceptions:
Exception | Description |
None. |
Exceptions:
Exception | Description |
None. |
Return value:
const std::string&
Exceptions:
Exception | Description |
None. | |
None. |
Return value:
Detector*
Exceptions:
Exception | Description |
None. | |
None. |
Return value:
const Detector*
Exceptions:
Exception | Description |
None. | |
None. |
Return value:
const std::string&
Exceptions:
Exception | Description |
None. | |
None. |
Return value:
SH- Static Data structure header.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
Constructs the Structure Header for this class.
Return value:
SH- Static Data structure header.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed |
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:
Exception | Description |
None. | |
None. |
This is GPS time in integer seconds since GPS standard epoch.
Return value:
INT_4U
Exceptions:
Exception | Description |
None. | |
None. |
Return value:
INT_4U
Exceptions:
Exception | Description |
None. | |
None. |
Parameters:
Parameter | Description |
const StatData& statData | The object to compare with. |
Return value:
bool- True if the objects are not equal.
Exceptions:
Exception | Description |
None. | |
None. |
Parameters:
Parameter | Description |
const StatData& statData | Object to be added. |
Return value:
const StatData&- This object.
Parameters:
Parameter | Description |
const StatData& statData | Object to be assigned. |
Return value:
const StatData&- This object.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
Determines whether two StatData objects are equal. For this comparison, all of the data is compared.
Parameters:
Parameter | Description |
const StatData& statData | 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:
StatData*- 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. |
Return value:
DataContainer&
Exceptions:
Exception | Description |
None. | |
None. |
Return value:
const DataContainer&
Exceptions:
Exception | Description |
None. | |
None. |
Return value:
TableContainer&
Exceptions:
Exception | Description |
None. | |
None. |
Return value:
const TableContainer&
Exceptions:
Exception | Description |
None. | |
None. |
Parameters:
Parameter | Description |
Detector* detector |
Exceptions:
Exception | Description |
None. | |
None. |
Parameters:
Parameter | Description |
Output& out out | Output data stream object. |
Exceptions:
Exception | Description |
write_failure | Write failure occured. |