ldas-tools-framecpp 2.7.0
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | Static Private 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:
Inheritance graph
[legend]
Collaboration diagram for FrameCPP::Version_8::FrHeader:
Collaboration graph
[legend]

Classes

union  FrHeader_type
 

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...
 
typedef FrEndOfFile::chkSumFrHeader_type checksum_type
 
typedef FrEndOfFile::chkSumFrHeader_type checksum_type
 
typedef FrameSpec::version_type frame_spec_version_type
 
typedef FrameSpec::version_type frame_spec_version_type
 
typedef boost::shared_ptr< Objectobject_type
 
typedef boost::shared_ptr< Objectobject_type
 
typedef std::unique_ptr< Objectunique_object_type
 
typedef std::unique_ptr< Objectunique_object_type
 
typedef object_type demote_arg_type
 
typedef object_type demote_arg_type
 
typedef object_type demote_ret_type
 
typedef object_type demote_ret_type
 
typedef object_type promote_arg_type
 
typedef object_type promote_arg_type
 
typedef object_type promote_ret_type
 
typedef object_type promote_ret_type
 
enum  frame_library_type {
  FRAME_LIBRARY_UNKNOWN = 0 , FRAME_LIBRARY_FRAMEL = 1 , FRAME_LIBRARY_FRAMECPP = 2 , FRAME_LIBRARY_UNKNOWN = 0 ,
  FRAME_LIBRARY_FRAMEL = 1 , FRAME_LIBRARY_FRAMECPP = 2
}
 
enum  frame_library_type {
  FRAME_LIBRARY_UNKNOWN = 0 , FRAME_LIBRARY_FRAMEL = 1 , FRAME_LIBRARY_FRAMECPP = 2 , FRAME_LIBRARY_UNKNOWN = 0 ,
  FRAME_LIBRARY_FRAMEL = 1 , FRAME_LIBRARY_FRAMECPP = 2
}
 
typedef FR_HEADER__VERSION_TYPE version_type
 
typedef FR_HEADER__VERSION_TYPE version_type
 
typedef FR_HEADER__LIBRARY_REVISION_TYPE library_revision_type
 
typedef FR_HEADER__LIBRARY_REVISION_TYPE library_revision_type
 
typedef CHAR * originator_type
 
typedef CHAR * originator_type
 

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.
 
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
 
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_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream.
 
ostream_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream.
 
virtual ObjectCreate () const
 constructor - virtual
 
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.
 
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.
 
library_revision_type GetLibraryRevision () const
 
library_revision_type GetLibraryRevision () const
 
version_type GetVersion () const
 
version_type GetVersion () const
 
originator_type GetOriginator () const
 
originator_type GetOriginator () const
 
virtual bool IsValid () const
 
virtual bool IsValid () const
 
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.
 
void Write (OStream &Stream) const
 

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 cmn_streamsize_type SizeOf ()
 
static cmn_streamsize_type SizeOf ()
 
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.
 
 FrHeader (std::istream &Source)
 
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.
 
 FrHeader (std::istream &Source)
 
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.
 

Protected Attributes

frame_library_type m_frame_library
 

Private Member Functions

 FrHeader (istream_type &Stream)
 Constructor.
 
 FrHeader (istream_type &Stream)
 Constructor.
 
void initialize (std::istream &Source)
 Initialize the class.
 
void initialize (std::istream &Source)
 Initialize the class.
 

Private Attributes

union FrameCPP::Version_8::FrHeader::FrHeader_type m_data
 
bool m_reorder_bytes
 State of reordering.
 
int m_byte_order
 
FrEndOfFile::chkSumFrHeader_type m_checksum
 Object checksum.
 
INT_4U m_checksum_value
 
const class_type m_class
 Storage for the class identifier.
 
const Description *const m_desc
 Description for parent class.
 

Static Private Attributes

static const Common::FrameSpec::Info::frame_object_types s_object_id = Common::FrameSpec::Info::FSI_FR_HEADER
 

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

◆ checksum_type [1/2]

typedef FrEndOfFile::chkSumFrHeader_type FrameCPP::Version_8::FrHeader::checksum_type

◆ checksum_type [2/2]

