ldas-tools-framecpp 2.9.2
Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
FrameCPP::Version_3::FrameH Class Referenceabstract

FrameH Data Structure Definition. More...

#include <FrameH.hh>

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

Public Member Functions

 FrameH ()
 Default constructor. More...
 
streamsize_type Bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
 
virtual FrameHClone () const
 Virtual constructor.
 
virtual FrameHCreate (istream_type &Stream) const
 constructor - virtual
 
virtual const char * ObjectStructName () const
 Retrieve the class name of the object. More...
 
virtual void Write (ostream_type &Stream) const
 Write the structure to the stream.
 
bool operator== (const FrameH &RHS) const
 comparison operator
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 comparison operator
 
 FrameH ()
 Default constructor.
 
streamsize_type Bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
 
virtual FrameHClone () const
 Virtual constructor.
 
virtual FrameHCreate (istream_type &Stream) const
 constructor - virtual
 
virtual const char * ObjectStructName () const
 Retrieve the class name of the object. More...
 
virtual void Write (ostream_type &Stream) const
 Write the structure to the stream.
 
bool operator== (const FrameH &RHS) const
 comparison operator
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 comparison operator
 
 FrameH ()
 Default constructor.
 
streamsize_type Bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
 
virtual FrameHClone () const
 Virtual constructor.
 
virtual FrameHCreate (istream_type &Stream) const
 constructor - virtual
 
virtual const char * ObjectStructName () const
 Retrieve the class name of the object. More...
 
virtual void Write (ostream_type &Stream) const
 Write the structure to the stream.
 
bool operator== (const FrameH &RHS) const
 comparison operator
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 comparison operator
 
class_type GetClass () const
 Retrieve the class identifier. More...
 
class_type GetClass () const
 Retrieve the class identifier. More...
 
class_type GetClass () const
 Retrieve the class identifier. More...
 
const Description * GetDescription () const
 Retrieve FrSH/FrSE description of the parent object. More...
 
const Description * GetDescription () const
 Retrieve FrSH/FrSE description of the parent object. More...
 
const Description * GetDescription () const
 Retrieve FrSH/FrSE description of the parent object. More...
 
ostream_type & WriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream. More...
 
ostream_type & WriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream. More...
 
ostream_type & WriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream. More...
 
virtual ObjectCreate () const
 constructor - virtual
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
 
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...
 

Static Public Member Functions

static object_type DemoteObject (frame_spec_version_type Target, object_type Obj, istream_type *Stream)
 Down grade an object. More...
 
static object_type DemoteObject (frame_spec_version_type Target, object_type Obj, istream_type *Stream)
 Down grade an object. More...
 
static object_type DemoteObject (frame_spec_version_type Target, object_type Obj, istream_type *Stream)
 Down grade an object. More...
 
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
 Upgrade an object. More...
 
template<typename PreviousType , typename CurrentType >
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
 Upgrade an object. More...
 
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
 Upgrade an object. More...
 
template<typename PreviousType , typename CurrentType >
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
 Upgrade an object. More...
 
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
 Upgrade an object. More...
 
template<typename PreviousType , typename CurrentType >
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
 Upgrade an object. More...
 

Protected Member Functions

virtual void VerifyObject (Common::Verify &Verifier, Common::IFrameStream &Stream) const
 Verify the object as being valid. More...
 
virtual start_time_normalized_type normalizedStartTime () const
 Frame start time in seconds.
 
virtual delta_t_normalized_type normalizedDeltaT () const
 Duration of the frame.
 
virtual void assign (assign_stream_type &Stream)
 Assign the contents of the instance. More...
 
virtual void VerifyObject (Common::Verify &Verifier, Common::IFrameStream &Stream) const
 Verify the object as being valid. More...
 
virtual start_time_normalized_type normalizedStartTime () const
 Frame start time in seconds.
 
virtual delta_t_normalized_type normalizedDeltaT () const
 Duration of the frame.
 
virtual void assign (assign_stream_type &Stream)
 Assign the contents of the instance. More...
 
virtual void VerifyObject (Common::Verify &Verifier, Common::IFrameStream &Stream) const
 Verify the object as being valid. More...
 
virtual start_time_normalized_type normalizedStartTime () const
 Frame start time in seconds.
 
virtual delta_t_normalized_type normalizedDeltaT () const
 Duration of the frame.
 
virtual void assign (assign_stream_type &Stream)
 Assign the contents of the instance. More...
 
virtual class_type getClass () const
 Retrieve the class identifier.
 
virtual class_type getClass () const
 Retrieve the class identifier.
 
virtual class_type getClass () const
 Retrieve the class identifier.
 
virtual demote_ret_type demote (frame_spec_version_type Target, demote_arg_type Obj, istream_type *Stream) const =0
 Demotes object to previous version of the frame spec. More...
 
virtual promote_ret_type promote (frame_spec_version_type Target, promote_arg_type Obj, istream_type *Stream) const =0
 Promotes object to another version of the frame spec. More...
 
streamsize_type bytes () const
 Number of bytes required by this object. More...
 
streamsize_type bytes () const
 Number of bytes required by this object. More...
 
streamsize_type bytes () const
 Number of bytes required by this object. More...
 

Static Protected Member Functions

static void dataDescription (Common::Description &Desc)
 Dictionary description of data. More...
 
static void dataDescription (Common::Description &Desc)
 Dictionary description of data. More...
 
static void dataDescription (Common::Description &Desc)
 Dictionary description of data. More...
 

Protected Attributes

name_type name
 Name of project or other experiment description. More...
 
run_type run
 Run number.
 
frame_type frame
 Frame number. More...
 
GTime_type GTime
 Frame start time. More...
 
ULeapS_type ULeapS
 The number of leap seconds. More...
 
localTime_type localTime
 Local seasonal time. More...
 
dt_type dt
 Frame length in seconds.
 

Detailed Description

FrameH Data Structure Definition.

Constructor & Destructor Documentation

◆ FrameH()

FrameH::FrameH ( )

Default constructor.

Allocate resources using default values.

Member Function Documentation

◆ assign() [1/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() [2/3]

virtual void FrameCPP::Version_3::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_3::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/3]

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/3]

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() [3/3]

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.

◆ dataDescription() [1/3]

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/3]

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.

◆ dataDescription() [3/3]

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.

◆ demote()

virtual demote_ret_type FrameCPP::Common::FrameSpec::ObjectInterface::demote ( frame_spec_version_type  Target,
demote_arg_type  Obj,
istream_type *  Stream 
) const
protectedpure virtualinherited

◆ DemoteObject() [1/3]

FrameSpec::ObjectInterface::object_type FrameCPP::Common::FrameSpec::ObjectInterface::DemoteObject ( frame_spec_version_type  Target,
object_type  Obj,
istream_type *  Stream 
)
staticinherited

Down grade an object.

Parameters
[in]TargetThis is the version of the frame specification of the demoted object.
[in]ObjThe base object.
[in]StreamStream from which Obj was created.
Returns
A pointer to the objected derived by demoting Obj.

◆ DemoteObject() [2/3]

static object_type FrameCPP::Common::FrameSpec::ObjectInterface::DemoteObject ( frame_spec_version_type  Target,
object_type  Obj,
istream_type *  Stream 
)
staticinherited

Down grade an object.

Parameters
[in]TargetThis is the version of the frame specification of the demoted object.
[in]ObjThe base object.
[in]StreamStream from which Obj was created.
Returns
A pointer to the objected derived by demoting Obj.

◆ DemoteObject() [3/3]

static object_type FrameCPP::Common::FrameSpec::ObjectInterface::DemoteObject ( frame_spec_version_type  Target,
object_type  Obj,
istream_type *  Stream 
)
staticinherited

Down grade an object.

Parameters
[in]TargetThis is the version of the frame specification of the demoted object.
[in]ObjThe base object.
[in]StreamStream from which Obj was created.
Returns
A pointer to the objected derived by demoting Obj.

◆ GetClass() [1/3]

FrameSpec::class_type FrameCPP::Common::FrameSpec::Object::GetClass ( ) const
inlineinherited

Retrieve the class identifier.

Returns
The class identifier.

◆ GetClass() [2/3]

class_type FrameCPP::Common::FrameSpec::Object::GetClass ( ) const
inherited

Retrieve the class identifier.

Returns
The class identifier.

◆ GetClass() [3/3]

class_type FrameCPP::Common::FrameSpec::Object::GetClass ( ) const
inherited

Retrieve the class identifier.

Returns
The class identifier.

◆ GetDescription() [1/3]

const Description * FrameCPP::Common::FrameSpec::Object::GetDescription ( ) const
inlinevirtualinherited

Retrieve FrSH/FrSE description of the parent object.

Returns
The description of the parent class.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ GetDescription() [2/3]

const Description * FrameCPP::Common::FrameSpec::Object::GetDescription ( ) const
virtualinherited

Retrieve FrSH/FrSE description of the parent object.

Returns
The description of the parent class.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ GetDescription() [3/3]

const Description * FrameCPP::Common::FrameSpec::Object::GetDescription ( ) const
virtualinherited

Retrieve FrSH/FrSE description of the parent object.

Returns
The description of the parent class.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ ObjectStructName() [1/3]

const char * FrameH::ObjectStructName ( ) const
virtual

Retrieve the class name of the object.

Returns
The name of the class associated with the object.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ ObjectStructName() [2/3]

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

Retrieve the class name of the object.

Returns
The name of the class associated with the object.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ ObjectStructName() [3/3]

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

Retrieve the class name of the object.

Returns
The name of the class associated with the object.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ promote()

virtual promote_ret_type FrameCPP::Common::FrameSpec::ObjectInterface::promote ( frame_spec_version_type  Target,
promote_arg_type  Obj,
istream_type *  Stream 
) const
protectedpure virtualinherited

◆ PromoteObject() [1/6]

FrameSpec::ObjectInterface::object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type  Target,
frame_spec_version_type  Source,
object_type  Obj,
istream_type *  Stream 
)
staticinherited

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [2/6]

template<typename PreviousType , typename CurrentType >
static object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type  Target,
frame_spec_version_type  Source,
object_type  Obj,
istream_type *  Stream 
)
staticinherited

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [3/6]

static object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type  Target,
frame_spec_version_type  Source,
object_type  Obj,
istream_type *  Stream 
)
staticinherited

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [4/6]

template<typename PreviousType , typename CurrentType >
static object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type  Target,
frame_spec_version_type  Source,
object_type  Obj,
istream_type *  Stream 
)
staticinherited

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [5/6]

static object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type  Target,
frame_spec_version_type  Source,
object_type  Obj,
istream_type *  Stream 
)
staticinherited

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [6/6]

template<typename PreviousType , typename CurrentType >
static object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type  Target,
frame_spec_version_type  Source,
object_type  Obj,
istream_type *  Stream 
)
staticinherited

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.

◆ SetULeapS() [1/3]

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/3]

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

Establish leap second offset.

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

◆ SetULeapS() [3/3]

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

Establish leap second offset.

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

◆ VerifyObject() [1/3]

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.

Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.

◆ VerifyObject() [2/3]

virtual void FrameCPP::Version_3::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.

Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.

◆ VerifyObject() [3/3]

virtual void FrameCPP::Version_3::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.

Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.

◆ WriteNext() [1/3]

ostream_type & FrameCPP::Common::FrameSpec::Object::WriteNext ( ostream_type &  Stream) const
inherited

Write a next pointer to the parent to the stream.

Parameters
[in,out]StreamThe output stream to receive the next pointer.
Returns
The output stream.

◆ WriteNext() [2/3]

ostream_type & FrameCPP::Common::FrameSpec::Object::WriteNext ( ostream_type &  Stream) const
inherited

Write a next pointer to the parent to the stream.

Parameters
[in,out]StreamThe output stream to receive the next pointer.
Returns
The output stream.

◆ WriteNext() [3/3]

ostream_type & FrameCPP::Common::FrameSpec::Object::WriteNext ( ostream_type &  Stream) const
inherited

Write a next pointer to the parent to the stream.

Parameters
[in,out]StreamThe output stream to receive the next pointer.
Returns
The output stream.

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: