FrameH Data Structure Definition.
More...
#include <FrameH.hh>
|
| FrameH () |
| Default constructor. More...
|
|
streamsize_type | Bytes (const Common::StreamBase &Stream) const |
| Number of bytes needed to write this structure.
|
|
virtual FrameH * | Clone () const |
| Virtual constructor.
|
|
virtual FrameH * | Create (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 FrameH * | Clone () const |
| Virtual constructor.
|
|
virtual FrameH * | Create (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...
|
|
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...
|
|
virtual Object * | Create () const |
| constructor - virtual
|
|
virtual Object * | Create (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...
|
|
|
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...
|
|
|
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 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...
|
|
FrameH Data Structure Definition.
◆ FrameH()
Default constructor.
Allocate resources using default values.
◆ assign() [1/2]
void FrameH::assign |
( |
assign_stream_type & |
Stream | ) |
|
|
protectedvirtual |
Assign the contents of the instance.
- Parameters
-
[in] | Stream | An 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/2]
virtual void FrameCPP::Version_3::FrameH::assign |
( |
assign_stream_type & |
Stream | ) |
|
|
protectedvirtual |
Assign the contents of the instance.
- Parameters
-
[in] | Stream | An 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 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.
◆ dataDescription() [1/2]
static void FrameCPP::Version_3::FrameHNPS::dataDescription |
( |
Common::Description & |
Desc | ) |
|
|
staticprotectedinherited |
Dictionary description of data.
- Parameters
-
[out] | Desc | The handle to a dictionary description to which this type of object is to be added. |
◆ dataDescription() [2/2]
void FrameHNPS::dataDescription |
( |
Common::Description & |
Desc | ) |
|
|
inlinestaticprotectedinherited |
Dictionary description of data.
- Parameters
-
[out] | Desc | The 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 |
Demotes object to previous version of the frame spec.
- Parameters
-
[in] | Target | The version of the frame specification to demote too. |
[in] | Obj | The version of the object to demote. |
[in] | Stream | The input stream from which the original object was read. |
- Returns
- An object of the previous generation.
Implemented in FrameCPP::Version_4::FrTable, FrameCPP::Version_4::FrTable, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_6::FrTable, FrameCPP::Version_6::FrTable, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_3::FrAdcData, and FrameCPP::Version_3::FrAdcData.
◆ DemoteObject() [1/2]
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] | Target | This is the version of the frame specification of the demoted object. |
[in] | Obj | The base object. |
[in] | Stream | Stream from which Obj was created. |
- Returns
- A pointer to the objected derived by demoting Obj.
◆ DemoteObject() [2/2]
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] | Target | This is the version of the frame specification of the demoted object. |
[in] | Obj | The base object. |
[in] | Stream | Stream from which Obj was created. |
- Returns
- A pointer to the objected derived by demoting Obj.
◆ GetClass() [1/2]
class_type FrameCPP::Common::FrameSpec::Object::GetClass |
( |
| ) |
const |
|
inherited |
Retrieve the class identifier.
- Returns
- The class identifier.
◆ GetClass() [2/2]
FrameSpec::class_type FrameCPP::Common::FrameSpec::Object::GetClass |
( |
| ) |
const |
|
inlineinherited |
Retrieve the class identifier.
- Returns
- The class identifier.
◆ GetDescription() [1/2]
const Description * FrameCPP::Common::FrameSpec::Object::GetDescription |
( |
| ) |
const |
|
inlinevirtualinherited |
◆ GetDescription() [2/2]
const Description* FrameCPP::Common::FrameSpec::Object::GetDescription |
( |
| ) |
const |
|
virtualinherited |
◆ ObjectStructName() [1/2]
virtual const char* FrameCPP::Version_3::FrameH::ObjectStructName |
( |
| ) |
const |
|
virtual |
◆ ObjectStructName() [2/2]
const char * FrameH::ObjectStructName |
( |
| ) |
const |
|
virtual |
◆ 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 |
Promotes object to another version of the frame spec.
- Parameters
-
[in] | Target | The version of the promoted frame specification. |
[in] | Obj | The object to be promoted. |
[in] | Stream | The input stream from which the original object was read. |
- Returns
- An object promoted to the next generation.
Implemented in FrameCPP::Version_4::FrTable, FrameCPP::Version_4::FrTable, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_6::FrTable, FrameCPP::Version_6::FrTable, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_3::FrAdcData, and FrameCPP::Version_3::FrAdcData.
◆ PromoteObject() [1/4]
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] | Target | Promote Obj to this version of the frame specification. |
[in] | Source | Obj conforms to this version of the frame specification. |
[in] | Obj | Object to be converted |
[in] | Stream | Originating stream for Obj. |
- Returns
- A pointer to the objected derived by promoting Obj.
◆ PromoteObject() [2/4]
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] | Target | Promote Obj to this version of the frame specification. |
[in] | Source | Obj conforms to this version of the frame specification. |
[in] | Obj | Object to be converted |
[in] | Stream | Originating stream for Obj. |
- Returns
- A pointer to the objected derived by promoting Obj.
◆ PromoteObject() [3/4]
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] | Target | Promote Obj to this version of the frame specification. |
[in] | Source | Obj conforms to this version of the frame specification. |
[in] | Obj | Object to be converted |
[in] | Stream | Originating stream for Obj. |
- Returns
- A pointer to the objected derived by promoting Obj.
◆ PromoteObject() [4/4]
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] | Target | Promote Obj to this version of the frame specification. |
[in] | Source | Obj conforms to this version of the frame specification. |
[in] | Obj | Object to be converted |
[in] | Stream | Originating stream for Obj. |
- Returns
- A pointer to the objected derived by promoting Obj.
◆ SetULeapS() [1/2]
void FrameHNPS::SetULeapS |
( |
ULeapS_type |
Value | ) |
|
|
inlineinherited |
Establish leap second offset.
Set the number of leap seconds since GPS epoc.
- Parameters
-
[in] | Value | Number 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] | Value | Number of leap seconds since GPS epoc. |
◆ VerifyObject() [1/2]
virtual void FrameCPP::Version_3::FrameH::VerifyObject |
( |
Common::Verify & |
Verifier, |
|
|
Common::IFrameStream & |
Stream |
|
) |
| const |
|
protectedvirtual |
Verify the object as being valid.
- Parameters
-
[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. |
Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.
◆ VerifyObject() [2/2]
void FrameH::VerifyObject |
( |
Common::Verify & |
Verifier, |
|
|
Common::IFrameStream & |
Stream |
|
) |
| const |
|
protectedvirtual |
Verify the object as being valid.
- Parameters
-
[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. |
Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.
◆ WriteNext() [1/2]
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] | Stream | The output stream to receive the next pointer. |
- Returns
- The output stream.
◆ WriteNext() [2/2]
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] | Stream | The output stream to receive the next pointer. |
- Returns
- The output stream.
◆ frame
frame_type FrameHNPS::frame |
|
protectedinherited |
Frame number.
This value is monotonically increasing until the end of the run.
◆ GTime
GTime_type FrameHNPS::GTime |
|
protectedinherited |
Frame start time.
The GPS time since GPS standard epoch.
◆ localTime
localTime_type FrameHNPS::localTime |
|
protectedinherited |
Local seasonal time.
UTC in seconds [integer multiple of 1800 seconds].
◆ name
name_type 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 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:
- /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-2.7.0/include/framecpp/Version3/FrameH.hh
- Version3/FrameH.cc