typedef FrEndOfFile::chkSumFrHeader_type FrameCPP::Version_8::FrHeader::checksum_type

◆ demote_arg_type [1/2]

◆ demote_arg_type [2/2]

◆ demote_ret_type [1/2]

◆ demote_ret_type [2/2]

◆ frame_spec_version_type [1/2]

◆ frame_spec_version_type [2/2]

◆ library_revision_type [1/2]

◆ library_revision_type [2/2]

◆ object_type [1/2]

typedef boost::shared_ptr< Object > FrameCPP::Common::FrameSpec::ObjectInterface::object_type
inherited

◆ object_type [2/2]

typedef boost::shared_ptr< Object > FrameCPP::Common::FrameSpec::ObjectInterface::object_type
inherited

◆ originator_type [1/2]

◆ originator_type [2/2]

◆ promote_arg_type [1/2]

◆ promote_arg_type [2/2]

◆ promote_ret_type [1/2]

◆ promote_ret_type [2/2]

◆ unique_object_type [1/2]

◆ unique_object_type [2/2]

◆ version_type [1/2]

◆ version_type [2/2]

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.

◆ frame_library_type [1/2]

Enumerator
FRAME_LIBRARY_UNKNOWN 
FRAME_LIBRARY_FRAMEL 
FRAME_LIBRARY_FRAMECPP 
FRAME_LIBRARY_UNKNOWN 
FRAME_LIBRARY_FRAMEL 
FRAME_LIBRARY_FRAMECPP 

◆ frame_library_type [2/2]

Enumerator
FRAME_LIBRARY_UNKNOWN 
FRAME_LIBRARY_FRAMEL 
FRAME_LIBRARY_FRAMECPP 
FRAME_LIBRARY_UNKNOWN 
FRAME_LIBRARY_FRAMEL 
FRAME_LIBRARY_FRAMECPP 

Constructor & Destructor Documentation

◆ FrHeader() [1/8]

FrHeader::FrHeader ( )

Constructor.

◆ ~FrHeader() [1/2]

FrHeader::~FrHeader ( )
virtual

Desctructor.

Reimplemented from FrameCPP::Common::FrHeader.

◆ FrHeader() [2/8]

FrHeader::FrHeader ( const FrHeader & Source)
protected

Copy Constructor.

◆ FrHeader() [3/8]

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

◆ FrHeader() [4/8]

FrHeader::FrHeader ( istream_type & Stream)
private

Constructor.

Parameters
StreamCreate an instance of the object from an input stream.

◆ FrHeader() [5/8]

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

Constructor.

◆ ~FrHeader() [2/2]

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

Desctructor.

Reimplemented from FrameCPP::Common::FrHeader.

◆ FrHeader() [6/8]

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

Copy Constructor.

◆ FrHeader() [7/8]

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

◆ FrHeader() [8/8]

FrameCPP::Version_8::FrHeader::FrHeader ( istream_type & Stream)
private

Constructor.

Parameters
StreamCreate an instance of the object from an input stream.

Member Function Documentation

◆ Bytes() [1/4]

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

Calculate the streaming size of the object.

Reimplemented from FrameCPP::Common::FrHeader.

◆ Bytes() [2/4]

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

Calculate the streaming size of the object.

Reimplemented from FrameCPP::Common::FrHeader.

◆ Bytes() [3/4]

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

Calculate the streaming size of the object.

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

◆ Bytes() [4/4]

virtual Common::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.

◆ ByteSwapping() [1/2]

bool FrHeader::ByteSwapping ( ) const
virtual

Check if byte swapping is needed.

Reimplemented from FrameCPP::Common::FrHeader.

◆ ByteSwapping() [2/2]

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

Check if byte swapping is needed.

Reimplemented from FrameCPP::Common::FrHeader.

◆ Checksum() [1/2]

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

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

◆ Checksum() [2/2]

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

◆ Clone() [1/2]

FrHeader * FrHeader::Clone ( ) const
virtual

Copy Constructor (virtual)

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

◆ Clone() [2/2]

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

Copy Constructor (virtual)

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

◆ complete() [1/2]

void FrHeader::complete ( )
protectedvirtual

calculate values since the object is now complete

Reimplemented from FrameCPP::Common::FrHeader.

◆ complete() [2/2]

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

calculate values since the object is now complete

Reimplemented from FrameCPP::Common::FrHeader.

◆ Create() [1/5]

FrameSpec::Object * FrameCPP::Common::FrameSpec::ObjectInterface::Create ( ) const
virtualinherited

◆ Create() [2/5]

FrHeader * FrHeader::Create ( istream_type & Stream) const
virtual

Constructor ( virtual )

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

◆ Create() [3/5]

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

Constructor ( virtual )

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

◆ Create() [4/5]

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

Constructor ( virtual )

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

◆ Create() [5/5]

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

Constructor ( virtual )

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

◆ demote() [1/2]

FrHeader::demote_ret_type FrHeader::demote ( INT_2U Target,
demote_arg_type Obj,
istream_type * Stream ) const
protectedvirtual

Down grade an object.

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

◆ demote() [2/2]

virtual 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.

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

◆ Description() [1/2]

const FrameSpec::Object * FrHeader::Description ( ) const
virtual

Retrieve the objects stream description.

◆ Description() [2/2]

virtual const Common::FrameSpec::Object * FrameCPP::Version_8::FrHeader::Description ( ) const
virtual

Retrieve the objects stream description.

◆ Filter() [1/2]

void 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.

◆ Filter() [2/2]

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

Perform the filter over the bytes streamed.

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

Reimplemented from FrameCPP::Common::FrHeader.

◆ Get8ByteEndianness() [1/2]

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

Buffer holding the endian bytes for an 8 byte quantity.

◆ Get8ByteEndianness() [2/2]

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

Buffer holding the endian bytes for an 8 byte quantity.

◆ GetByteOrder() [1/2]

int FrHeader::GetByteOrder ( ) const
inline

Return the byte order of the frame.

◆ GetByteOrder() [2/2]

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

Return the byte order of the frame.

◆ GetClass() [1/2]

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

Retrieve the class identifier.

Returns
The class identifier.

◆ getClass() [1/2]

FrameSpec::class_type FrameCPP::Common::FrameSpec::Object::getClass ( ) const
protectedvirtualinherited

Retrieve the class identifier.

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

◆ GetClass() [2/2]

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

Retrieve the class identifier.

Returns
The class identifier.

◆ getClass() [2/2]

virtual class_type FrameCPP::Common::FrameSpec::Object::getClass ( ) const
protectedvirtualinherited

Retrieve the class identifier.

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

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

◆ GetFrameLibrary() [1/2]

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

Retrieve the library used to generate the frame stream.

◆ GetFrameLibrary() [2/2]

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

Retrieve the library used to generate the frame stream.

◆ GetFrameLibraryName() [1/4]

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

Retrieve the library used to generate the frame stream.

◆ GetFrameLibraryName() [2/4]

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

Retrieve the library used to generate the frame stream.

◆ GetFrameLibraryName() [3/4]

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

Retrieve the library used to generate the frame stream.

◆ GetFrameLibraryName() [4/4]

static std::string FrameCPP::Common::FrHeader::GetFrameLibraryName ( frame_library_type LibraryId)
staticinherited

Retrieve the library used to generate the frame stream.

◆ GetLibraryRevision() [1/2]

FrHeader::library_revision_type FrHeader::GetLibraryRevision ( ) const
inlineinherited

◆ GetLibraryRevision() [2/2]

library_revision_type FrameCPP::Common::FrHeader::GetLibraryRevision ( ) const
inherited

◆ GetOriginator() [1/2]

FrHeader::originator_type FrHeader::GetOriginator ( ) const
inlineinherited

◆ GetOriginator() [2/2]

originator_type FrameCPP::Common::FrHeader::GetOriginator ( ) const
inherited

◆ GetVersion() [1/2]

FrHeader::version_type FrHeader::GetVersion ( ) const
inlineinherited

◆ GetVersion() [2/2]

version_type FrameCPP::Common::FrHeader::GetVersion ( ) const
inherited

◆ initialize() [1/2]

void FrHeader::initialize ( std::istream & Source)
privateinherited

Initialize the class.

