ldas-tools-framecpp  2.5.8
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | 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:
FrameCPP::Common::FrameSpec::Object FrameCPP::Common::FrHeader FrameCPP::Common::FrameSpec::ObjectInterface

Public Types

enum  { FRAME_LIBRARY_UNKNOWN = 0, FRAME_LIBRARY_FRAMEL = 1, FRAME_LIBRARY_FRAMECPP = 2 }
 Libraries known to implement the frame specification. More...
 
typedef
FrEndOfFile::chkSumFrHeader_type 
checksum_type
 
typedef FrameSpec::version_type frame_spec_version_type
 
typedef
LDASTools::AL::SharedPtr
< Object
object_type
 
typedef std::unique_ptr< Objectunique_object_type
 
typedef object_type demote_arg_type
 
typedef object_type demote_ret_type
 
typedef object_type promote_arg_type
 
typedef object_type promote_ret_type
 
enum  frame_library_type { FRAME_LIBRARY_UNKNOWN = 0, FRAME_LIBRARY_FRAMEL = 1, FRAME_LIBRARY_FRAMECPP = 2 }
 
typedef FR_HEADER__VERSION_TYPE version_type
 
typedef
FR_HEADER__LIBRARY_REVISION_TYPE 
library_revision_type
 
typedef CHAR * originator_type
 

Public Member Functions

 FrHeader ()
 Constructor. More...
 
virtual ~FrHeader ()
 Desctructor. More...
 
virtual FrHeaderClone () const
 Copy Constructor (virtual) More...
 
const unsigned char * Get8ByteEndianness () const
 Buffer holding the endian bytes for an 8 byte quantity. More...
 
int GetByteOrder () const
 Return the byte order of the frame. More...
 
void SetOriginator (const std::string &Originator)
 Establish the originator of the frame. More...
 
virtual
Common::FrameSpec::size_type 
Bytes () const
 Calculate the streaming size of the object. More...
 
virtual
Common::FrameSpec::size_type 
Bytes (const Common::StreamBase &Stream) const
 Calculate the streaming size of the object. More...
 
virtual bool ByteSwapping () const
 Check if byte swapping is needed. More...
 
checksum_type Checksum () const
 
virtual const
Common::FrameSpec::Object
Description () const
 Retrieve the objects stream description. More...
 
virtual FrHeaderCreate (istream_type &Stream) const
 Constructor ( virtual ) More...
 
virtual FrHeaderCreate (std::istream &Stream) const
 Constructor ( virtual ) More...
 
void Filter (Common::StreamFilter &SFilter) const
 Perform the filter over the bytes streamed. More...
 
virtual const char * ObjectStructName () const
 Retrieve the name of the frame structure. More...
 
virtual void VerifyObject (Common::Verify &Verifier, Common::IFrameStream &Stream) const
 Perform verification of the object. More...
 
void Write (ostream_type &Stream) const
 Write object to the stream. More...
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 comparison operator More...
 
class_type GetClass () const
 Retrieve the class identifier. More...
 
const DescriptionGetDescription () const
 Retrieve FrSH/FrSE description of the parent object. More...
 
ostream_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream. More...
 
virtual ObjectCreate () const
 constructor - virtual More...
 
template<typename PreviousType , typename CurrentType >
FrameSpec::ObjectInterface::promote_ret_type PromoteObject (FrameSpec::ObjectInterface::frame_spec_version_type Target, FrameSpec::ObjectInterface::frame_spec_version_type Source, FrameSpec::ObjectInterface::promote_arg_type Obj, IStream *Stream)
 
frame_library_type GetFrameLibrary () const
 Retrieve the library used to generate the frame stream. More...
 
std::string GetFrameLibraryName () const
 Retrieve the library used to generate the frame stream. More...
 
library_revision_type GetLibraryRevision () const
 
version_type GetVersion () const
 
originator_type GetOriginator () const
 
virtual bool IsValid () const
 
void SetLibraryVersion (INT_2U Version)
 Establish the version of the Library used. More...
 
void SetVersion (INT_2U Version)
 Establish the version of the frame specification. 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 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 cmn_streamsize_type SizeOf ()
 
static std::string GetFrameLibraryName (frame_library_type LibraryId)
 Retrieve the library used to generate the frame stream. More...
 

Static Public Attributes

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

Protected Member Functions

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

Protected Attributes

frame_library_type m_frame_library
 

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 Typedef Documentation

typedef FrEndOfFile::chkSumFrHeader_type FrameCPP::Version_8::FrHeader::checksum_type
typedef FR_HEADER__LIBRARY_REVISION_TYPE FrameCPP::Common::FrHeader::library_revision_type
inherited
typedef LDASTools::AL::SharedPtr< Object > FrameCPP::Common::FrameSpec::ObjectInterface::object_type
inherited
typedef CHAR* FrameCPP::Common::FrHeader::originator_type
inherited
typedef FR_HEADER__VERSION_TYPE FrameCPP::Common::FrHeader::version_type
inherited

Member Enumeration Documentation

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.

enum FrameCPP::Common::FrHeader::frame_library_type
inherited
Enumerator
FRAME_LIBRARY_UNKNOWN 
FRAME_LIBRARY_FRAMEL 
FRAME_LIBRARY_FRAMECPP 

Constructor & Destructor Documentation

