ldas-tools-framecpp 2.7.0
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
FrameCPP::Version_8::FrameH Class Referenceabstract

Frame Header. More...

#include <FrameH.hh>

Inheritance diagram for FrameCPP::Version_8::FrameH:
Inheritance graph
[legend]
Collaboration diagram for FrameCPP::Version_8::FrameH:
Collaboration graph
[legend]

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 FrameHClone () 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 FrameHClone () 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_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual self_typeCreate (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 FrameHpCreate (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 FrameHpCreate (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.
 

Detailed Description

Frame Header.

Constructor & Destructor Documentation

◆ FrameH() [1/8]

FrameH::FrameH ( const FrameH frame)
Parameters
[in]frameFrame to use as the base

◆ FrameH() [2/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.

Parameters
[in]nameName of project or other experiment description
[in]runRun number (number < 0 reserved for simulated data); monotonic for experimental runs.
[in]frameFrame number, monotonically increasing until end of run, re-starting from 0 with each new run.
[in]timeFrame start time in GPS units.
[in]uLeapSThe integer number of leap seconds between GPS/TAI and UTC in the epoch when the frame is written.
[in]dtFrame length in seconds
[in]dqualData quality flag
Returns
A new instance of this object.

◆ FrameH() [3/8]

FrameH::FrameH ( const FrameHNPS Source)

Copy constructor.

Parameters
[in]SourceThe non-pointer portion of the frame header.

◆ FrameH() [4/8]

FrameH::FrameH ( const Previous::FrameH Source,
istream_type *  Stream 
)
inline

Upconvert constructor.

Parameters
[in]SourceAn instance of a similiar object from a previous version of the frame specification.
[in]StreamThe stream from which the origional object was read.

◆ FrameH() [5/8]

FrameCPP::Version_8::FrameH::FrameH ( const FrameH frame)
Parameters
[in]frameFrame to use as the base

◆ FrameH() [6/8]

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.

Parameters
[in]nameName of project or other experiment description
[in]runRun number (number < 0 reserved for simulated data); monotonic for experimental runs.
[in]frameFrame number, monotonically increasing until end of run, re-starting from 0 with each new run.
[in]timeFrame start time in GPS units.
[in]uLeapSThe integer number of leap seconds between GPS/TAI and UTC in the epoch when the frame is written.
[in]dtFrame length in seconds
[in]dqualData quality flag
Returns
A new instance of this object.

◆ FrameH() [7/8]

FrameCPP::Version_8::FrameH::FrameH ( const FrameHNPS Source)

Copy constructor.

Parameters
[in]SourceThe non-pointer portion of the frame header.

◆ FrameH() [8/8]

FrameCPP::Version_8::FrameH::FrameH ( const Previous::FrameH Source,
istream_type *  Stream 
)

Upconvert constructor.

Parameters
[in]SourceAn instance of a similiar object from a previous version of the frame specification.
[in]StreamThe stream from which the origional object was read.

Member Function Documentation

◆ assign() [1/3]

void FrameHNPS::assign ( assign_stream_type &  Stream)
protectedinherited

Assign the contents of the instance.

Parameters
[in]StreamAn input stream from which to read information for the instance.
Note
This has been hidden so programmers are not tempted to bypass usage of IFrameStream as the input stream.

◆ assign() [2/3]

void FrameH::assign ( assign_stream_type &  Stream)
protectedvirtual

Assign the contents of the instance.

Parameters
[in]StreamAn input stream from which to read information for the instance.
Note
This has been hidden so programmers are not tempted to bypass usage of IFrameStream as the input stream.

◆ assign() [3/3]

virtual void FrameCPP::Version_8::FrameH::assign ( assign_stream_type &  Stream)
protectedvirtual

Assign the contents of the instance.

Parameters
[in]StreamAn input stream from which to read information for the instance.
Note
This has been hidden so programmers are not tempted to bypass usage of IFrameStream as the input stream.

◆ bytes() [1/2]

streamsize_type FrameCPP::Version_3::FrameHNPS::bytes ( ) const
inlineprotectedinherited

Number of bytes required by this object.

Returns
The number of bytes need to read or write this object to a stream.

◆ bytes() [2/2]

streamsize_type FrameCPP::Version_3::FrameHNPS::bytes ( ) const
protectedinherited

Number of bytes required by this object.

Returns
The number of bytes need to read or write this object to a stream.

◆ Bytes() [1/2]

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::Bytes ( const StreamBase &  Stream) const
virtualinherited

Return the number of bytes for this object.

Parameters
[in]StreamStream characteristics used to determine the number of bytes needed to format the object for the Stream.
Returns
The number of bytes for this object

◆ Bytes() [2/2]

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::Bytes ( const StreamBase &  Stream) const
virtualinherited

Return the number of bytes for this object.

Parameters
[in]StreamStream characteristics used to determine the number of bytes needed to format the object for the Stream.
Returns
The number of bytes for this object

◆ Create() [1/2]

virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::Create ( istream_type &  Stream) const
virtualinherited

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.
Returns
Return pointer to the newly allocated resource.

◆ Create() [2/2]

virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::Create ( istream_type &  Stream) const
virtualinherited

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.
Returns
Return pointer to the newly allocated resource.

◆ dataDescription() [1/2]

void FrameCPP::Version_3::FrameHNPS::dataDescription ( Common::Description &  Desc)
inlinestaticprotectedinherited

Dictionary description of data.

Parameters
[out]DescThe handle to a dictionary description to which this type of object is to be added.

◆ dataDescription() [2/2]

static void FrameCPP::Version_3::FrameHNPS::dataDescription ( Common::Description &  Desc)
staticprotectedinherited

Dictionary description of data.

Parameters
[out]DescThe handle to a dictionary description to which this type of object is to be added.

◆ GetRawData() [1/4]

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
rawData_type FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::GetRawData ( )
inlineinherited

Retrieve the raw data reference.

Returns
A pointer to the raw data structure.

◆ GetRawData() [2/4]

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
rawData_type FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::GetRawData ( )
inlineinherited

Retrieve the raw data reference.

Returns
A pointer to the raw data structure.

◆ GetRawData() [3/4]

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
rawData_type FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::GetRawData ( ) const
inlineinherited

Retrieve the raw data reference.

Returns
A pointer to the raw data structure.

◆ GetRawData() [4/4]

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
rawData_type FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::GetRawData ( ) const
inlineinherited

Retrieve the raw data reference.

Returns
A pointer to the raw data structure.

◆ ObjectStructName() [1/2]

const char * FrameH::ObjectStructName ( ) const
virtual

The name structure name of this object.

Returns
The name of the structure as specified by the frame specification.

◆ ObjectStructName() [2/2]

virtual const char * FrameCPP::Version_8::FrameH::ObjectStructName ( ) const
virtual

The name structure name of this object.

Returns
The name of the structure as specified by the frame specification.

◆ operator==() [1/4]

bool FrameH::operator== ( const Common::FrameSpec::Object RHS) const
virtual

equality operator for abstract data type

Parameters
[in]RHSThe object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ operator==() [2/4]

virtual bool FrameCPP::Version_8::FrameH::operator== ( const Common::FrameSpec::Object RHS) const
virtual

equality operator for abstract data type

Parameters
[in]RHSThe object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ operator==() [3/4]

bool FrameH::operator== ( const FrameH RHS) const
inline

equality operator

Parameters
[in]RHSThe FrameH object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ operator==() [4/4]

bool FrameCPP::Version_8::FrameH::operator== ( const FrameH RHS) const

equality operator

Parameters
[in]RHSThe FrameH object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ pBytes() [1/2]

FrameCPP::cmn_streamsize_type FrameH::pBytes ( const Common::StreamBase &  Stream) const
protectedvirtual

Number of bytes needed to write this structure.

Parameters
[in]StreamThe stream from which to the object is being read or written.
Returns
The number of bytes need to read or write this object.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >.

◆ pBytes() [2/2]

cmn_streamsize_type FrameCPP::Version_8::FrameH::pBytes ( const Common::StreamBase &  Stream) const
protectedvirtual

Number of bytes needed to write this structure.

Parameters
[in]StreamThe stream from which to the object is being read or written.
Returns
The number of bytes need to read or write this object.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >.

◆ pCreate() [1/2]

FrameH * FrameH::pCreate ( istream_type &  Stream) const
protectedvirtual

Virtual constructor.

Parameters
[in]StreamThe input stream from which to read the object.
Returns
A new instance of this object.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >.

◆ pCreate() [2/2]

virtual FrameH * FrameCPP::Version_8::FrameH::pCreate ( istream_type &  Stream) const
protectedvirtual

Virtual constructor.

Parameters
[in]StreamThe input stream from which to read the object.
Returns
A new instance of this object.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >.

◆ Promote() [1/2]

FrameH::promote_ret_type FrameH::Promote ( INT_2U  Source,
promote_arg_type  Obj,
istream_type *  Stream 
)
inlinestatic

Promote previous version of object to this version.

Parameters
[in]SourceThe frame specification version of the object.
[in]ObjThe previous version of the object.
[in]StreamStream from which the origional object was created.
Returns
A new instance of FrameH based on Obj

◆ Promote() [2/2]

static promote_ret_type FrameCPP::Version_8::FrameH::Promote ( INT_2U  Source,
promote_arg_type  Obj,
istream_type *  Stream 
)
static

Promote previous version of object to this version.

Parameters
[in]SourceThe frame specification version of the object.
[in]ObjThe previous version of the object.
[in]StreamStream from which the origional object was created.
Returns
A new instance of FrameH based on Obj

◆ pWrite() [1/3]

void FrameH::pWrite ( ostream_type &  Stream) const
protectedvirtual

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.

◆ pWrite() [2/3]

virtual void FrameCPP::Version_8::FrameH::pWrite ( ostream_type &  Stream) const
protectedvirtual

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.

◆ pWrite() [3/3]

virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::pWrite ( ostream_type &  Stream) const
protectedpure virtualinherited

◆ readSubset() [1/2]

void FrameH::readSubset ( istream_type &  Stream,
INT_4U  ElementMask 
)
protectedvirtual

Limitted reading of the object.

Parameters
[in]StreamThe input stream from which to read the object.
[in]ElementMaskMask of elements to read from the Stream

◆ readSubset() [2/2]

virtual void FrameCPP::Version_8::FrameH::readSubset ( istream_type &  Stream,
INT_4U  ElementMask 
)
protectedvirtual

Limitted reading of the object.

Parameters
[in]StreamThe input stream from which to read the object.
[in]ElementMaskMask of elements to read from the Stream

◆ SetULeapS() [1/2]

void FrameCPP::Version_3::FrameHNPS::SetULeapS ( ULeapS_type  Value)
inlineinherited

Establish leap second offset.

Set the number of leap seconds since GPS epoc.

Parameters
[in]ValueNumber of leap seconds since GPS epoc.

◆ SetULeapS() [2/2]

void FrameCPP::Version_3::FrameHNPS::SetULeapS ( ULeapS_type  Value)
inherited

Establish leap second offset.

Parameters
[in]ValueNumber of leap seconds since GPS epoc.

◆ StructDescription() [1/2]

const Description * FrameH::StructDescription ( )
static

The description of structure.

Returns
A Description object which describes this structure as specified by the frame specification.

◆ StructDescription() [2/2]

static const Common::Description * FrameCPP::Version_8::FrameH::StructDescription ( )
static

The description of structure.

Returns
A Description object which describes this structure as specified by the frame specification.

◆ StructName() [1/2]

const char * FrameH::StructName ( )
inlinestatic

The name structure name of this object.

Returns
The name of the structure as specified by the frame specification.

◆ StructName() [2/2]

static const char * FrameCPP::Version_8::FrameH::StructName ( )
static

The name structure name of this object.

Returns
The name of the structure as specified by the frame specification.

◆ VerifyObject() [1/2]

void FrameH::VerifyObject ( Common::Verify &  Verifier,
Common::IFrameStream &  Stream 
) const
protectedvirtual

Verify the object as being valid.

Parameters
[in]VerifierThe instance of the Verify object where state information is stored.
[in]StreamThe input stream from which the object is being read.

◆ VerifyObject() [2/2]

virtual void FrameCPP::Version_8::FrameH::VerifyObject ( Common::Verify &  Verifier,
Common::IFrameStream &  Stream 
) const
protectedvirtual

Verify the object as being valid.

Parameters
[in]VerifierThe instance of the Verify object where state information is stored.
[in]StreamThe input stream from which the object is being read.

Member Data Documentation

◆ frame

frame_type FrameCPP::Version_3::FrameHNPS::frame
protectedinherited

Frame number.

This value is monotonically increasing until the end of the run.

◆ GTime

GTime_type FrameCPP::Version_3::FrameHNPS::GTime
protectedinherited

Frame start time.

The GPS time since GPS standard epoch.

◆ localTime

localTime_type FrameCPP::Version_3::FrameHNPS::localTime
protectedinherited

Local seasonal time.

UTC in seconds [integer multiple of 1800 seconds].

◆ name

name_type FrameCPP::Version_3::FrameHNPS::name
protectedinherited

Name of project or other experiment description.

Name of project or other experiment description. (e.g., GEO; LIGO; VIRGO; TAMA; ...)

◆ ULeapS

ULeapS_type FrameCPP::Version_3::FrameHNPS::ULeapS
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].


The documentation for this class was generated from the following files: