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

Implementation of the frame header structure. More...

#include <FrHeader.hh>

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

Public Types

enum  { FRAME_LIBRARY_UNKNOWN = 0 , FRAME_LIBRARY_FRAMEL = 1 , FRAME_LIBRARY_FRAMECPP = 2 }
 Libraries known to implement the frame specification. More...
 
enum  { FRAME_LIBRARY_UNKNOWN = 0 , FRAME_LIBRARY_FRAMEL = 1 , FRAME_LIBRARY_FRAMECPP = 2 }
 Libraries known to implement the frame specification. More...
 

Public Member Functions

 FrHeader ()
 Constructor.
 
virtual ~FrHeader ()
 Desctructor.
 
virtual FrHeaderClone () const
 Copy Constructor (virtual)
 
const unsigned char * Get8ByteEndianness () const
 Buffer holding the endian bytes for an 8 byte quantity.
 
int GetByteOrder () const
 Return the byte order of the frame.
 
void SetOriginator (const std::string &Originator)
 Establish the originator of the frame.
 
virtual Common::FrameSpec::size_type Bytes () const
 Calculate the streaming size of the object.
 
virtual Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 Calculate the streaming size of the object.
 
virtual bool ByteSwapping () const
 Check if byte swapping is needed.
 
checksum_type Checksum () const
 
virtual const Common::FrameSpec::ObjectDescription () const
 Retrieve the objects stream description.
 
virtual FrHeaderCreate (istream_type &Stream) const
 Constructor ( virtual )
 
virtual FrHeaderCreate (std::istream &Stream) const
 Constructor ( virtual )
 
void Filter (Common::StreamFilter &SFilter) const
 Perform the filter over the bytes streamed.
 
virtual const char * ObjectStructName () const
 Retrieve the name of the frame structure.
 
virtual void VerifyObject (Common::Verify &Verifier, Common::IFrameStream &Stream) const
 Perform verification of the object.
 
void Write (ostream_type &Stream) const
 Write object to the stream.
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 comparison operator
 
 FrHeader ()
 Constructor.
 
virtual ~FrHeader ()
 Desctructor.
 
virtual FrHeaderClone () const
 Copy Constructor (virtual)
 
const unsigned char * Get8ByteEndianness () const
 Buffer holding the endian bytes for an 8 byte quantity.
 
int GetByteOrder () const
 Return the byte order of the frame.
 
void SetOriginator (const std::string &Originator)
 Establish the originator of the frame.
 
virtual Common::FrameSpec::size_type Bytes () const
 Calculate the streaming size of the object.
 
virtual Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 Calculate the streaming size of the object.
 
virtual bool ByteSwapping () const
 Check if byte swapping is needed.
 
virtual const Common::FrameSpec::ObjectDescription () const
 Retrieve the objects stream description.
 
virtual FrHeaderCreate (istream_type &Stream) const
 Constructor ( virtual )
 
virtual FrHeaderCreate (std::istream &Stream) const
 Constructor ( virtual )
 
void Filter (Common::StreamFilter &SFilter) const
 Perform the filter over the bytes streamed.
 
virtual const char * ObjectStructName () const
 Retrieve the name of the frame structure.
 
virtual void VerifyObject (Common::Verify &Verifier, Common::IFrameStream &Stream) const
 Perform verification of the object.
 
void Write (ostream_type &Stream) const
 Write object to the stream.
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 comparison operator
 
class_type GetClass () const
 Retrieve the class identifier.
 
class_type GetClass () const
 Retrieve the class identifier.
 
const DescriptionGetDescription () const
 Retrieve FrSH/FrSE description of the parent object.
 
const DescriptionGetDescription () const
 Retrieve FrSH/FrSE description of the parent object.
 
ostream_type & WriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream.
 
ostream_type & WriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream.
 
virtual ObjectCreate () const
 constructor - virtual
 
frame_library_type GetFrameLibrary () const
 Retrieve the library used to generate the frame stream.
 
frame_library_type GetFrameLibrary () const
 Retrieve the library used to generate the frame stream.
 
std::string GetFrameLibraryName () const
 Retrieve the library used to generate the frame stream.
 
std::string GetFrameLibraryName () const
 Retrieve the library used to generate the frame stream.
 
void SetLibraryVersion (INT_2U Version)
 Establish the version of the Library used.
 
void SetLibraryVersion (INT_2U Version)
 Establish the version of the Library used.
 
void SetVersion (INT_2U Version)
 Establish the version of the frame specification.
 
void SetVersion (INT_2U Version)
 Establish the version of the frame specification.
 

Static Public Member Functions

static object_type DemoteObject (frame_spec_version_type Target, object_type Obj, istream_type *Stream)
 Down grade an object.
 
static object_type DemoteObject (frame_spec_version_type Target, object_type Obj, istream_type *Stream)
 Down grade an object.
 
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
 Upgrade an object.
 
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.
 
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
 Upgrade an object.
 
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.
 
static std::string GetFrameLibraryName (frame_library_type LibraryId)
 Retrieve the library used to generate the frame stream.
 
static std::string GetFrameLibraryName (frame_library_type LibraryId)
 Retrieve the library used to generate the frame stream.
 

Static Public Attributes

static const char * ORIGINATOR_IGWD = "IGWD"
 File type.
 

Protected Member Functions

 FrHeader (const FrHeader &Source)
 Copy Constructor.
 
virtual void complete ()
 calculate values since the object is now complete
 
virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const
 Down grade an object.
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const
 Upgrade an object.
 
 FrHeader (const FrHeader &Source)
 Copy Constructor.
 
virtual void complete ()
 calculate values since the object is now complete
 
virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const
 Down grade an object.
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const
 Upgrade an object.
 
virtual class_type getClass () const
 Retrieve the class identifier.
 
virtual class_type getClass () const
 Retrieve the class identifier.
 

Detailed Description

Implementation of the frame header structure.

This structure is described in section 4.3.1 of the frame specification. Its purpose is to provide a table of standard information in the host order so the reader can determine what translations need to occur.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Libraries known to implement the frame specification.

This enumeration is intended to supply a unique identity for each library implementing the frame specification. This information along with the version of the library and the frame specification, uniquely identifies an implementation of the frame specification and can be used to code around problems with the implementation.

Enumerator
FRAME_LIBRARY_UNKNOWN 

Unknown frame library.

FRAME_LIBRARY_FRAMEL 

Virgo's frameL C implementation of the frame spec.

FRAME_LIBRARY_FRAMECPP 

LIGO's frameCPP C++ implementation of the frame spec.

◆ anonymous enum

anonymous enum

Libraries known to implement the frame specification.

This enumeration is intended to supply a unique identity for each library implementing the frame specification. This information along with the version of the library and the frame specification, uniquely identifies an implementation of the frame specification and can be used to code around problems with the implementation.

Enumerator
FRAME_LIBRARY_UNKNOWN 

Unknown frame library.

FRAME_LIBRARY_FRAMEL 

Virgo's frameL C implementation of the frame spec.

FRAME_LIBRARY_FRAMECPP 

LIGO's frameCPP C++ implementation of the frame spec.

Member Function Documentation

◆ Checksum()

FrHeader::checksum_type FrHeader::Checksum ( ) const
inline

Retieve the value of the checksum associated with this FrHeader structure.

◆ 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]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/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]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.

◆ Filter() [1/2]

void FrHeader::Filter ( Common::StreamFilter & SFilter) const
inline

Perform the filter over the bytes streamed.

Parameters
[in]SFilterFilter to be applied to the stream.

This performs the filtering operation over the raw bytes of the structure. A typical use would be to calculate the CRC checksum of this object.

◆ Filter() [2/2]

void FrameCPP::Version_8::FrHeader::Filter ( Common::StreamFilter & SFilter) const

Perform the filter over the bytes streamed.

Parameters
[in]SFilterFilter to be applied to the stream.

◆ GetClass() [1/2]

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

Retrieve the class identifier.

Returns
The class identifier.

◆ GetClass() [2/2]

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

Retrieve the class identifier.

Returns
The class identifier.

◆ GetDescription() [1/2]

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

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.

◆ operator==()

bool FrHeader::operator== ( const Common::FrameSpec::Object & Obj) const
virtual

comparison operator

Todo
actually implement comparision operator

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

◆ 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]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/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]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/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]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/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]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.

◆ 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]StreamThe 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]StreamThe output stream to receive the next pointer.
Returns
The output stream.

Member Data Documentation

◆ ORIGINATOR_IGWD

static const char * FrHeader::ORIGINATOR_IGWD = "IGWD"
static

File type.

The string "IGWD" to identify the file as an Interferometric Gravitational Wave Detectors frame file.


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