Class Index Cross Index Namespace Index

Class FrameCPP::Version_3_4_5::Frame

Frame
Contained in: FrameCPP::Version_3_4_5
Derived from: FrameCPP::Version_3_4_5::Base FrameCPP::FrameHBase
Derived by: FrameCPP::Version_3_4_5::DaqFrame

#include "../../../../../lib/framecpp/src/Version3_4_5/frame.hh"


public function member index:

Frame(); Default Constructor.
Frame(const Frame& frame); Copy Constructor.
Frame(const std::string& name, INT_4S run, INT_4U frame, const Time& time, INT_2U uLeapS, const REAL_8& dt, INT_4U dqual = 0); Constructor.
virtual ~Frame(); Destructor.
virtual INT_2U getClassId() const; Get Class ID
inline INT_4U getDataQuality() const; Get data quality word
inline REAL_8 getDt() const; Get frame length
inline INT_4U getFrame() const; Get frame number
inline const Time& getGTime() const; Get start time
const std::string& getName() const;
inline RawData* getRawData(); Get raw data
inline const RawData* getRawData() const; Get const raw data
inline INT_4S getRun() const; Get run number
static SH getSH(); Get Structure Header
static SH getSH3(); Get Structure Header
static SH getSH4(); Get Structure Header
inline INT_2U getULeapS() const; Get leap seconds
inline bool isRawDataOwned() const; Get raw data ownership flag
inline bool operator !=(const Frame& frame) const; Not-equal comparison.
const Frame& operator +=(const Frame& frame); += Assignment Operator.
const Frame& operator =(const Frame& frame); Assignment Operator.
bool operator ==(const Frame& frame) const; Equal comparison.
inline AuxContainer& refAux(); Get aux data container
inline const AuxContainer& refAux() const; Get const aux data container
inline DetectorProcContainer& refDetectorProc(); Get proc detector container
inline const DetectorProcContainer& refDetectorProc() const; Get const proc detector container
inline DetectorSimContainer& refDetectorSim(); Get sim detector container
inline const DetectorSimContainer& refDetectorSim() const; Get const sim detector container
inline EventContainer& refEvent(); Get event data container
inline const EventContainer& refEvent() const; Get const event data container
inline HistoryContainer& refHistory(); Get history container
inline const HistoryContainer& refHistory() const; Get const history container
inline ProcDataContainer& refProcData(); Get proc data container
inline const ProcDataContainer& refProcData() const; Get const proc data container
inline SimDataContainer& refSimData(); Get sim data container
inline const SimDataContainer& refSimData() const; Get const sim data container
inline SimEventContainer& refSimEvent(); Get simulated event data container
inline const SimEventContainer& refSimEvent() const; Get simulated event data container
inline SummaryContainer& refSummary(); Get summary data container
inline const SummaryContainer& refSummary() const; Get const summary data container
inline TableContainer& refTable(); Get table container
inline const TableContainer& refTable() const; Get table container
inline TypeContainer& refType(); Get 'type' container
inline const TypeContainer& refType() const; Get const 'type' container
inline UserContainer& refUser(); Get 'user' container
inline const UserContainer& refUser() const; Get const 'user' container
inline void setDt(const REAL_8 dt); Set frame length
void setRawData(const RawData& r); Set raw data
void setRawData(const RawData* r); Set raw data
void setRawData(RawData* r, bool allocate = true, bool owns = true); Set raw data
inline void setRawDataOwnership(bool owns); Set raw data ownership flag
 

private function member index:

static Frame* read(FrameReaderBase& in); Read a frame
static Frame* read3(FrameReaderBase& in); Version 3 frame read.
static Frame* read4(FrameReaderBase& in); Version 4 frame read.
virtual void write(Output& out) const; Write a frame.
 

Description:

This class represents a frame object. It is modeled after the FrameH structure in the Frame Specification, LIGO-T970130.


Function Member Descriptions:


FrameCPP::Version_3_4_5::Frame::Frame - Default Constructor.


Frame();
This creates a Frame with the following characteristics:

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::Frame::Frame - Copy Constructor.


Frame(const Frame& frame);
This performs a deep copy of owned elements.

Parameters:
ParameterDescription
const Frame& frameA frame to be copied.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::Frame::Frame - Constructor.


