|
| FrameH () |
| Default constructor.
|
|
| FrameH (const name_type &name, run_type run, frame_type frame, const GTime_type &time, ULeapS_type uLeapS, const dt_type dt, dataQuality_type dqual=0) |
| Explicate construction.
|
|
| FrameH (const FrameH &frame) |
| Copy Constructor.
|
|
| FrameH (const Previous::FrameH &Source, stream_base_type *Stream) |
| Upconvert constructor.
|
|
virtual FrameH * | Clone () const |
| Virtual constructor.
|
|
virtual bool | operator== (const Common::FrameSpec::Object &Obj) const |
| equality operator
|
|
| FrameH () |
| Default constructor.
|
|
| FrameH (const name_type &name, run_type run, frame_type frame, const GTime_type &time, ULeapS_type uLeapS, const dt_type dt, dataQuality_type dqual=0) |
| Explicate construction.
|
|
| FrameH (const FrameH &frame) |
| Copy Constructor.
|
|
| FrameH (const Previous::FrameH &Source, stream_base_type *Stream) |
| Upconvert constructor.
|
|
virtual FrameH * | Clone () const |
| Virtual constructor.
|
|
virtual bool | operator== (const Common::FrameSpec::Object &Obj) const |
| equality operator
|
|
virtual const char * | ObjectStructName () const |
| The name structure name of this object.
|
|
virtual const char * | ObjectStructName () const |
| The name structure name of this object.
|
|
virtual streamsize_type | Bytes (const StreamBase &Stream) const |
| Return the number of bytes for this object.
|
|
virtual streamsize_type | Bytes (const StreamBase &Stream) const |
| Return the number of bytes for this object.
|
|
virtual self_type * | Create (istream_type &Stream) const |
| Virtual constructor.
|
|
virtual self_type * | Create (istream_type &Stream) const |
| Virtual constructor.
|
|
virtual void | Write (ostream_type &Stream) const |
| Write object to the stream.
|
|
virtual void | Write (ostream_type &Stream) const |
| Write object to the stream.
|
|
const name_type & | GetName () const |
| Retrieve name of project.
|
|
run_type | GetRun () const |
| Run number.
|
|
frame_type | GetFrame () const |
| Frame number.
|
|
dataQuality_type | GetDataQuality () const |
| Data quality flag.
|
|
const GTime_type & | GetGTime () const |
| Start Time.
|
|
ULeapS_type | GetULeapS () const |
| Leap seconds.
|
|
dt_type | GetDt () const |
| Frame length.
|
|
void | SetName (const name_type &Name) |
| Establish the name.
|
|
void | SetRun (run_type Run) |
| Establish the run number.
|
|
void | SetDataQuality (dataQuality_type DataQuality) |
| Establish the data quality flag.
|
|
void | SetDt (dt_type Dt) |
| Establish the frame duration.
|
|
void | SetGTime (const GTime_type &Value) |
| Establish the start time.
|
|
void | SetULeapS (ULeapS_type Value) |
| Establish leap second offset.
|
|
rawData_type | GetRawData () const |
| Retrieve the raw data reference.
|
|
rawData_type | GetRawData () |
| Retrieve the raw data reference.
|
|
|
static promote_ret_type | Promote (INT_2U Source, promote_arg_type Obj, promote_stream_type *Stream) |
| Promote previous version of object to this version.
|
|
static promote_ret_type | Promote (INT_2U Source, promote_arg_type Obj, promote_stream_type *Stream) |
| Promote previous version of object to this version.
|
|
static const Common::Description * | StructDescription () |
| The description of structure.
|
|
static const Common::Description * | StructDescription () |
| The description of structure.
|
|
static const char * | CheckSumDataClass () |
| Data class to be used in class field of FrSE.
|
|
static const char * | CheckSumDataClass () |
| Data class to be used in class field of FrSE.
|
|
static const char * | CheckSumDataComment () |
| Comment to be used in comment field of FrSE.
|
|
static const char * | CheckSumDataComment () |
| Comment to be used in comment field of FrSE.
|
|
static struct_desc_type | FrameSpecDescription () |
| Return the dictionary name of the structure.
|
|
static struct_id_type | FrameSpecId () |
| Return the dictionary name of the structure.
|
|
|
virtual void | assign (assign_stream_type &Stream) |
| Assign the contents of the instance.
|
|
virtual void | assign (assign_stream_type &Stream) |
| Assign the contents of the instance.
|
|
virtual delta_t_normalized_type | normalizedDeltaT () const |
| Frame start time in seconds.
|
|
virtual delta_t_normalized_type | normalizedDeltaT () const |
| Frame start time in seconds.
|
|
virtual start_time_normalized_type | normalizedStartTime () const |
| Duration of the frame.
|
|
virtual start_time_normalized_type | normalizedStartTime () const |
| Duration of the frame.
|
|
cmn_streamsize_type | pBytes (const Common::StreamBase &Stream) const |
| Number of bytes needed to write this structure.
|
|
cmn_streamsize_type | pBytes (const Common::StreamBase &Stream) const |
| Number of bytes needed to write this structure.
|
|
virtual self_type * | pCreate (istream_type &Stream) const |
| Virtual constructor.
|
|
virtual self_type * | pCreate (istream_type &Stream) const |
| Virtual constructor.
|
|
virtual void | pWrite (ostream_type &Stream) const |
| Write the structure to the stream.
|
|
virtual void | pWrite (ostream_type &Stream) const |
| Write the structure to the stream.
|
|
virtual void | readSubset (istream_type &Stream, INT_4U ElementMask) |
| Limitted reading of the object.
|
|
virtual void | readSubset (istream_type &Stream, INT_4U ElementMask) |
| Limitted reading of the object.
|
|
virtual void | vTOCQuery (int InfoClass, va_list vl) const |
| Answer requests for information as needed by TOC.
|
|
virtual void | vTOCQuery (int InfoClass, va_list vl) const |
| Answer requests for information as needed by TOC.
|
|
template<typename TYPE_T , typename USER_T , typename DETECT_SIM_T , typename DETECT_PROC_T , typename HISTORY_T , typename RAW_DATA_T , typename PROC_DATA_T , typename SIM_DATA_T , typename EVENT_T , typename SIM_EVENT_T , typename SUMMARY_DATA_T , typename AUX_DATA_T , typename AUX_TABLE_T >
dataQuality_type FrameCPP::v5::FrameH< TYPE_T, USER_T, DETECT_SIM_T, DETECT_PROC_T, HISTORY_T, RAW_DATA_T, PROC_DATA_T, SIM_DATA_T, EVENT_T, SIM_EVENT_T, SUMMARY_DATA_T, AUX_DATA_T, AUX_TABLE_T >::GetDataQuality |
( |
| ) |
const |
|
inlineinherited |
Data quality flag.
Retrieve the data quality flag associated with the frame
- Returns
- The data quality flag for the frame
template<typename TYPE_T , typename USER_T , typename DETECT_SIM_T , typename DETECT_PROC_T , typename HISTORY_T , typename RAW_DATA_T , typename PROC_DATA_T , typename SIM_DATA_T , typename EVENT_T , typename SIM_EVENT_T , typename SUMMARY_DATA_T , typename AUX_DATA_T , typename AUX_TABLE_T >
dt_type FrameCPP::v5::FrameH< TYPE_T, USER_T, DETECT_SIM_T, DETECT_PROC_T, HISTORY_T, RAW_DATA_T, PROC_DATA_T, SIM_DATA_T, EVENT_T, SIM_EVENT_T, SUMMARY_DATA_T, AUX_DATA_T, AUX_TABLE_T >::GetDt |
( |
| ) |
const |
|
inlineinherited |
Frame length.
Retrieve the duration of the frame in seconds.
- Returns
- Length of frame in seconds.
template<typename TYPE_T , typename USER_T , typename DETECT_SIM_T , typename DETECT_PROC_T , typename HISTORY_T , typename RAW_DATA_T , typename PROC_DATA_T , typename SIM_DATA_T , typename EVENT_T , typename SIM_EVENT_T , typename SUMMARY_DATA_T , typename AUX_DATA_T , typename AUX_TABLE_T >
frame_type FrameCPP::v5::FrameH< TYPE_T, USER_T, DETECT_SIM_T, DETECT_PROC_T, HISTORY_T, RAW_DATA_T, PROC_DATA_T, SIM_DATA_T, EVENT_T, SIM_EVENT_T, SUMMARY_DATA_T, AUX_DATA_T, AUX_TABLE_T >::GetFrame |
( |
| ) |
const |
|
inlineinherited |
Frame number.
Retrieve the frame number associated with the frame
- Returns
- The frame number of the frame
template<typename TYPE_T , typename USER_T , typename DETECT_SIM_T , typename DETECT_PROC_T , typename HISTORY_T , typename RAW_DATA_T , typename PROC_DATA_T , typename SIM_DATA_T , typename EVENT_T , typename SIM_EVENT_T , typename SUMMARY_DATA_T , typename AUX_DATA_T , typename AUX_TABLE_T >
const GTime_type & FrameCPP::v5::FrameH< TYPE_T, USER_T, DETECT_SIM_T, DETECT_PROC_T, HISTORY_T, RAW_DATA_T, PROC_DATA_T, SIM_DATA_T, EVENT_T, SIM_EVENT_T, SUMMARY_DATA_T, AUX_DATA_T, AUX_TABLE_T >::GetGTime |
( |
| ) |
const |
|
inlineinherited |
Start Time.
Retrieve the start time of the frame.
- Returns
- The start time of the frame
template<typename TYPE_T , typename USER_T , typename DETECT_SIM_T , typename DETECT_PROC_T , typename HISTORY_T , typename RAW_DATA_T , typename PROC_DATA_T , typename SIM_DATA_T , typename EVENT_T , typename SIM_EVENT_T , typename SUMMARY_DATA_T , typename AUX_DATA_T , typename AUX_TABLE_T >
const name_type & FrameCPP::v5::FrameH< TYPE_T, USER_T, DETECT_SIM_T, DETECT_PROC_T, HISTORY_T, RAW_DATA_T, PROC_DATA_T, SIM_DATA_T, EVENT_T, SIM_EVENT_T, SUMMARY_DATA_T, AUX_DATA_T, AUX_TABLE_T >::GetName |
( |
| ) |
const |
|
inlineinherited |
Retrieve name of project.
Retrieve the name of project or other experiment description.
- Returns
- Name of project
template<typename TYPE_T , typename USER_T , typename DETECT_SIM_T , typename DETECT_PROC_T , typename HISTORY_T , typename RAW_DATA_T , typename PROC_DATA_T , typename SIM_DATA_T , typename EVENT_T , typename SIM_EVENT_T , typename SUMMARY_DATA_T , typename AUX_DATA_T , typename AUX_TABLE_T >
rawData_type FrameCPP::v5::FrameH< TYPE_T, USER_T, DETECT_SIM_T, DETECT_PROC_T, HISTORY_T, RAW_DATA_T, PROC_DATA_T, SIM_DATA_T, EVENT_T, SIM_EVENT_T, SUMMARY_DATA_T, AUX_DATA_T, AUX_TABLE_T >::GetRawData |
( |
| ) |
|
|
inlineinherited |
Retrieve the raw data reference.
- Returns
- A pointer to the raw data structure.
template<typename TYPE_T , typename USER_T , typename DETECT_SIM_T , typename DETECT_PROC_T , typename HISTORY_T , typename RAW_DATA_T , typename PROC_DATA_T , typename SIM_DATA_T , typename EVENT_T , typename SIM_EVENT_T , typename SUMMARY_DATA_T , typename AUX_DATA_T , typename AUX_TABLE_T >
rawData_type FrameCPP::v5::FrameH< TYPE_T, USER_T, DETECT_SIM_T, DETECT_PROC_T, HISTORY_T, RAW_DATA_T, PROC_DATA_T, SIM_DATA_T, EVENT_T, SIM_EVENT_T, SUMMARY_DATA_T, AUX_DATA_T, AUX_TABLE_T >::GetRawData |
( |
| ) |
const |
|
inlineinherited |
Retrieve the raw data reference.
Set the number of leap seconds since GPS epoc.
- Returns
- A pointer to the raw data structure.
template<typename TYPE_T , typename USER_T , typename DETECT_SIM_T , typename DETECT_PROC_T , typename HISTORY_T , typename RAW_DATA_T , typename PROC_DATA_T , typename SIM_DATA_T , typename EVENT_T , typename SIM_EVENT_T , typename SUMMARY_DATA_T , typename AUX_DATA_T , typename AUX_TABLE_T >
run_type FrameCPP::v5::FrameH< TYPE_T, USER_T, DETECT_SIM_T, DETECT_PROC_T, HISTORY_T, RAW_DATA_T, PROC_DATA_T, SIM_DATA_T, EVENT_T, SIM_EVENT_T, SUMMARY_DATA_T, AUX_DATA_T, AUX_TABLE_T >::GetRun |
( |
| ) |
const |
|
inlineinherited |
Run number.
Retrieve the run number associated with the frame.
- Returns
- The run number of the frame
template<typename TYPE_T , typename USER_T , typename DETECT_SIM_T , typename DETECT_PROC_T , typename HISTORY_T , typename RAW_DATA_T , typename PROC_DATA_T , typename SIM_DATA_T , typename EVENT_T , typename SIM_EVENT_T , typename SUMMARY_DATA_T , typename AUX_DATA_T , typename AUX_TABLE_T >
ULeapS_type FrameCPP::v5::FrameH< TYPE_T, USER_T, DETECT_SIM_T, DETECT_PROC_T, HISTORY_T, RAW_DATA_T, PROC_DATA_T, SIM_DATA_T, EVENT_T, SIM_EVENT_T, SUMMARY_DATA_T, AUX_DATA_T, AUX_TABLE_T >::GetULeapS |
( |
| ) |
const |
|
inlineinherited |
Leap seconds.
Retrieve the number of leap seconds associated with the frame.
- Returns
- The integer number of leap seconds associated with the start time.
template<typename TYPE_T , typename USER_T , typename DETECT_SIM_T , typename DETECT_PROC_T , typename HISTORY_T , typename RAW_DATA_T , typename PROC_DATA_T , typename SIM_DATA_T , typename EVENT_T , typename SIM_EVENT_T , typename SUMMARY_DATA_T , typename AUX_DATA_T , typename AUX_TABLE_T >
void FrameCPP::v5::FrameH< TYPE_T, USER_T, DETECT_SIM_T, DETECT_PROC_T, HISTORY_T, RAW_DATA_T, PROC_DATA_T, SIM_DATA_T, EVENT_T, SIM_EVENT_T, SUMMARY_DATA_T, AUX_DATA_T, AUX_TABLE_T >::SetDataQuality |
( |
dataQuality_type | DataQuality | ) |
|
|
inlineinherited |
Establish the data quality flag.
Set the data quality flag of the frame.
- Parameters
-
[in] | DataQuality | The value of the data quality flag. |
template<typename TYPE_T , typename USER_T , typename DETECT_SIM_T , typename DETECT_PROC_T , typename HISTORY_T , typename RAW_DATA_T , typename PROC_DATA_T , typename SIM_DATA_T , typename EVENT_T , typename SIM_EVENT_T , typename SUMMARY_DATA_T , typename AUX_DATA_T , typename AUX_TABLE_T >
void FrameCPP::v5::FrameH< TYPE_T, USER_T, DETECT_SIM_T, DETECT_PROC_T, HISTORY_T, RAW_DATA_T, PROC_DATA_T, SIM_DATA_T, EVENT_T, SIM_EVENT_T, SUMMARY_DATA_T, AUX_DATA_T, AUX_TABLE_T >::SetDt |
( |
dt_type | Dt | ) |
|
|
inlineinherited |
Establish the frame duration.
Set the length of the frame in seconds.
- Parameters
-
[in] | Dt | The length of the frame in seconds |
template<typename TYPE_T , typename USER_T , typename DETECT_SIM_T , typename DETECT_PROC_T , typename HISTORY_T , typename RAW_DATA_T , typename PROC_DATA_T , typename SIM_DATA_T , typename EVENT_T , typename SIM_EVENT_T , typename SUMMARY_DATA_T , typename AUX_DATA_T , typename AUX_TABLE_T >
void FrameCPP::v5::FrameH< TYPE_T, USER_T, DETECT_SIM_T, DETECT_PROC_T, HISTORY_T, RAW_DATA_T, PROC_DATA_T, SIM_DATA_T, EVENT_T, SIM_EVENT_T, SUMMARY_DATA_T, AUX_DATA_T, AUX_TABLE_T >::SetGTime |
( |
const GTime_type & | Value | ) |
|
|
inlineinherited |
Establish the start time.
Set the start time of the frame.
- Parameters
-
[in] | Value | The start time of the frame. |
template<typename TYPE_T , typename USER_T , typename DETECT_SIM_T , typename DETECT_PROC_T , typename HISTORY_T , typename RAW_DATA_T , typename PROC_DATA_T , typename SIM_DATA_T , typename EVENT_T , typename SIM_EVENT_T , typename SUMMARY_DATA_T , typename AUX_DATA_T , typename AUX_TABLE_T >
void FrameCPP::v5::FrameH< TYPE_T, USER_T, DETECT_SIM_T, DETECT_PROC_T, HISTORY_T, RAW_DATA_T, PROC_DATA_T, SIM_DATA_T, EVENT_T, SIM_EVENT_T, SUMMARY_DATA_T, AUX_DATA_T, AUX_TABLE_T >::SetName |
( |
const name_type & | Name | ) |
|
|
inlineinherited |
Establish the name.
Set the project name of the frame. Values less than zero are reserved for simulated data. For experimental runs, this value is monotonicly increasing.
- Parameters
-
[in] | Name | The name to associate with the frame |
template<typename TYPE_T , typename USER_T , typename DETECT_SIM_T , typename DETECT_PROC_T , typename HISTORY_T , typename RAW_DATA_T , typename PROC_DATA_T , typename SIM_DATA_T , typename EVENT_T , typename SIM_EVENT_T , typename SUMMARY_DATA_T , typename AUX_DATA_T , typename AUX_TABLE_T >
void FrameCPP::v5::FrameH< TYPE_T, USER_T, DETECT_SIM_T, DETECT_PROC_T, HISTORY_T, RAW_DATA_T, PROC_DATA_T, SIM_DATA_T, EVENT_T, SIM_EVENT_T, SUMMARY_DATA_T, AUX_DATA_T, AUX_TABLE_T >::SetRun |
( |
run_type | Run | ) |
|
|
inlineinherited |
Establish the run number.
Set the run number of the frame. Values less than zero are reserved for simulated data. For experimental runs, this value is monotonicly increasing.
- Parameters
-
[in] | Run | The run number to associate with the frame. |
template<typename TYPE_T , typename USER_T , typename DETECT_SIM_T , typename DETECT_PROC_T , typename HISTORY_T , typename RAW_DATA_T , typename PROC_DATA_T , typename SIM_DATA_T , typename EVENT_T , typename SIM_EVENT_T , typename SUMMARY_DATA_T , typename AUX_DATA_T , typename AUX_TABLE_T >
void FrameCPP::v5::FrameH< TYPE_T, USER_T, DETECT_SIM_T, DETECT_PROC_T, HISTORY_T, RAW_DATA_T, PROC_DATA_T, SIM_DATA_T, EVENT_T, SIM_EVENT_T, SUMMARY_DATA_T, AUX_DATA_T, AUX_TABLE_T >::SetULeapS |
( |
ULeapS_type | Value | ) |
|
|
inlineinherited |
Establish leap second offset.
- Parameters
-
[in] | Value | Number of leap seconds since GPS epoc. |