Class Index | Cross Index | Namespace Index |
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. |
This creates a Frame with the following characteristics:
- name = "none"
- run = 0
- frame = 0
- dataQuality = 0
- GTime = 0 seconds, 0 nanoseconds
- ULeapS = 0
- dt = 0
- No other data.
Exceptions:
Exception | Description |
None. |
This performs a deep copy of owned elements.
Parameters:
Parameter | Description |
const Frame& frame | A frame to be copied. |
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
Constructs a frame with the specified parameters but no data.
Parameters:
Parameter | Description |
const std::string& name | Project or experiment name. |
INT_4S run | Run number. |
INT_4U frame | Frame number. |
INT_4U dataQuality | data quality word. |
const Time& time | GPS start time. |
INT_2U uLeapS | Leap seconds in the epoch in which the frame was written. |
const REAL_8& dt | Frame length in seconds. |
This deletes the rawdata.
Exceptions:
Exception | Description |
None. |
Gets the class ID.
Return value:
INT_2U
Exceptions:
Exception | Description |
None. |
Return value:
INT_4U- Data quality.
Gets the frame length in seconds.
Return value:
REAL_8- Frame length in seconds.
Gets the frame number.
Return value:
INT_4U- Frame number.
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.
Gets the raw data object.
Return value:
RawData&- Raw data.
Exceptions:
Exception | Description |
None. | |
None. |
Gets the raw data object.
Return value:
const RawData&- Raw data.
Exceptions:
Exception | Description |
None. | |
None. |
Gets the run number.
Return value:
INT_4S- Frame run number.
Constructs the Structure Header for this class.
Return value:
SH- Frame structure header.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
Constructs the Structure Header for this class. Frame Data format version 3.
Return value:
SH- Frame structure header.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
Constructs the Structure Header for this class. Frame Data format version 4.
Return value:
SH- Frame structure header.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
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.
Determines whether two frame objects are not equal. All contained data is compared.
Parameters:
Parameter | Description |
const Frame& frame | The object to compare with. |
Return value:
bool- True if the objects are not equal.
Exceptions:
Exception | Description |
None. |
Parameters:
Parameter | Description |
const Frame& frame |
Return value:
const Frame&
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
frame_mismatch | Couldn't add `frame' (time or ADC mismatch) |
Parameters:
Parameter | Description |
const Frame& frame | Object to be assigned. |
Return value:
const Frame&- This frame.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
Parameters:
Parameter | Description |
const Frame& frame | Frame which which to compare. |
Return value:
bool- True if frames are equal.
Exceptions:
Exception | Description |
None. |
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:
Parameter | Description |
Input& in | Input data stream object. |
Return value:
Frame*- Newly created.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
read_failure | Read failed. |
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
read_failure | Read failed. |
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
read_failure | Read failed. |
Gets the container used to store auxiliary data.
Return value:
AuxContainer&- Auxiliary data.
Exceptions:
Exception | Description |
None. | |
None. |
Gets the container used to store auxiliary data.
Return value:
const AuxContainer&- Auxiliary data.
Exceptions:
Exception | Description |
None. | |
None. |
Return value:
SearchContainer&- Proc Detector.
Exceptions:
Exception | Description |
None. | |
None. |
Return value:
const DetectorProcContainer&- Proc Detector.
Exceptions:
Exception | Description |
None. | |
None. |
Return value:
DetectorSimContainer&- Sim Detector.
Exceptions:
Exception | Description |
None. | |
None. |
Return value:
const DetectorSimContainer&- Sim Detector.
Exceptions:
Exception | Description |
None. | |
None. |
Gets the container used to store event data.
Return value:
EventContainer&- Event data.
Exceptions:
Exception | Description |
None. | |
None. |
Gets the container used to store event data.
Return value:
const EventContainer&- Event data.
Exceptions:
Exception | Description |
None. | |
None. |
Gets the history container. This contains the history of post-processing with which frame may have been generated.
Return value:
HistoryContainer&- History.
Exceptions:
Exception | Description |
None. | |
None. |
Gets the history container. This contains the history of post-processing with which frame may have been generated.
Return value:
const HistoryContainer&- History.
Exceptions:
Exception | Description |
None. | |
None. |
Gets the container used to store procData.
Return value:
ProcDataContainer&- Processed data.
Exceptions:
Exception | Description |
None. | |
None. |
Gets the container used to store procData.
Return value:
const ProcDataContainer&- Processed data.
Exceptions:
Exception | Description |
None. | |
None. |
Gets the container used to store simulated data.
Return value:
SimDataContainer&- Simulated data.
Exceptions:
Exception | Description |
None. | |
None. |
Gets the container used to store simulated data.
Return value:
const SimDataContainer&- Simulated data.
Exceptions:
Exception | Description |
None. | |
None. |
Gets simulated event data container
Return value:
SimEventContainer&- Simulated event data.
Exceptions:
Exception | Description |
None. | |
None. |
Gets simulated event data container
Return value:
SimEventContainer&- Simulated event data.
Exceptions:
Exception | Description |
None. | |
None. |
Gets the container used to store statistical summary data.
Return value:
SummaryContainer&- Summary data.
Exceptions:
Exception | Description |
None. | |
None. |
Gets the container used to store statistical summary data.
Return value:
const SummaryContainer&- Summary data.
Exceptions:
Exception | Description |
None. | |
None. |
Gets the container used to store table(s).
Return value:
TableContainer&- Auxiliary table data.
Exceptions:
Exception | Description |
None. | |
None. |
Gets the container used to store table(s).
Return value:
const TableContainer&- Auxiliary table data.
Exceptions:
Exception | Description |
None. | |
None. |
Gets the 'type' container. This returns a reference to the 'type' container used to store general information.
Return value:
TypeContainer&- Data.
Exceptions:
Exception | Description |
None. | |
None. |
Gets the 'type' container. This returns a constant reference to the 'type' container used to store general information.
Return value:
const TypeContainer&- Data.
Exceptions:
Exception | Description |
None. | |
None. |
Gets the 'user' container. This returns a reference to the 'user' container used to store user-provided information.
Return value:
UserContainer&- User data.
Exceptions:
Exception | Description |
None. | |
None. |
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:
Exception | Description |
None. | |
None. |
Sets the frame length in seconds.
Return value:
Nothing Nothing.
Parameters:
Parameter | Description |
const RawData& r | RawData to set. |
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
Parameters:
Parameter | Description |
const RawData* r | RawData to set. |
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
Parameters:
Parameter | Description |
RawData* r | RawData to ste. |
bool allocate | Will allocate a copy of `r'. |
bool owns | Frame will own its RawData. |
Exceptions:
Exception | Description |
std::bad_alloc |
Writes a frame to an Output object.
Parameters:
Parameter | Description |
Output& out out | Output data stream object. |
Exceptions:
Exception | Description |
write_failure | Write failed. |