Frame(const std::string& name, INT_4S run, INT_4U frame, const Time& time, INT_2U uLeapS, const REAL_8& dt, INT_4U dqual = 0);
Constructs a frame with the specified parameters but no data.

Parameters:
ParameterDescription
const std::string& nameProject or experiment name.
INT_4S runRun number.
INT_4U frameFrame number.
INT_4U dataQualitydata quality word.
const Time& timeGPS start time.
INT_2U uLeapSLeap seconds in the epoch in which the frame was written.
const REAL_8& dtFrame length in seconds.



FrameCPP::Version_3_4_5::Frame::~Frame - Destructor.


virtual ~Frame();
This deletes the rawdata.

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::Frame::getClassId - Get Class ID


virtual INT_2U getClassId() const;
Gets the class ID.

Return value:
INT_2U

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::Frame::getDataQuality - Get data quality word


inline INT_4U getDataQuality() const;

Return value:
INT_4U- Data quality.


FrameCPP::Version_3_4_5::Frame::getDt - Get frame length


inline REAL_8 getDt() const;
Gets the frame length in seconds.

Return value:
REAL_8- Frame length in seconds.


FrameCPP::Version_3_4_5::Frame::getFrame - Get frame number


inline INT_4U getFrame() const;
Gets the frame number.

Return value:
INT_4U- Frame number.


FrameCPP::Version_3_4_5::Frame::getGTime - Get start time


inline const Time& getGTime() const;
Gets the frame start time. This is the GPS time in integer seconds and the integer nanosecond residual since the GPS standard epoch. This is calid for approximately 143 years from time origin.

Return value:
const Time&- Frame start time.


FrameCPP::Version_3_4_5::Frame::getName


const std::string& getName() const;



FrameCPP::Version_3_4_5::Frame::getRawData - Get raw data


inline RawData* getRawData();
Gets the raw data object.

Return value:
RawData&- Raw data.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Frame::getRawData - Get const raw data


inline const RawData* getRawData() const;
Gets the raw data object.

Return value:
const RawData&- Raw data.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Frame::getRun - Get run number


inline INT_4S getRun() const;
Gets the run number.

Return value:
INT_4S- Frame run number.


FrameCPP::Version_3_4_5::Frame::getSH - Get Structure Header


static SH getSH();
Constructs the Structure Header for this class.

Return value:
SH- Frame structure header.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::Frame::getSH3 - Get Structure Header


static SH getSH3();
Constructs the Structure Header for this class. Frame Data format version 3.

Return value:
SH- Frame structure header.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::Frame::getSH4 - Get Structure Header


static SH getSH4();
Constructs the Structure Header for this class. Frame Data format version 4.

Return value:
SH- Frame structure header.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::Frame::getULeapS - Get leap seconds


inline INT_2U getULeapS() const;
Gets the number of leap seconds. This is the integer number of leap seconds between GPS/TAI and UTC in the epoch when the frame is written: ULeapS = Int[TAI - UTC].

Return value:
INT_2U- Leap seconds.


FrameCPP::Version_3_4_5::Frame::isRawDataOwned - Get raw data ownership flag


inline bool isRawDataOwned() const;



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


inline bool operator !=(const Frame& frame) const;
Determines whether two frame objects are not equal. All contained data is compared.

Parameters:
ParameterDescription
const Frame& frameThe object to compare with.

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

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::Frame::operator += - += Assignment Operator.


const Frame& operator +=(const Frame& frame);

Parameters:
ParameterDescription
const Frame& frame

Return value:
const Frame&

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.
frame_mismatchCouldn't add `frame' (time or ADC mismatch)



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


const Frame& operator =(const Frame& frame);

Parameters:
ParameterDescription
const Frame& frameObject to be assigned.

Return value:
const Frame&- This frame.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



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


bool operator ==(const Frame& frame) const;

Parameters:
ParameterDescription
const Frame& frameFrame which which to compare.

Return value:
bool- True if frames are equal.

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::Frame::read - Read a frame


static Frame* read(FrameReaderBase& in);
Reads a Frame object from an Input object. This method creates a dynamically allocated Frame object. This frame is initialized from the given Input object.

*NOTE* This method allocates memory and returns a pointer to it. The user is responsible for freeing this memory.


