Class Index Cross Index Namespace Index

Class FrameCPP::Version_3_4_5::ProcData

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.
 

Description:

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


Function Member Descriptions:


FrameCPP::Version_3_4_5::ProcData::ProcData - Default Constructor.


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

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::ProcData::ProcData - Copy Constructor.


ProcData(const ProcData& procData);
This performs a deep copy of the object.

Parameters:
ParameterDescription
const ProcData& procDataObject to be copied.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::ProcData::ProcData - Constructor.


ProcData(const std::string& name, const REAL_8& sampleRate, const Time& timeOffset, const REAL_8& fShift, const REAL_4& phase);

Parameters:
ParameterDescription
const std::string& nameData or channel name.
const REAL_8& sampleRateData acquisition rate, samples / s.
const Time& timeOffsetInteger seconds time relative to frame start.
const REAL_8& fShiftFrequency shift.
const REAL_4& phasePhase.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::ProcData::~ProcData


virtual ~ProcData();

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::ProcData::appendComment - Appends a comment.


inline void appendComment(const std::string& comment);
This method adds a comment followed by a newline to the end of the current list of comments.

Parameters:
ParameterDescription
const std::string& commentComment.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::ProcData::getClassId


virtual INT_2U getClassId() const;

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::ProcData::getComment - Get the comment.


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

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

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::ProcData::getFShift - Get the frequency shift if the signal has been heterodyned before the ADC.


inline REAL_8 getFShift() const;
fShift = (f_heterodyne - fNyquist@sampleRate).

Return value:
REAL_8- Frequency shift.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::ProcData::getName


const std::string& getName() const;



FrameCPP::Version_3_4_5::ProcData::getPhase - Get phase of heterodyning signal at start of dataset.


inline REAL_4 getPhase() const;

Return value:
REAL_4- phase.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::ProcData::getSH - Constructs the Structure Header for this class.


static SH getSH();

Return value:
SH- Proc Data structure header.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::ProcData::getSH3 - Constructs fram data vesion 3 Structure Header for this class.


static SH getSH3();

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::ProcData::getSH4 - Constructs frame data vesion 4 Structure Header for this class.


static SH getSH4();

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::ProcData::getSampleRate - Get the data acquisition rate, samples / sec.


inline REAL_8 getSampleRate() const;

Return value:
REAL_8- Sampling rate.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::ProcData::getTimeOffset - Get the time relative to the frame start.


inline const Time& getTimeOffset() const;
This is for triggered data lasting less than one frame, it is the integer seconds and nanoseconds.

Return value:
const Time&- Relative time.

Exceptions:
ExceptionDescription
None.
None.



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


inline bool operator !=(const ProcData& procData) const;

Parameters:
ParameterDescription
const ProcData& procDataThe object to compare with.

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

Exceptions:
ExceptionDescription
None.



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


const ProcData& operator +=(const ProcData& procData);

Parameters:
ParameterDescription
const ProcData& procDataObject to be added.

Return value:
const ProcData&- This object.


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


const ProcData& operator =(const ProcData& procData);

Parameters:
ParameterDescription
const ProcData& procDataObject to be assigned.

Return value:
const ProcData&- This object.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



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


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

Parameters:
ParameterDescription
const ProcData& procDataThe object to compare with.

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

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::ProcData::read - Reads an ProcData object from an FrameReaderBase object.


static ProcData* read(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:
ProcData*- Newly allocated.

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



FrameCPP::Version_3_4_5::ProcData::read3 - Version 3 frame input method.


static ProcData* read3(FrameReaderBase& in);

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



FrameCPP::Version_3_4_5::ProcData::read4 - Version 4 frame input method.


static ProcData* read4(FrameReaderBase& in);

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



FrameCPP::Version_3_4_5::ProcData::refAux - Get the container for user provided information.


inline AuxContainer& refAux();

Return value:
AuxContainer&- Generic data.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::ProcData::refAux - Get the container for user provided information.


inline const AuxContainer& refAux() const;

Return value:
const AuxContainer&- Generic data.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::ProcData::refData - Get the container which contains the data.


inline DataContainer& refData();

Return value:
DataContainer&- Data.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::ProcData::refData - Get the container which contains the data.


inline const DataContainer& refData() const;

Return value:
const DataContainer&- Data.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::ProcData::refTable - Get the container for user provided table data.


inline TableContainer& refTable();

Return value:
SearchContainer< Table, &Table::getName >&- Table.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::ProcData::refTable - Get the container for user provided table data.


inline const TableContainer& refTable() const;

Return value:
const SearchContainer< Table, &Table::getName >&- Table.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::ProcData::setTimeOffset


void setTimeOffset(const INT_4S sec = 0, const INT_4U nan = 0);



FrameCPP::Version_3_4_5::ProcData::write - Writes an ProcData 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::ProcData::mAux - Generic data.

AuxContainer mAux;

FrameCPP::Version_3_4_5::ProcData::mComment - Comment.

std::string mComment;

FrameCPP::Version_3_4_5::ProcData::mData - Sampled data

DataContainer mData;

FrameCPP::Version_3_4_5::ProcData::mFShift - Frequency shift.

REAL_8 mFShift;

FrameCPP::Version_3_4_5::ProcData::mName - Data or channel name.

std::string mName;

FrameCPP::Version_3_4_5::ProcData::mPhase - Phase of heterodyning signal at start of dataset

REAL_4 mPhase;

FrameCPP::Version_3_4_5::ProcData::mSampleRate - Sampling rate.

REAL_8 mSampleRate;

FrameCPP::Version_3_4_5::ProcData::mTable - Tabled data.

TableContainer mTable;

FrameCPP::Version_3_4_5::ProcData::mTimeOffset - Integer seconds start time relative to frame start.

Time mTimeOffset;