ldas-tools-framecpp 2.7.0
|
Frame Header. More...
#include <FrameH.hh>
Public Member Functions | |
FrameH () | |
Default constructor. | |
FrameH (const FrameH &frame) | |
FrameH (const std::string &name, INT_4S run, INT_4U frame, const GPSTime &time, INT_2U uLeapS, const REAL_8 dt, INT_4U dqual=0) | |
Explicate construction. | |
FrameH (const FrameHNPS &Source) | |
Copy constructor. | |
FrameH (const Previous::FrameH &Source, istream_type *Stream) | |
Upconvert constructor. | |
~FrameH () | |
Destructor. | |
virtual FrameH * | Clone () const |
Virtual constructor. | |
virtual const char * | ObjectStructName () const |
The name structure name of this object. | |
bool | operator== (const FrameH &RHS) const |
equality operator | |
virtual bool | operator== (const Common::FrameSpec::Object &RHS) const |
equality operator for abstract data type | |
FrameH () | |
Default constructor. | |
FrameH (const FrameH &frame) | |
FrameH (const std::string &name, INT_4S run, INT_4U frame, const GPSTime &time, INT_2U uLeapS, const REAL_8 dt, INT_4U dqual=0) | |
Explicate construction. | |
FrameH (const FrameHNPS &Source) | |
Copy constructor. | |
FrameH (const Previous::FrameH &Source, istream_type *Stream) | |
Upconvert constructor. | |
~FrameH () | |
Destructor. | |
virtual FrameH * | Clone () const |
Virtual constructor. | |
virtual const char * | ObjectStructName () const |
The name structure name of this object. | |
bool | operator== (const FrameH &RHS) const |
equality operator | |
virtual bool | operator== (const Common::FrameSpec::Object &RHS) const |
equality operator for abstract data type | |
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. | |
void | SetULeapS (ULeapS_type Value) |
Establish leap second offset. | |
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. | |
rawData_type | GetRawData () const |
Retrieve the raw data reference. | |
rawData_type | GetRawData () |
Retrieve the raw data reference. | |
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. | |
static const char * | StructName () |
The name structure name of this object. | |
static const Common::Description * | StructDescription () |
The description of structure. | |
static promote_ret_type | Promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream) |
Promote previous version of object to this version. | |
static const char * | StructName () |
The name structure name of this object. | |
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. | |
Protected Member Functions | |
virtual void | assign (assign_stream_type &Stream) |
Assign the contents of the instance. | |
virtual void | readSubset (istream_type &Stream, INT_4U ElementMask) |
Limitted reading of the object. | |
virtual start_time_normalized_type | normalizedStartTime () const |
Frame start time in seconds. | |
virtual delta_t_normalized_type | normalizedDeltaT () const |
Duration of the frame. | |
cmn_streamsize_type | pBytes (const Common::StreamBase &Stream) const |
Number of bytes needed to write this structure. | |
virtual FrameH * | pCreate (istream_type &Stream) const |
Virtual constructor. | |
virtual void | pWrite (ostream_type &Stream) const |
Write the structure to the stream. | |
virtual void | VerifyObject (Common::Verify &Verifier, Common::IFrameStream &Stream) const |
Verify the object as being valid. | |
virtual void | assign (assign_stream_type &Stream) |
Assign the contents of the instance. | |
virtual void | readSubset (istream_type &Stream, INT_4U ElementMask) |
Limitted reading of the object. | |
virtual start_time_normalized_type | normalizedStartTime () const |
Frame start time in seconds. | |
virtual delta_t_normalized_type | normalizedDeltaT () const |
Duration of the frame. | |
cmn_streamsize_type | pBytes (const Common::StreamBase &Stream) const |
Number of bytes needed to write this structure. | |
virtual FrameH * | pCreate (istream_type &Stream) const |
Virtual constructor. | |
virtual void | pWrite (ostream_type &Stream) const |
Write the structure to the stream. | |
virtual void | VerifyObject (Common::Verify &Verifier, Common::IFrameStream &Stream) const |
Verify the object as being valid. | |
virtual void | pWrite (ostream_type &Stream) const=0 |
Write the structure to the stream. | |
void | assign (assign_stream_type &Stream) |
Assign the contents of the instance. | |
streamsize_type | bytes () const |
Number of bytes required by this object. | |
streamsize_type | bytes () const |
Number of bytes required by this object. | |
Static Protected Member Functions | |
static void | dataDescription (Common::Description &Desc) |
Dictionary description of data. | |
static void | dataDescription (Common::Description &Desc) |
Dictionary description of data. | |
Protected Attributes | |
name_type | name |
Name of project or other experiment description. | |
run_type | run |
Run number. | |
frame_type | frame |
Frame number. | |
GTime_type | GTime |
Frame start time. | |
ULeapS_type | ULeapS |
The number of leap seconds. | |
localTime_type | localTime |
Local seasonal time. | |
dt_type | dt |
Frame length in seconds. | |
Frame Header.
FrameH::FrameH | ( | const FrameH & | frame | ) |
[in] | frame | Frame to use as the base |
FrameH::FrameH | ( | const std::string & | name, |
INT_4S | run, | ||
INT_4U | frame, | ||
const GPSTime & | time, | ||
INT_2U | uLeapS, | ||
const REAL_8 | dt, | ||
INT_4U | 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 |
FrameH::FrameH | ( | const FrameHNPS & | Source | ) |
Copy constructor.
[in] | Source | The non-pointer portion of the frame header. |
|
inline |
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 FrameH & | frame | ) |
[in] | frame | Frame to use as the base |
FrameCPP::Version_8::FrameH::FrameH | ( | const std::string & | name, |
INT_4S | run, | ||
INT_4U | frame, | ||
const GPSTime & | time, | ||
INT_2U | uLeapS, | ||
const REAL_8 | dt, | ||
INT_4U | 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 FrameHNPS & | Source | ) |
Copy constructor.
[in] | Source | The non-pointer portion of the frame header. |
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. |
|
protectedinherited |
Assign the contents of the instance.
[in] | Stream | An input stream from which to read information for the instance. |
|
protectedvirtual |
Assign the contents of the instance.
[in] | Stream | An input stream from which to read information for the instance. |
|
protectedvirtual |
Assign the contents of the instance.
[in] | Stream | An input stream from which to read information for the instance. |
|
inlineprotectedinherited |
Number of bytes required by this object.
|
protectedinherited |
Number of bytes required by this object.
|
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. |
|
inlinestaticprotectedinherited |
Dictionary description of data.
[out] | Desc | The handle to a dictionary description to which this type of object is to be added. |
|
staticprotectedinherited |
Dictionary description of data.
[out] | Desc | The handle to a dictionary description to which this type of object is to be added. |
|
inlineinherited |
Retrieve the raw data reference.
|
inlineinherited |
Retrieve the raw data reference.
|
inlineinherited |
Retrieve the raw data reference.
|
inlineinherited |
Retrieve the raw data reference.
|
virtual |
The name structure name of this object.
|
virtual |
The name structure name of this object.
|
virtual |
equality operator for abstract data type
[in] | RHS | The object to be compared. |
|
virtual |
equality operator for abstract data type
[in] | RHS | The object to be compared. |
|
inline |
equality operator
[in] | RHS | The FrameH object to be compared. |
bool FrameCPP::Version_8::FrameH::operator== | ( | const FrameH & | RHS | ) | const |
equality operator
[in] | RHS | The FrameH object to be compared. |
|
protectedvirtual |
Number of bytes needed to write this structure.
[in] | Stream | The stream from which to the object is being read or written. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >.
|
protectedvirtual |
Number of bytes needed to write this structure.
[in] | Stream | The stream from which to the object is being read or written. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >.
|
protectedvirtual |
Virtual constructor.
[in] | Stream | The input stream from which to read the object. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >.
|
protectedvirtual |
Virtual constructor.
[in] | Stream | The input stream from which to read the object. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >.
|
inlinestatic |
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. |
|
static |
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. |
|
protectedvirtual |
Write the structure to the stream.
[in] | Stream | The output stream where the object is to be written. |
|
protectedvirtual |
Write the structure to the stream.
[in] | Stream | The output stream where the object is to be written. |
|
protectedpure virtualinherited |
Write the structure to the stream.
[in] | Stream | The output stream where the object is to be written. |
Implemented in FrameCPP::Version_8::FrRawData, FrameCPP::Version_8::FrSE, FrameCPP::Version_8::FrSerData, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSimData, FrameCPP::Version_8::FrSimEvent, FrameCPP::Version_8::FrSummary, FrameCPP::Version_8::FrTable, FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrVect, FrameCPP::Version_8::FrRawData, FrameCPP::Version_8::FrSE, FrameCPP::Version_8::FrSerData, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSimData, FrameCPP::Version_8::FrSimEvent, FrameCPP::Version_8::FrSummary, FrameCPP::Version_8::FrTable, FrameCPP::Version_8::FrTOC, and FrameCPP::Version_8::FrVect.
|
protectedvirtual |
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 |
|
protectedvirtual |
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 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. |
|
static |
The description of structure.
|
static |
The description of structure.
|
inlinestatic |
The name structure name of this object.
|
static |
The name structure name of this object.
|
protectedvirtual |
Verify the object as being valid.
[in] | Verifier | The instance of the Verify object where state information is stored. |
[in] | Stream | The input stream from which the object is being read. |
|
protectedvirtual |
Verify the object as being valid.
[in] | Verifier | The instance of the Verify object where state information is stored. |
[in] | Stream | The input stream from which the object is being read. |
|
protectedinherited |
Frame number.
This value is monotonically increasing until the end of the run.
|
protectedinherited |
Frame start time.
The GPS time since GPS standard epoch.
|
protectedinherited |
Local seasonal time.
UTC in seconds [integer multiple of 1800 seconds].
|
protectedinherited |
Name of project or other experiment description.
Name of project or other experiment description. (e.g., GEO; LIGO; VIRGO; TAMA; ...)
|
protectedinherited |
The number of leap seconds.
The integer number of leap seconds between GPS\/TAI and UTC in the epoch when the frame is written: ULeapS = Int[TAI - UTC].