ldas-tools-framecpp 2.8.1
|
Event data. More...
#include <FrameH.hh>
Inherits FrameCPP::Version_8::FrameHImpl::ClassicIO< T >, FrameCPP::Version_8::FrameHImpl::ClassicIO< T >, and FrameCPP::Version_8::FrameHImpl::ClassicIO< T >.
Public Member Functions | |
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. More... | |
FrameH (const FrameH &frame) | |
Copy Constructor. More... | |
FrameH (const Previous::FrameH &Source, istream_type *Stream) | |
Upconvert constructor. More... | |
virtual FrameH * | Clone () const |
Virtual constructor. | |
virtual bool | operator== (const Common::FrameSpec::Object &Obj) const |
equality operator More... | |
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. More... | |
FrameH (const FrameH &frame) | |
Copy Constructor. More... | |
FrameH (const Previous::FrameH &Source, istream_type *Stream) | |
Upconvert constructor. More... | |
virtual FrameH * | Clone () const |
Virtual constructor. | |
virtual bool | operator== (const Common::FrameSpec::Object &Obj) const |
equality operator More... | |
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. More... | |
FrameH (const FrameH &frame) | |
Copy Constructor. More... | |
FrameH (const Previous::FrameH &Source, istream_type *Stream) | |
Upconvert constructor. More... | |
virtual FrameH * | Clone () const |
Virtual constructor. | |
virtual bool | operator== (const Common::FrameSpec::Object &Obj) const |
equality operator More... | |
virtual const char * | ObjectStructName () const |
The name structure name of this object. More... | |
virtual const char * | ObjectStructName () const |
The name structure name of this object. More... | |
virtual const char * | ObjectStructName () const |
The name structure name of this object. More... | |
const name_type & | GetName () const |
Retrieve name of project. More... | |
const name_type & | GetName () const |
Retrieve name of project. More... | |
const name_type & | GetName () const |
Retrieve name of project. More... | |
run_type | GetRun () const |
Run number. More... | |
run_type | GetRun () const |
Run number. More... | |
run_type | GetRun () const |
Run number. More... | |
frame_type | GetFrame () const |
Frame number. More... | |
frame_type | GetFrame () const |
Frame number. More... | |
frame_type | GetFrame () const |
Frame number. More... | |
dataQuality_type | GetDataQuality () const |
Data quality flag. More... | |
dataQuality_type | GetDataQuality () const |
Data quality flag. More... | |
dataQuality_type | GetDataQuality () const |
Data quality flag. More... | |
const GTime_type & | GetGTime () const |
Start Time. More... | |
const GTime_type & | GetGTime () const |
Start Time. More... | |
const GTime_type & | GetGTime () const |
Start Time. More... | |
ULeapS_type | GetULeapS () const |
Leap seconds. More... | |
ULeapS_type | GetULeapS () const |
Leap seconds. More... | |
ULeapS_type | GetULeapS () const |
Leap seconds. More... | |
dt_type | GetDt () const |
Frame length. More... | |
dt_type | GetDt () const |
Frame length. More... | |
dt_type | GetDt () const |
Frame length. More... | |
void | SetName (const name_type &Name) |
Establish the name. More... | |
void | SetName (const name_type &Name) |
Establish the name. More... | |
void | SetName (const name_type &Name) |
Establish the name. More... | |
void | SetRun (run_type Run) |
Establish the run number. More... | |
void | SetRun (run_type Run) |
Establish the run number. More... | |
void | SetRun (run_type Run) |
Establish the run number. More... | |
void | SetDataQuality (dataQuality_type DataQuality) |
Establish the data quality flag. More... | |
void | SetDataQuality (dataQuality_type DataQuality) |
Establish the data quality flag. More... | |
void | SetDataQuality (dataQuality_type DataQuality) |
Establish the data quality flag. More... | |
void | SetDt (dt_type Dt) |
Establish the frame duration. More... | |
void | SetDt (dt_type Dt) |
Establish the frame duration. More... | |
void | SetDt (dt_type Dt) |
Establish the frame duration. More... | |
void | SetGTime (const GTime_type >ime) |
Establish the start time. More... | |
void | SetGTime (const GTime_type >ime) |
Establish the start time. More... | |
void | SetGTime (const GTime_type >ime) |
Establish the start time. More... | |
void | SetULeapS (ULeapS_type Value) |
Establish leap second offset. More... | |
void | SetULeapS (ULeapS_type Value) |
Establish leap second offset. More... | |
void | SetULeapS (ULeapS_type Value) |
Establish leap second offset. More... | |
rawData_type | GetRawData () const |
Retrieve the raw data reference. More... | |
rawData_type | GetRawData () |
Retrieve the raw data reference. More... | |
rawData_type | GetRawData () const |
Retrieve the raw data reference. More... | |
rawData_type | GetRawData () |
Retrieve the raw data reference. More... | |
rawData_type | GetRawData () const |
Retrieve the raw data reference. More... | |
rawData_type | GetRawData () |
Retrieve the raw data reference. More... | |
virtual streamsize_type | Bytes (const StreamBase &Stream) const |
Return the number of bytes for this object. More... | |
virtual streamsize_type | Bytes (const StreamBase &Stream) const |
Return the number of bytes for this object. More... | |
virtual streamsize_type | Bytes (const StreamBase &Stream) const |
Return the number of bytes for this object. More... | |
virtual self_type * | Create (istream_type &Stream) const |
Virtual constructor. More... | |
virtual self_type * | Create (istream_type &Stream) const |
Virtual constructor. More... | |
virtual self_type * | Create (istream_type &Stream) const |
Virtual constructor. More... | |
virtual void | Write (ostream_type &Stream) const |
Write object to the stream. | |
virtual void | Write (ostream_type &Stream) const |
Write object to the stream. | |
virtual void | Write (ostream_type &Stream) const |
Write object to the stream. | |
Static Public Member Functions | |
static promote_ret_type | Promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream) |
Promote previous version of object to this version. More... | |
static promote_ret_type | Promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream) |
Promote previous version of object to this version. More... | |
static promote_ret_type | Promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream) |
Promote previous version of object to this version. More... | |
static const Common::Description * | StructDescription () |
The description of structure. More... | |
static const Common::Description * | StructDescription () |
The description of structure. More... | |
static const Common::Description * | StructDescription () |
The description of structure. More... | |
static struct_desc_type | FrameSpecDescription () |
Return the dictionary name of the structure. | |
static struct_desc_type | FrameSpecDescription () |
Return the dictionary name of the structure. | |
static struct_desc_type | FrameSpecDescription () |
Return the dictionary name of the structure. | |
static struct_id_type | FrameSpecId () |
Return the dictionary name of the structure. | |
static struct_id_type | FrameSpecId () |
Return the dictionary name of the structure. | |
static struct_id_type | FrameSpecId () |
Return the dictionary name of the 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 * | 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 const char * | CheckSumDataComment () |
Comment to be used in comment field of FrSE. | |
Protected Member Functions | |
virtual void | assign (assign_stream_type &Stream) |
Assign the contents of the instance. More... | |
virtual void | assign (assign_stream_type &Stream) |
Assign the contents of the instance. More... | |
virtual void | assign (assign_stream_type &Stream) |
Assign the contents of the instance. More... | |
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 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. | |
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. More... | |
cmn_streamsize_type | pBytes (const Common::StreamBase &Stream) const |
Number of bytes needed to write this structure. More... | |
cmn_streamsize_type | pBytes (const Common::StreamBase &Stream) const |
Number of bytes needed to write this structure. More... | |
virtual self_type * | pCreate (istream_type &Stream) const |
Virtual constructor. More... | |
virtual self_type * | pCreate (istream_type &Stream) const |
Virtual constructor. More... | |
virtual self_type * | pCreate (istream_type &Stream) const |
Virtual constructor. More... | |
virtual void | pWrite (ostream_type &Stream) const |
Write the structure to the stream. More... | |
virtual void | pWrite (ostream_type &Stream) const |
Write the structure to the stream. More... | |
virtual void | pWrite (ostream_type &Stream) const |
Write the structure to the stream. More... | |
virtual void | readSubset (istream_type &Stream, INT_4U ElementMask) |
Limitted reading of the object. More... | |
virtual void | readSubset (istream_type &Stream, INT_4U ElementMask) |
Limitted reading of the object. More... | |
virtual void | readSubset (istream_type &Stream, INT_4U ElementMask) |
Limitted reading of the object. More... | |
virtual void | vTOCQuery (int InfoClass, va_list vl) const |
Answer requests for information as needed by TOC. More... | |
virtual void | vTOCQuery (int InfoClass, va_list vl) const |
Answer requests for information as needed by TOC. More... | |
virtual void | vTOCQuery (int InfoClass, va_list vl) const |
Answer requests for information as needed by TOC. More... | |
Event data.
FrameCPP::Version_8::FrameH::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.
[in] | name | Name of project or other experiment description |
[in] | run | Run number (number < 0 reserved for simulated data); monotonic for experimental runs. |
[in] | frame | Frame number, monotonically increasing until end of run, re-starting from 0 with each new run. |
[in] | time | Frame start time in GPS units. |
[in] | uLeapS | The integer number of leap seconds between GPS/TAI and UTC in the epoch when the frame is written. |
[in] | dt | Frame length in seconds |
[in] | dqual | Data quality flag |
FrameCPP::Version_8::FrameH::FrameH | ( | const FrameH & | frame | ) |
Copy Constructor.
[in] | frame | Frame to use as the base |
FrameCPP::Version_8::FrameH::FrameH | ( | const Previous::FrameH & | Source, |
istream_type * | Stream | ||
) |
Upconvert constructor.
[in] | Source | An instance of a similiar object from a previous version of the frame specification. |
[in] | Stream | The stream from which the origional object was read. |
FrameCPP::Version_8::FrameH::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.
[in] | name | Name of project or other experiment description |
[in] | run | Run number (number < 0 reserved for simulated data); monotonic for experimental runs. |
[in] | frame | Frame number, monotonically increasing until end of run, re-starting from 0 with each new run. |
[in] | time | Frame start time in GPS units. |
[in] | uLeapS | The integer number of leap seconds between GPS/TAI and UTC in the epoch when the frame is written. |
[in] | dt | Frame length in seconds |
[in] | dqual | Data quality flag |
FrameCPP::Version_8::FrameH::FrameH | ( | const FrameH & | frame | ) |
Copy Constructor.
[in] | frame | Frame to use as the base |
FrameCPP::Version_8::FrameH::FrameH | ( | const Previous::FrameH & | Source, |
istream_type * | Stream | ||
) |
Upconvert constructor.
[in] | Source | An instance of a similiar object from a previous version of the frame specification. |
[in] | Stream | The stream from which the origional object was read. |
FrameCPP::Version_8::FrameH::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.
[in] | name | Name of project or other experiment description |
[in] | run | Run number (number < 0 reserved for simulated data); monotonic for experimental runs. |
[in] | frame | Frame number, monotonically increasing until end of run, re-starting from 0 with each new run. |
[in] | time | Frame start time in GPS units. |
[in] | uLeapS | The integer number of leap seconds between GPS/TAI and UTC in the epoch when the frame is written. |
[in] | dt | Frame length in seconds |
[in] | dqual | Data quality flag |
FrameCPP::Version_8::FrameH::FrameH | ( | const FrameH & | frame | ) |
Copy Constructor.
[in] | frame | Frame to use as the base |
FrameCPP::Version_8::FrameH::FrameH | ( | const Previous::FrameH & | Source, |
istream_type * | Stream | ||
) |
Upconvert constructor.
[in] | Source | An instance of a similiar object from a previous version of the frame specification. |
[in] | Stream | The stream from which the origional object was read. |
|
inlineprotectedvirtualinherited |
Assign the contents of the instance.
[in] | Stream | An input stream from which to read information for the instance. |
|
inlineprotectedvirtualinherited |
Assign the contents of the instance.
[in] | Stream | An input stream from which to read information for the instance. |
|
inlineprotectedvirtualinherited |
Assign the contents of the instance.
[in] | Stream | An input stream from which to read information for the instance. |
|
virtualinherited |
Return the number of bytes for this object.
[in] | Stream | Stream characteristics used to determine the number of bytes needed to format the object for the Stream. |
|
virtualinherited |
Return the number of bytes for this object.
[in] | Stream | Stream characteristics used to determine the number of bytes needed to format the object for the Stream. |
|
virtualinherited |
Return the number of bytes for this object.
[in] | Stream | Stream characteristics used to determine the number of bytes needed to format the object for the Stream. |
|
virtualinherited |
Virtual constructor.
[in] | Stream | The input stream from where the object is being read. |
|
virtualinherited |
Virtual constructor.
[in] | Stream | The input stream from where the object is being read. |
|
virtualinherited |
Virtual constructor.
[in] | Stream | The input stream from where the object is being read. |
|
inlineinherited |
Data quality flag.
Retrieve the data quality flag associated with the frame.
|
inherited |
Data quality flag.
|
inherited |
Data quality flag.
|
inlineinherited |
Frame length.
Retrieve the duration of the frame in seconds.
|
inherited |
Frame length.
|
inherited |
Frame length.
|
inlineinherited |
Frame number.
Retrieve the frame number associated with the frame.
|
inherited |
Frame number.
|
inherited |
Frame number.
|
inlineinherited |
Start Time.
Retrieve the start time of the frame.
|
inherited |
Start Time.
|
inherited |
Start Time.
|
inlineinherited |
Retrieve name of project.
Retrieve the name of project or other experiment description.
|
inherited |
Retrieve name of project.
|
inherited |
Retrieve name of project.
|
inlineinherited |
Retrieve the raw data reference.
|
inlineinherited |
Retrieve the raw data reference.
|
inlineinherited |
Retrieve the raw data reference.
|
inlineinherited |
Retrieve the raw data reference.
|
inlineinherited |
Retrieve the raw data reference.
|
inlineinherited |
Retrieve the raw data reference.
|
inlineinherited |
Run number.
Retrieve the run number associated with the frame.
|
inherited |
Run number.
|
inherited |
Run number.
|
inlineinherited |
Leap seconds.
Retrieve the number of leap seconds associated with the frame.
|
inherited |
Leap seconds.
|
inherited |
Leap seconds.
|
inlinevirtualinherited |
The name structure name of this object.
|
inlinevirtualinherited |
The name structure name of this object.
|
inlinevirtualinherited |
The name structure name of this object.
|
virtual |
equality operator
[in] | RHS | The FrameH object to be compared. |
|
virtual |
equality operator
[in] | RHS | The FrameH object to be compared. |
|
virtual |
equality operator
[in] | RHS | The FrameH object to be compared. |
|
inlineprotectedinherited |
Number of bytes needed to write this structure.
[in] | Stream | The stream from which to the object is being read or written. |
|
inlineprotectedinherited |
Number of bytes needed to write this structure.
[in] | Stream | The stream from which to the object is being read or written. |
|
inlineprotectedinherited |
Number of bytes needed to write this structure.
[in] | Stream | The stream from which to the object is being read or written. |
|
inlineprotectedvirtualinherited |
Virtual constructor.
[in] | Stream | The input stream from which to read the object. |
|
inlineprotectedvirtualinherited |
Virtual constructor.
[in] | Stream | The input stream from which to read the object. |
|
inlineprotectedvirtualinherited |
Virtual constructor.
[in] | Stream | The input stream from which to read the object. |
|
inlinestaticinherited |
Promote previous version of object to this version.
[in] | Source | The frame specification version of the object. |
[in] | Obj | The previous version of the object. |
[in] | Stream | Stream from which the origional object was created. |
|
inlinestaticinherited |
Promote previous version of object to this version.
[in] | Source | The frame specification version of the object. |
[in] | Obj | The previous version of the object. |
[in] | Stream | Stream from which the origional object was created. |
|
inlinestaticinherited |
Promote previous version of object to this version.
[in] | Source | The frame specification version of the object. |
[in] | Obj | The previous version of the object. |
[in] | Stream | Stream from which the origional object was created. |
|
inlineprotectedvirtualinherited |
Write the structure to the stream.
[in] | Stream | The output stream where the object is to be written. |
|
inlineprotectedvirtualinherited |
Write the structure to the stream.
[in] | Stream | The output stream where the object is to be written. |
|
inlineprotectedvirtualinherited |
Write the structure to the stream.
[in] | Stream | The output stream where the object is to be written. |
|
inlineprotectedvirtualinherited |
Limitted reading of the object.
[in] | Stream | The input stream from which to read the object. |
[in] | ElementMask | Mask of elements to read from the Stream |
|
inlineprotectedvirtualinherited |
Limitted reading of the object.
[in] | Stream | The input stream from which to read the object. |
[in] | ElementMask | Mask of elements to read from the Stream |
|
inlineprotectedvirtualinherited |
Limitted reading of the object.
[in] | Stream | The input stream from which to read the object. |
[in] | ElementMask | Mask of elements to read from the Stream |
|
inlineinherited |
Establish the data quality flag.
Set the data quality flag of the frame.
[in] | DataQuality | The value of the data quality flag. |
|
inherited |
Establish the data quality flag.
[in] | DataQuality | The value of the data quality flag. |
|
inherited |
Establish the data quality flag.
[in] | DataQuality | The value of the data quality flag. |
|
inlineinherited |
Establish the frame duration.
Set the length of the frame in seconds.
[in] | Dt | The length of the frame in seconds |
|
inherited |
Establish the frame duration.
[in] | Dt | The length of the frame in seconds |
|
inherited |
Establish the frame duration.
[in] | Dt | The length of the frame in seconds |
|
inlineinherited |
Establish the start time.
Set the start time of the frame.
[in] | GTime | The start time of the frame. |
|
inherited |
Establish the start time.
[in] | GTime | The start time of the frame. |
|
inherited |
Establish the start time.
[in] | GTime | The start time of the frame. |
|
inherited |
Establish the name.
[in] | Name | The name to associate with the frame |
|
inherited |
Establish the name.
[in] | Name | The name to associate with the frame |
|
inherited |
Establish the name.
[in] | Name | The name to associate with the frame |
|
inlineinherited |
Establish the run number.
[in] | Run | The run number to associate with the frame. |
Set the run number of the frame. Values less than zero are reserved for simulated data. For experimental runs, this value is monotonicly increasing.
|
inherited |
Establish the run number.
[in] | Run | The run number to associate with the frame. |
|
inherited |
Establish the run number.
[in] | Run | The run number to associate with the frame. |
|
inlineinherited |
Establish leap second offset.
Set the number of leap seconds since GPS epoc.
[in] | Value | Number of leap seconds since GPS epoc. |
|
inherited |
Establish leap second offset.
[in] | Value | Number of leap seconds since GPS epoc. |
|
inherited |
Establish leap second offset.
[in] | Value | Number of leap seconds since GPS epoc. |
|
inlinestaticinherited |
The description of structure.
|
inlinestaticinherited |
The description of structure.
|
inlinestaticinherited |
The description of structure.
|
protectedvirtualinherited |
Answer requests for information as needed by TOC.
[in] | InfoClass | Class of information being requested. |
[in] | vl | Variable argument list of requested data. |
|
protectedvirtualinherited |
Answer requests for information as needed by TOC.
[in] | InfoClass | Class of information being requested. |
[in] | vl | Variable argument list of requested data. |
|
protectedvirtualinherited |
Answer requests for information as needed by TOC.
[in] | InfoClass | Class of information being requested. |
[in] | vl | Variable argument list of requested data. |