Parameters
[in,out]SourceThe source stream from which to initialize the instance.

◆ initialize() [2/2]

void FrameCPP::Common::FrHeader::initialize ( std::istream & Source)
privateinherited

Initialize the class.

Parameters
[in,out]SourceThe source stream from which to initialize the instance.

◆ IsValid() [1/2]

bool FrHeader::IsValid ( ) const
virtualinherited

◆ IsValid() [2/2]

virtual bool FrameCPP::Common::FrHeader::IsValid ( ) const
virtualinherited

◆ ObjectStructName() [1/2]

const char * FrHeader::ObjectStructName ( ) const
virtual

Retrieve the name of the frame structure.

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

◆ ObjectStructName() [2/2]

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

Retrieve the name of the frame structure.

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

◆ operator==() [1/2]

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

comparison operator

Todo
actually implement comparision operator

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

◆ operator==() [2/2]

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

comparison operator

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

◆ promote() [1/2]

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

Upgrade an object.

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

◆ promote() [2/2]

virtual 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.

◆ PromoteObject() [1/5]

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

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

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

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

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

◆ SetLibraryVersion() [1/2]

void FrHeader::SetLibraryVersion ( INT_2U Version)
inlineinherited

Establish the version of the Library used.

◆ SetLibraryVersion() [2/2]

void FrameCPP::Common::FrHeader::SetLibraryVersion ( INT_2U Version)
inherited

Establish the version of the Library used.

◆ SetOriginator() [1/2]

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

Establish the originator of the frame.

◆ SetOriginator() [2/2]

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

Establish the originator of the frame.

◆ SetVersion() [1/2]

void FrHeader::SetVersion ( INT_2U Version)
inlineinherited

Establish the version of the frame specification.

◆ SetVersion() [2/2]

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

Establish the version of the frame specification.

◆ SizeOf() [1/2]

cmn_streamsize_type FrHeader::SizeOf ( )
inlinestaticinherited

◆ SizeOf() [2/2]

static cmn_streamsize_type FrameCPP::Common::FrHeader::SizeOf ( )
staticinherited

◆ VerifyObject() [1/2]

void FrHeader::VerifyObject ( Common::Verify & Verifier,
Common::IFrameStream & Stream ) const
virtual

Perform verification of the object.

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

◆ VerifyObject() [2/2]

virtual 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.

◆ Write() [1/3]

void FrHeader::Write ( OStream & Stream) const
inherited

◆ Write() [2/3]

void FrHeader::Write ( ostream_type & Stream) const
virtual

Write object to the stream.

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

◆ Write() [3/3]

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

Write object to the stream.

Implements 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]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

◆ m_byte_order

int FrHeader::m_byte_order
private
Todo
need to lookup how this variable is used.
Todo
need to lookup how this variable is used.

◆ m_checksum

FrEndOfFile::chkSumFrHeader_type FrHeader::m_checksum
mutableprivate

Object checksum.

This is the storage space for the checksum associated with the FrHeader structure. It is calculated at the beginning and written at the end as part of the FrEndOfFile structure.

◆ m_checksum_value

INT_4U FrHeader::m_checksum_value
private

The checksum as calculated from reading the object from the stream.

◆ m_class

const class_type FrameCPP::Common::FrameSpec::Object::m_class
privateinherited

Storage for the class identifier.

The class identifier uniquely identifies the parent class within the frame specification. All instances of parent class will have the same class identifier.

◆ m_data

union FrameCPP::Version_8::FrHeader::FrHeader_type FrHeader::m_data
private

◆ m_desc

const Description *const FrameCPP::Common::FrameSpec::Object::m_desc
privateinherited

Description for parent class.

The description for the parent class composed of one FrSH and one or more FrSE elements.

◆ m_frame_library

frame_library_type FrHeader::m_frame_library
protectedinherited

◆ m_reorder_bytes

bool FrHeader::m_reorder_bytes
private

State of reordering.

This variable is true if the stream endianness is not the same as the host endianness.

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

◆ s_object_id

static const Common::FrameSpec::Info::frame_object_types FrHeader::s_object_id = Common::FrameSpec::Info::FSI_FR_HEADER
staticprivate

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