Class Index | Cross Index | Namespace Index |
This class represents post-processed 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/procdata.hh"
public function member index: |
|||
ProcData | (); | Default Constructor. | |
ProcData | (const ProcData& procData); | Copy Constructor. | |
ProcData | (const std::string& name, const REAL_8& sampleRate, const Time& timeOffset, const REAL_8& fShift, const REAL_4& phase); | Constructor. | |
virtual | ~ProcData | (); | |
inline void | appendComment | (const std::string& comment); | Appends a comment. |
virtual INT_2U | getClassId | () const; | |
inline const std::string& | getComment | () const; | Get the comment. |
inline REAL_8 | getFShift | () const; | Get the frequency shift if the signal has been heterodyned before the ADC. |
const std::string& | getName | () const; | |
inline REAL_4 | getPhase | () const; | Get phase of heterodyning signal at start of dataset. |
static SH | getSH | (); | Constructs the Structure Header for this class. |
static SH | getSH3 | (); | Constructs fram data vesion 3 Structure Header for this class. |
static SH | getSH4 | (); | Constructs frame data vesion 4 Structure Header for this class. |
inline REAL_8 | getSampleRate | () const; | Get the data acquisition rate, samples / sec. |
inline const Time& | getTimeOffset | () const; | Get the time relative to the frame start. |
inline bool | operator != | (const ProcData& procData) const; | Not-equal comparison. |
const ProcData& | operator += | (const ProcData& procData); | += Operator. |
const ProcData& | operator = | (const ProcData& procData); | Assignment Operator. |
bool | operator == | (const ProcData& procData) const; | Equal comparison. |
inline AuxContainer& | refAux | (); | Get the container for user provided information. |
inline const AuxContainer& | refAux | () const; | Get the container for user provided information. |
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 for user provided table data. |
inline const TableContainer& | refTable | () const; | Get the container for user provided table data. |
void | setTimeOffset | (const INT_4S sec = 0, const INT_4U nan = 0); | |
private function member index: |
|||
static ProcData* | read | (FrameReaderBase& in); | Reads an ProcData object from an FrameReaderBase object. |
static ProcData* | read3 | (FrameReaderBase& in); | Version 3 frame input method. |
static ProcData* | read4 | (FrameReaderBase& in); | Version 4 frame input method. |
virtual void | write | (Output& out) const; | Writes an ProcData object to an Output object. |
This creates a ProcData object with the following properties:
- name = "none"
- comment = ""
- sampleRate = 0.0
- timeOffset = 0 seconds, 0 nanoseconds
- fShift = 0.0
- phase = 0.0
- No other data.
Exceptions:
Exception | Description |
None. |
This performs a deep copy of the object.
Parameters:
Parameter | Description |
const ProcData& procData | Object to be copied. |
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
Parameters:
Parameter | Description |
const std::string& name | Data or channel name. |
const REAL_8& sampleRate | Data acquisition rate, samples / s. |
const Time& timeOffset | Integer seconds time relative to frame start. |
const REAL_8& fShift | Frequency shift. |
const REAL_4& phase | Phase. |
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
Exceptions:
Exception | Description |
None. |
This method adds a comment followed by a newline to the end of the current list of comments.
Parameters:
Parameter | Description |
const std::string& comment | Comment. |
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
std::bad_alloc | Memory allocation failed. |
Exceptions:
Exception | Description |
None. |
Return value:
const std::string&- Comment.
Exceptions:
Exception | Description |
None. | |
None. |
fShift = (f_heterodyne - fNyquist@sampleRate).
Return value:
REAL_8- Frequency shift.
Exceptions:
Exception | Description |
None. | |
None. |
Return value:
REAL_4- phase.
Exceptions:
Exception | Description |
None. | |
None. |
Return value:
SH- Proc 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:
REAL_8- Sampling rate.
Exceptions:
Exception | Description |
None. | |
None. |
This is for triggered data lasting less than one frame, it is the integer seconds and nanoseconds.
Return value:
const Time&- Relative time.
Exceptions:
Exception | Description |
None. | |
None. |
Parameters:
Parameter | Description |
const ProcData& procData | The object to compare with. |
Return value:
bool- True if the objects are not equal.
Exceptions:
Exception | Description |
None. |
Parameters:
Parameter | Description |
const ProcData& procData | Object to be added. |
Return value:
const ProcData&- This object.
Parameters:
Parameter | Description |
const ProcData& procData | Object to be assigned. |
Return value:
const ProcData&- This object.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
Determines whether two ProcData objects are equal. For this comparison, all of the data is compared.
Parameters:
Parameter | Description |
const ProcData& procData | 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:
ProcData*- Newly allocated.
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:
AuxContainer&- Generic data.
Exceptions:
Exception | Description |
None. | |
None. |
Return value:
const AuxContainer&- Generic data.
Exceptions:
Exception | Description |
None. | |
None. |
Return value:
DataContainer&- Data.
Exceptions:
Exception | Description |
None. | |
None. |
Return value:
const DataContainer&- Data.
Exceptions:
Exception | Description |
None. | |
None. |
Return value:
SearchContainer< Table, &Table::getName >&- Table.
Exceptions:
Exception | Description |
None. | |
None. |
Return value:
const SearchContainer< Table, &Table::getName >&- Table.
Exceptions:
Exception | Description |
None. | |
None. |
Parameters:
Parameter | Description |
Output& out out | Output data stream object. |
Exceptions:
Exception | Description |
write_failure | Write failure occured. |