FrameCPP::Version_8::FrHeader::FrHeader ( )

Constructor.

FrameCPP::Version_8::FrHeader::~FrHeader ( )
virtual

Desctructor.

Reimplemented from FrameCPP::Common::FrHeader.

FrameCPP::Version_8::FrHeader::FrHeader ( const FrHeader Source)
protected

Copy Constructor.

FrameCPP::Version_8::FrHeader::FrHeader ( std::istream &  Source)
protected

Member Function Documentation

FrameSpec::size_type FrameCPP::Version_8::FrHeader::Bytes ( ) const
virtual

Calculate the streaming size of the object.

Reimplemented from FrameCPP::Common::FrHeader.

FrameSpec::size_type FrameCPP::Version_8::FrHeader::Bytes ( const Common::StreamBase Stream) const
virtual

Calculate the streaming size of the object.

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

bool FrameCPP::Version_8::FrHeader::ByteSwapping ( ) const
virtual

Check if byte swapping is needed.

Reimplemented from FrameCPP::Common::FrHeader.

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

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

FrHeader * FrameCPP::Version_8::FrHeader::Clone ( ) const
virtual

Copy Constructor (virtual)

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

void FrameCPP::Version_8::FrHeader::complete ( )
protectedvirtual

calculate values since the object is now complete

Reimplemented from FrameCPP::Common::FrHeader.

FrHeader * FrameCPP::Version_8::FrHeader::Create ( istream_type Stream) const
virtual

Constructor ( virtual )

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

FrHeader * FrameCPP::Version_8::FrHeader::Create ( std::istream &  Stream) const
virtual

Constructor ( virtual )

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

FrameSpec::Object * FrameCPP::Common::FrameSpec::ObjectInterface::Create ( ) const
virtualinherited
FrHeader::demote_ret_type FrameCPP::Version_8::FrHeader::demote ( INT_2U  Target,
demote_arg_type  Obj,
istream_type Stream 
) const
protectedvirtual

Down grade an object.

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

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.
const FrameSpec::Object * FrameCPP::Version_8::FrHeader::Description ( ) const
virtual

Retrieve the objects stream description.

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

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.

Reimplemented from FrameCPP::Common::FrHeader.

const unsigned char * FrameCPP::Version_8::FrHeader::Get8ByteEndianness ( ) const
inline

Buffer holding the endian bytes for an 8 byte quantity.

int FrameCPP::Version_8::FrHeader::GetByteOrder ( ) const
inline

Return the byte order of the frame.

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

Retrieve the class identifier.

Returns
The class identifier.
FrameSpec::class_type FrameCPP::Common::FrameSpec::Object::getClass ( ) const
protectedvirtualinherited

Retrieve the class identifier.

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

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.

FrHeader::frame_library_type FrameCPP::Common::FrHeader::GetFrameLibrary ( ) const
inlineinherited

Retrieve the library used to generate the frame stream.

std::string FrameCPP::Common::FrHeader::GetFrameLibraryName ( ) const
inlineinherited

Retrieve the library used to generate the frame stream.

std::string FrameCPP::Common::FrHeader::GetFrameLibraryName ( frame_library_type  LibraryId)
inlinestaticinherited

Retrieve the library used to generate the frame stream.

FrHeader::library_revision_type FrameCPP::Common::FrHeader::GetLibraryRevision ( ) const
inlineinherited
FrHeader::originator_type FrameCPP::Common::FrHeader::GetOriginator ( ) const
inlineinherited
FrHeader::version_type FrameCPP::Common::FrHeader::GetVersion ( ) const
inlineinherited
bool FrameCPP::Common::FrHeader::IsValid ( ) const
virtualinherited
const char * FrameCPP::Version_8::FrHeader::ObjectStructName ( ) const
virtual

Retrieve the name of the frame structure.

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

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

comparison operator

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

FrHeader::promote_ret_type FrameCPP::Version_8::FrHeader::promote ( INT_2U  Target,
promote_arg_type  Obj,
istream_type Stream 
) const
protectedvirtual

Upgrade an object.

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

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.
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.
template<typename PreviousType , typename CurrentType >
FrameSpec::ObjectInterface::promote_ret_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( FrameSpec::ObjectInterface::frame_spec_version_type  Target,
FrameSpec::ObjectInterface::frame_spec_version_type  Source,
FrameSpec::ObjectInterface::promote_arg_type  Obj,
IStream Stream 
)
inherited
void FrameCPP::Common::FrHeader::SetLibraryVersion ( INT_2U  Version)
inlineinherited

Establish the version of the Library used.

void FrameCPP::Version_8::FrHeader::SetOriginator ( const std::string &  Originator)

Establish the originator of the frame.

void FrameCPP::Common::FrHeader::SetVersion ( INT_2U  Version)
inlineinherited

Establish the version of the frame specification.

cmn_streamsize_type FrameCPP::Common::FrHeader::SizeOf ( )
inlinestaticinherited
void FrameCPP::Version_8::FrHeader::VerifyObject ( Common::Verify Verifier,
Common::IFrameStream Stream 
) const
virtual

Perform verification of the object.

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

void FrameCPP::Version_8::FrHeader::Write ( ostream_type Stream) const
virtual

Write object to the stream.

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

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_library_type FrameCPP::Common::FrHeader::m_frame_library
protectedinherited
const char * FrameCPP::Version_8::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: