ldas-tools-framecpp  2.7.0
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_3::FrHeader Class Referenceabstract

#include <FrHeader.hh>

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

Classes

union  FrHeader_type
 

Public Types

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 ()
 
virtual ~FrHeader ()
 
virtual FrHeaderClone () const
 constructor - virtual copy constructor More...
 
const unsigned char * Get8ByteEndianness () const
 Retrieve the 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
 
virtual Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 Return the number of bytes for this object. More...
 
virtual bool ByteSwapping () const
 
virtual const Common::FrameSpec::ObjectDescription () const
 
virtual FrHeaderCreate (istream_type &Stream) const
 Constructor - virtual. More...
 
virtual FrHeaderCreate (std::istream &Stream) const
 Constructor - virtual. More...
 
void Filter (Common::StreamFilter &SFilter) const
 
virtual const char * ObjectStructName () const
 Retrieve the class name of the object. More...
 
virtual void VerifyObject (Common::Verify &Verifier, Common::IFrameStream &Stream) const
 Verify an object. More...
 
void Write (Common::OStream &Stream) const
 Write Header to stream. More...
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 comparison operator More...
 
 FrHeader ()
 
virtual ~FrHeader ()
 
virtual FrHeaderClone () const
 constructor - virtual copy constructor More...
 
const unsigned char * Get8ByteEndianness () const
 Retrieve the 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
 
virtual Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 Return the number of bytes for this object. More...
 
virtual bool ByteSwapping () const
 
virtual const Common::FrameSpec::ObjectDescription () const
 
virtual FrHeaderCreate (istream_type &Stream) const
 Constructor - virtual. More...
 
virtual FrHeaderCreate (std::istream &Stream) const
 Constructor - virtual. More...
 
void Filter (Common::StreamFilter &SFilter) const
 
virtual const char * ObjectStructName () const
 Retrieve the class name of the object. More...
 
virtual void VerifyObject (Common::Verify &Verifier, Common::IFrameStream &Stream) const
 Verify an object. More...
 
void Write (Common::OStream &Stream) const
 Write Header to stream. More...
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 comparison operator More...
 
class_type GetClass () const
 Retrieve the class identifier. More...
 
class_type GetClass () const
 Retrieve the class identifier. More...
 
const DescriptionGetDescription () const
 Retrieve FrSH/FrSE description of the parent object. 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...
 
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)
 
virtual void Write (ostream_type &Stream) const =0
 Write object to the stream. More...
 
frame_library_type GetFrameLibrary () const
 Retrieve the library used to generate the frame stream. More...
 
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...
 
std::string GetFrameLibraryName () const
 Retrieve the library used to generate the frame stream. More...
 
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. More...
 
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...
 
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 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 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. More...
 
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"
 

Protected Member Functions

 FrHeader (const FrHeader &Source)
 
 FrHeader (std::istream &Source)
 
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, istream_type *Stream) const
 Upgrade an object. More...
 
 FrHeader (const FrHeader &Source)
 
 FrHeader (std::istream &Source)
 
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, istream_type *Stream) const
 Upgrade an object. More...
 
virtual class_type getClass () const
 Retrieve the class identifier. More...
 
virtual class_type getClass () const
 Retrieve the class identifier. More...
 
virtual void complete ()
 Entry point to do extra processing. More...
 
virtual void complete ()
 Entry point to do extra processing. More...
 

Protected Attributes

frame_library_type m_frame_library
 

Private Member Functions

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

Private Attributes

union FrameCPP::Version_3::FrHeader::FrHeader_type m_data
 
bool m_reorder_bytes
 
int m_byte_order
 
const class_type m_class
 Storage for the class identifier. More...
 
const Description *const m_desc
 Description for parent class. More...
 

Static Private Attributes

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

Member Typedef Documentation

◆ 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

◆ 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 ( )

◆ ~FrHeader() [1/2]

FrHeader::~FrHeader ( )
virtual

Reimplemented from FrameCPP::Common::FrHeader.

◆ FrHeader() [2/8]

FrHeader::FrHeader ( const FrHeader Source)
protected

◆ FrHeader() [3/8]

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

◆ FrHeader() [4/8]

FrHeader::FrHeader ( istream_type Stream)
private

◆ FrHeader() [5/8]

FrameCPP::Version_3::FrHeader::FrHeader ( )

◆ ~FrHeader() [2/2]

virtual FrameCPP::Version_3::FrHeader::~FrHeader ( )
virtual

Reimplemented from FrameCPP::Common::FrHeader.

◆ FrHeader() [6/8]

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

◆ FrHeader() [7/8]

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

◆ FrHeader() [8/8]

FrameCPP::Version_3::FrHeader::FrHeader ( istream_type Stream)
private

Member Function Documentation

◆ Bytes() [1/4]

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

Reimplemented from FrameCPP::Common::FrHeader.

◆ Bytes() [2/4]

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

Reimplemented from FrameCPP::Common::FrHeader.

◆ Bytes() [3/4]

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

Return the number of bytes for this object.

Parameters
[in]StreamThe stream on which the object will be written or read.
Returns
The number of bytes required by this object for the specified stream.

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

◆ Bytes() [4/4]

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

Return the number of bytes for this object.

Parameters
[in]StreamThe stream on which the object will be written or read.
Returns
The number of bytes required by this object for the specified stream.

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

◆ ByteSwapping() [1/2]

bool FrHeader::ByteSwapping ( ) const
virtual

Reimplemented from FrameCPP::Common::FrHeader.

◆ ByteSwapping() [2/2]

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

Reimplemented from FrameCPP::Common::FrHeader.

◆ Clone() [1/2]

FrHeader * FrHeader::Clone ( ) const
virtual

constructor - virtual copy constructor

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

◆ Clone() [2/2]

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

constructor - virtual copy constructor

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

◆ complete() [1/2]

void FrHeader::complete ( )
protectedvirtualinherited

Entry point to do extra processing.

Reimplemented in FrameCPP::Version_8::FrHeader, and FrameCPP::Version_8::FrHeader.

◆ complete() [2/2]

virtual void FrameCPP::Common::FrHeader::complete ( )
protectedvirtualinherited

Entry point to do extra processing.

Reimplemented in FrameCPP::Version_8::FrHeader, and FrameCPP::Version_8::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_3::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_3::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_3::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

◆ Description() [2/2]

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

◆ Filter() [1/2]

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

Reimplemented from FrameCPP::Common::FrHeader.

◆ Filter() [2/2]

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

Reimplemented from FrameCPP::Common::FrHeader.

◆ Get8ByteEndianness() [1/2]

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

Retrieve the buffer holding the endian bytes for an 8 byte quantity.

◆ Get8ByteEndianness() [2/2]

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

Retrieve the 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_3::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 class name of the object.

Returns
The name of the class associated with the object.

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

◆ ObjectStructName() [2/2]

virtual const char* FrameCPP::Version_3::FrHeader::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.

◆ 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_3::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_3::FrHeader::promote ( INT_2U  Target,
promote_arg_type  ,
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_3::FrHeader::SetOriginator ( const std::string &  Originator)

Establish the originator of the frame.

◆ SetOriginator() [2/2]

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

Verify an object.

Parameters
[in,out]VerifierSet of rules to use in verification of the object. If an error occurs, the violation is logged here.
[in]StreamThe stream that is being used to read the object.

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

◆ VerifyObject() [2/2]

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

Verify an object.

Parameters
[in,out]VerifierSet of rules to use in verification of the object. If an error occurs, the violation is logged here.
[in]StreamThe stream that is being used to read the object.

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

◆ Write() [1/3]

void FrHeader::Write ( Common::OStream Stream) const

Write Header to stream.

◆ Write() [2/3]

void FrameCPP::Version_3::FrHeader::Write ( Common::OStream Stream) const

Write Header to stream.

◆ Write() [3/3]

virtual void FrameCPP::Common::FrameSpec::ObjectInterface::Write ( ostream_type Stream) const
pure virtualinherited

Write object to the stream.

Parameters
[in,out]StreamThe stream being written with the contents of object.

Implemented in FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_7::FrSimEvent, FrameCPP::Version_7::FrSimData, FrameCPP::Version_7::FrSerData, FrameCPP::Version_7::FrRawData, FrameCPP::Version_7::FrEvent, FrameCPP::Version_7::FrameH, FrameCPP::Version_6::FrVect, FrameCPP::Version_6::FrTOC, FrameCPP::Version_6::FrTable, FrameCPP::Version_6::FrSummary, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrSimEvent, FrameCPP::Version_6::FrSimData, FrameCPP::Version_6::FrSerData, FrameCPP::Version_6::FrRawData, FrameCPP::Version_6::FrProcData, FrameCPP::Version_6::FrMsg, FrameCPP::Version_6::FrEvent, FrameCPP::Version_6::FrEndOfFrame, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrDetector, FrameCPP::Version_6::FrAdcData, FrameCPP::Version_4::FrVect, FrameCPP::Version_4::FrTrigData, FrameCPP::Version_4::FrTOC, FrameCPP::Version_4::FrTable, FrameCPP::Version_4::FrSummary, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrSimEvent, FrameCPP::Version_4::FrSimData, FrameCPP::Version_4::FrSerData, FrameCPP::Version_4::FrRawData, FrameCPP::Version_4::FrProcData, FrameCPP::Version_4::FrEndOfFrame, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrDetector, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_3::FrVect, FrameCPP::Version_3::FrTrigData, FrameCPP::Version_3::FrSummary, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrSimData, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSerData, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrRawData, FrameCPP::Version_3::FrProcData, FrameCPP::Version_3::FrMsg, FrameCPP::Version_3::FrHistory, FrameCPP::Version_3::FrEndOfFrame, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrDetector, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_7::FrSimEvent, FrameCPP::Version_7::FrSimData, FrameCPP::Version_7::FrSerData, FrameCPP::Version_7::FrRawData, FrameCPP::Version_7::FrEvent, FrameCPP::Version_7::FrameH, FrameCPP::Version_6::FrVect, FrameCPP::Version_6::FrTOC, FrameCPP::Version_6::FrTable, FrameCPP::Version_6::FrSummary, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrSimEvent, FrameCPP::Version_6::FrSimData, FrameCPP::Version_6::FrSerData, FrameCPP::Version_6::FrRawData, FrameCPP::Version_6::FrProcData, FrameCPP::Version_6::FrMsg, FrameCPP::Version_6::FrEvent, FrameCPP::Version_6::FrEndOfFrame, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrDetector, FrameCPP::Version_6::FrAdcData, FrameCPP::Version_4::FrVect, FrameCPP::Version_4::FrTrigData, FrameCPP::Version_4::FrTOC, FrameCPP::Version_4::FrTable, FrameCPP::Version_4::FrSummary, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrSimEvent, FrameCPP::Version_4::FrSimData, FrameCPP::Version_4::FrSerData, FrameCPP::Version_4::FrRawData, FrameCPP::Version_4::FrProcData, FrameCPP::Version_4::FrEndOfFrame, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrDetector, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_3::FrVect, FrameCPP::Version_3::FrTrigData, FrameCPP::Version_3::FrSummary, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrSimData, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSerData, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrRawData, FrameCPP::Version_3::FrProcData, FrameCPP::Version_3::FrMsg, FrameCPP::Version_3::FrHistory, FrameCPP::Version_3::FrEndOfFrame, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrDetector, FrameCPP::Version_3::FrameH, and FrameCPP::Version_3::FrAdcData.

◆ 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

◆ 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_3::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

◆ ORIGINATOR_IGWD

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

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