Class Index | Cross Index | Namespace Index |
This class represents frame file table of contents .
Contained in: FrameCPP::Version_3_4_5
Derived from:
FrameCPP::Version_3_4_5::Base
Derived by:
FrameCPP::Version_3_4_5::FrameWriterTOC
FrameCPP::Version_3_4_5::TOCReader
#include "../../../../../lib/framecpp/src/Version3_4_5/toc.hh"
public function member index: |
|||
TOC | (); | Default Constructor. | |
TOC | (const TOC& eof); | Copy Constructor. | |
virtual | ~TOC | (); | |
virtual INT_2U | getClassId | () const; | |
inline const std::vector<REAL_8>& | getDt | () const; | Get frame durations |
inline const std::vector<INT_8U>& | getFirstADCPosition | () const; | Get first ADC positions |
inline const std::vector<INT_8U>& | getFirstMsgPosition | () const; | Get first message structure positions |
inline const std::vector<INT_8U>& | getFirstSerPosition | () const; | Get first serial data structure positions |
inline const std::vector<INT_8U>& | getFirstTablePosition | () const; | Get first raw data referenced table positions |
inline const std::vector<INT_4U>& | getFrame | () const; | Get frame numbers |
inline unsigned long | getFrameNumber | () const; | Get the total number of frames in file |
inline const std::vector<Time>& | getGTime | () const; | Get frame time stamps |
inline const std::vector<INT_8U>& | getPositionH | () const; | Get frame header positions |
inline const std::vector<INT_4S>& | getRuns | (unsigned long idx) const; | Get run numbers |
static SH | getSH | (); | Constructs the Structure Header for this class. |
static SH | getSH4 | (); | Constructs frame data version 4 Structure Header for this class |
inline INT_2S | getULeapS | () const; | Get leap seconds from the first frame in file |
const TOC& | operator = | (const TOC& eof); | Assignment Operator. |
protected function member index: |
|||
static TOC* | read | (Input& in); | Skips TOC structure in an Input object. |
static TOC* | read4 | (Input& in); | Skips TOC structure in an Input object. |
TOC* | reallyRead | (Input& in); | Reads an TOC object from an Input object. |
virtual void | write | (Output& out) const; | Writes an TOC object to an Output object. |
Exceptions:
Exception | Description |
None. |
This performs a deep copy of the object.
Parameters:
Parameter | Description |
const TOC& toc | Object to be copied. |
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
Exceptions:
Exception | Description |
None. |
Return value:
SH- TOC structure header.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
Parameters:
Parameter | Description |
const TOC& toc | Object to be assigned. |
Return value:
const TOC&- This TOC object.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
This method skips over the TOC. It is not read here.
Parameters:
Parameter | Description |
Input& in | Input data stream object. |
Return value:
TOC*- Always return zero.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
read_failure | Failed to skip over the TOC. |
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
read_failure | Failed to skip over the TOC. |
This method is used to read the table of contents.
Parameters:
Parameter | Description |
Input& in | Input stream object. |
Return value:
0absent or corrupt TOC; this -- everything was fine.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
read_failure | Read failed. |
Parameters:
Parameter | Description |
Output& out out | Outpu stream object. |
Exceptions:
Exception | Description |
write_failure | Write failed. |
Maps Detector name into its position
Maps proc name onto the std::vector of positions. One position per name per frame.
Maps Serial name onto the std::vector of positions. One position per name per frame.
Maps simulated data name on the std::vector of positions One position per name per frame
Maps Serial name onto the std::vector of positions. One position per name per frame.