Parameters:
ParameterDescription
Input& inInput data stream object.

Return value:
Frame*- Newly created.

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



FrameCPP::Version_3_4_5::Frame::read3 - Version 3 frame read.


static Frame* read3(FrameReaderBase& in);

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



FrameCPP::Version_3_4_5::Frame::read4 - Version 4 frame read.


static Frame* read4(FrameReaderBase& in);

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



FrameCPP::Version_3_4_5::Frame::refAux - Get aux data container


inline AuxContainer& refAux();
Gets the container used to store auxiliary data.

Return value:
AuxContainer&- Auxiliary data.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Frame::refAux - Get const aux data container


inline const AuxContainer& refAux() const;
Gets the container used to store auxiliary data.

Return value:
const AuxContainer&- Auxiliary data.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Frame::refDetectorProc - Get proc detector container


inline DetectorProcContainer& refDetectorProc();

Return value:
SearchContainer&- Proc Detector.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Frame::refDetectorProc - Get const proc detector container


inline const DetectorProcContainer& refDetectorProc() const;

Return value:
const DetectorProcContainer&- Proc Detector.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Frame::refDetectorSim - Get sim detector container


inline DetectorSimContainer& refDetectorSim();

Return value:
DetectorSimContainer&- Sim Detector.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Frame::refDetectorSim - Get const sim detector container


inline const DetectorSimContainer& refDetectorSim() const;

Return value:
const DetectorSimContainer&- Sim Detector.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Frame::refEvent - Get event data container


inline EventContainer& refEvent();
Gets the container used to store event data.

Return value:
EventContainer&- Event data.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Frame::refEvent - Get const event data container


inline const EventContainer& refEvent() const;
Gets the container used to store event data.

Return value:
const EventContainer&- Event data.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Frame::refHistory - Get history container


inline HistoryContainer& refHistory();
Gets the history container. This contains the history of post-processing with which frame may have been generated.

Return value:
HistoryContainer&- History.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Frame::refHistory - Get const history container


inline const HistoryContainer& refHistory() const;
Gets the history container. This contains the history of post-processing with which frame may have been generated.

Return value:
const HistoryContainer&- History.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Frame::refProcData - Get proc data container


inline ProcDataContainer& refProcData();
Gets the container used to store procData.

Return value:
ProcDataContainer&- Processed data.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Frame::refProcData - Get const proc data container


inline const ProcDataContainer& refProcData() const;
Gets the container used to store procData.

Return value:
const ProcDataContainer&- Processed data.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Frame::refSimData - Get sim data container


inline SimDataContainer& refSimData();
Gets the container used to store simulated data.

Return value:
SimDataContainer&- Simulated data.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Frame::refSimData - Get const sim data container


inline const SimDataContainer& refSimData() const;
Gets the container used to store simulated data.

Return value:
const SimDataContainer&- Simulated data.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Frame::refSimEvent - Get simulated event data container


inline SimEventContainer& refSimEvent();
Gets simulated event data container

Return value:
SimEventContainer&- Simulated event data.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Frame::refSimEvent - Get simulated event data container


inline const SimEventContainer& refSimEvent() const;
Gets simulated event data container

Return value:
SimEventContainer&- Simulated event data.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Frame::refSummary - Get summary data container


inline SummaryContainer& refSummary();
Gets the container used to store statistical summary data.

Return value:
SummaryContainer&- Summary data.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Frame::refSummary - Get const summary data container


inline const SummaryContainer& refSummary() const;
Gets the container used to store statistical summary data.

Return value:
const SummaryContainer&- Summary data.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Frame::refTable - Get table container


inline TableContainer& refTable();
Gets the container used to store table(s).

Return value:
TableContainer&- Auxiliary table data.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Frame::refTable - Get table container


inline const TableContainer& refTable() const;
Gets the container used to store table(s).

Return value:
const TableContainer&- Auxiliary table data.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Frame::refType - Get 'type' container


inline TypeContainer& refType();
Gets the 'type' container. This returns a reference to the 'type' container used to store general information.

Return value:
TypeContainer&- Data.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Frame::refType - Get const 'type' container


inline const TypeContainer& refType() const;
Gets the 'type' container. This returns a constant reference to the 'type' container used to store general information.

Return value:
const TypeContainer&- Data.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Frame::refUser - Get 'user' container


inline UserContainer& refUser();
Gets the 'user' container. This returns a reference to the 'user' container used to store user-provided information.

Return value:
UserContainer&- User data.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Frame::refUser - Get const 'user' container


inline const UserContainer& refUser() const;
Gets the 'user' container. This returns a constant reference to the 'user' container used to store user-provided information.

Return value:
UserContainer&- User data.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Frame::setDt - Set frame length


inline void setDt(const REAL_8 dt);
Sets the frame length in seconds.

Return value:
Nothing Nothing.


FrameCPP::Version_3_4_5::Frame::setRawData - Set raw data


void setRawData(const RawData& r);

Parameters:
ParameterDescription
const RawData& rRawData to set.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::Frame::setRawData - Set raw data


void setRawData(const RawData* r);

Parameters:
ParameterDescription
const RawData* rRawData to set.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::Frame::setRawData - Set raw data


void setRawData(RawData* r, bool allocate = true, bool owns = true);

Parameters:
ParameterDescription
RawData* rRawData to ste.
bool allocateWill allocate a copy of `r'.
bool ownsFrame will own its RawData.

Exceptions:
ExceptionDescription
std::bad_alloc



FrameCPP::Version_3_4_5::Frame::setRawDataOwnership - Set raw data ownership flag


inline void setRawDataOwnership(bool owns);



FrameCPP::Version_3_4_5::Frame::write - Write a frame.


virtual void write(Output& out) const;
Writes a frame to an Output object.

Parameters:
ParameterDescription
Output& out outOutput data stream object.

Exceptions:
ExceptionDescription
write_failureWrite failed.



Variable Member Descriptions:


FrameCPP::Version_3_4_5::Frame::mAux - Auxiliary data.

AuxContainer mAux;

FrameCPP::Version_3_4_5::Frame::mDataQuality - Top level quality of data.

INT_4U mDataQuality;

FrameCPP::Version_3_4_5::Frame::mDetectorProc - Data used in generating post-processing outputs.

DetectorProcContainer mDetectorProc;

FrameCPP::Version_3_4_5::Frame::mDetectorSim - Model or simulation parameter data definition.

DetectorSimContainer mDetectorSim;

FrameCPP::Version_3_4_5::Frame::mDt - Frame length in seconds.

REAL_8 mDt;

FrameCPP::Version_3_4_5::Frame::mEvent - Event data.

EventContainer mEvent;

FrameCPP::Version_3_4_5::Frame::mFrame - Frame number

INT_4U mFrame;

FrameCPP::Version_3_4_5::Frame::mGTime - Frame start time.

Time mGTime;

FrameCPP::Version_3_4_5::Frame::mHistory - History of post-processing.

HistoryContainer mHistory;

FrameCPP::Version_3_4_5::Frame::mName - Name of project or other experiment descritpion.

std::string mName;

FrameCPP::Version_3_4_5::Frame::mOwnsRawData - Frame owns its RawData.

bool mOwnsRawData;

FrameCPP::Version_3_4_5::Frame::mProcData - Post-processed data.

ProcDataContainer mProcData;

FrameCPP::Version_3_4_5::Frame::mRawData - Raw data.

RawData* mRawData;

FrameCPP::Version_3_4_5::Frame::mRun - Run number.

INT_4S mRun;

FrameCPP::Version_3_4_5::Frame::mSimData - Simulated data.

SimDataContainer mSimData;

FrameCPP::Version_3_4_5::Frame::mSimEvent - Simulated event data.

SimEventContainer mSimEvent;

FrameCPP::Version_3_4_5::Frame::mSummary - Statistical summary data.

SummaryContainer mSummary;

FrameCPP::Version_3_4_5::Frame::mTable - Auxiliary table data.

TableContainer mTable;

FrameCPP::Version_3_4_5::Frame::mType - General info.

TypeContainer mType;

FrameCPP::Version_3_4_5::Frame::mULeapS - Leap seconds between GPS/TAI and UTC valid fo `mGTime'.

INT_2U mULeapS;

FrameCPP::Version_3_4_5::Frame::mUser - Generic info.

UserContainer mUser;