ldas-tools-framecpp  2.8.1
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Types | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
FrameCPP::Common::StreamRef2< LT, CKT, CT, IT > Class Template Reference

Generalized common elements of frame structure. More...

#include <StreamRef.hh>

Inheritance diagram for FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >:
Inheritance graph
[legend]
Collaboration diagram for FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >:
Collaboration graph
[legend]

Public Types

typedef StreamRef2< LT, CKT, CT, IT > self_type
 
typedef StreamRef2< LT, CKT, CT, IT > self_type
 
typedef StreamRef2< LT, CKT, CT, IT > self_type
 
typedef INT_2U class_type
 
typedef INT_2U class_type
 
typedef INT_2U class_type
 
typedef INT_4U instance_type
 
typedef INT_4U instance_type
 
typedef INT_4U instance_type
 
typedef INT_8U length_type
 
typedef INT_8U length_type
 
typedef INT_8U length_type
 
typedef FrameSpec::version_type frame_spec_version_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 boost::shared_ptr< Objectobject_type
 
typedef std::unique_ptr< Objectunique_object_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_arg_type
 
typedef object_type demote_ret_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_arg_type
 
typedef object_type promote_ret_type
 
typedef object_type promote_ret_type
 
typedef object_type promote_ret_type
 

Public Member Functions

 StreamRef2 ()
 Constructor. More...
 
virtual ~StreamRef2 ()
 Destructor. More...
 
FrameSpec::size_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object. More...
 
virtual FrameSpec::size_type SizeOf () const
 
virtual INT_2U GetChkType () const
 
virtual class_type GetClass () const
 
virtual instance_type GetInstance () const
 
virtual length_type GetLength () const
 
virtual void SetChkType (INT_2U ChkType)
 
virtual void SetClass (class_type Class)
 
virtual void SetInstance (instance_type Instance)
 
virtual void SetLength (length_type Length)
 
virtual self_typeCreate (IStream &Stream) const
 constructor - virtual More...
 
virtual self_typeClone () const
 constructor - virtual copy constructor More...
 
virtual const char * ObjectStructName () const
 Retrieve the class name of the object. More...
 
virtual void Write (OStream &Stream) const
 Write object to the stream. More...
 
virtual bool operator== (const StreamRef2< LT, CKT, CT, IT > &RHS) const
 comparison operator More...
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 comparison operator More...
 
 StreamRef2 ()
 Constructor. More...
 
virtual ~StreamRef2 ()
 Destructor. More...
 
FrameSpec::size_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object. More...
 
virtual FrameSpec::size_type SizeOf () const
 
virtual INT_2U GetChkType () const
 
virtual class_type GetClass () const
 
virtual instance_type GetInstance () const
 
virtual length_type GetLength () const
 
virtual void SetChkType (INT_2U ChkType)
 
virtual void SetClass (class_type Class)
 
virtual void SetInstance (instance_type Instance)
 
virtual void SetLength (length_type Length)
 
virtual self_typeCreate (IStream &Stream) const
 constructor - virtual More...
 
virtual self_typeClone () const
 constructor - virtual copy constructor More...
 
virtual const char * ObjectStructName () const
 Retrieve the class name of the object. More...
 
virtual void Write (OStream &Stream) const
 Write object to the stream. More...
 
virtual bool operator== (const StreamRef2< LT, CKT, CT, IT > &RHS) const
 comparison operator More...
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 comparison operator More...
 
 StreamRef2 ()
 Constructor. More...
 
virtual ~StreamRef2 ()
 Destructor. More...
 
FrameSpec::size_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object. More...
 
virtual FrameSpec::size_type SizeOf () const
 
virtual INT_2U GetChkType () const
 
virtual class_type GetClass () const
 
virtual instance_type GetInstance () const
 
virtual length_type GetLength () const
 
virtual void SetChkType (INT_2U ChkType)
 
virtual void SetClass (class_type Class)
 
virtual void SetInstance (instance_type Instance)
 
virtual void SetLength (length_type Length)
 
virtual self_typeCreate (IStream &Stream) const
 constructor - virtual More...
 
virtual self_typeClone () const
 constructor - virtual copy constructor More...
 
virtual const char * ObjectStructName () const
 Retrieve the class name of the object. More...
 
virtual void Write (OStream &Stream) const
 Write object to the stream. More...
 
virtual bool operator== (const StreamRef2< LT, CKT, CT, IT > &RHS) const
 comparison operator More...
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 comparison operator 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...
 
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...
 
ostream_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream. More...
 
virtual ObjectCreate () const
 constructor - virtual More...
 
virtual ObjectCreate (std::istream &Buffer) 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 VerifyObject (Verify &Verifier, IFrameStream &Stream) const
 Verify an object. More...
 
virtual void VerifyObject (Verify &Verifier, IFrameStream &Stream) const
 Verify an object. More...
 
virtual void VerifyObject (Verify &Verifier, IFrameStream &Stream) const
 Verify an object. More...
 

Static Public Member Functions

static FrameSpec::size_type Bytes ()
 
static FrameSpec::size_type Bytes ()
 
static FrameSpec::size_type Bytes ()
 
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 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 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...
 

Protected Member Functions

virtual void assign (IStringStream &Stream)
 
virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, IStream *Stream) const
 Down grade an object. More...
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, IStream *Stream) const
 Upgrade an object. More...
 
virtual void assign (IStringStream &Stream)
 
virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, IStream *Stream) const
 Down grade an object. More...
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, IStream *Stream) const
 Upgrade an object. More...
 
virtual void assign (IStringStream &Stream)
 
virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, IStream *Stream) const
 Down grade an object. More...
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, IStream *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 class_type getClass () const
 Retrieve the class identifier. More...
 

Private Types

typedef LT internal_length_type
 
typedef CKT internal_chkType_type
 
typedef CT internal_class_type
 
typedef IT internal_instance_type
 
typedef LT internal_length_type
 
typedef CKT internal_chkType_type
 
typedef CT internal_class_type
 
typedef IT internal_instance_type
 
typedef LT internal_length_type
 
typedef CKT internal_chkType_type
 
typedef CT internal_class_type
 
typedef IT internal_instance_type
 

Private Member Functions

 StreamRef2 (IStream &Stream)
 
 StreamRef2 (const StreamRef2 &Source)
 
 StreamRef2 (IStream &Stream)
 
 StreamRef2 (const StreamRef2 &Source)
 
 StreamRef2 (IStream &Stream)
 
 StreamRef2 (const StreamRef2 &Source)
 

Private Attributes

internal_length_type m_length
 
internal_chkType_type m_chkType
 
internal_class_type m_class
 
internal_instance_type m_instance
 
const Description *const m_desc
 Description for parent class. More...
 

Static Private Attributes

static const FrameSpec::Info::frame_object_types s_object_id
 

Detailed Description

template<class LT, class CKT, class CT, class IT>
class FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >

Generalized common elements of frame structure.

This templated implementation simplifies the actual implementation of the common elements of all frame structures by having each of the storage elements have a separate template parameter.

This implementation supports versions of the frame specification which require the chkType field.

Template Parameters
LTData type for the length field.
CKTData type for the chkType field.
CTData type for the class field.
ITData type for the instance field.

Member Typedef Documentation

◆ class_type [1/3]

◆ class_type [2/3]

◆ class_type [3/3]

◆ demote_arg_type [1/3]

◆ demote_arg_type [2/3]

◆ demote_arg_type [3/3]

◆ demote_ret_type [1/3]

◆ demote_ret_type [2/3]

◆ demote_ret_type [3/3]

◆ frame_spec_version_type [1/3]

◆ frame_spec_version_type [2/3]

◆ frame_spec_version_type [3/3]

◆ instance_type [1/3]

◆ instance_type [2/3]

◆ instance_type [3/3]

◆ internal_chkType_type [1/3]

template<class LT , class CKT , class CT , class IT >
typedef CKT FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::internal_chkType_type
private

◆ internal_chkType_type [2/3]

template<class LT , class CKT , class CT , class IT >
typedef CKT FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::internal_chkType_type
private

◆ internal_chkType_type [3/3]

template<class LT , class CKT , class CT , class IT >
typedef CKT FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::internal_chkType_type
private

◆ internal_class_type [1/3]

template<class LT , class CKT , class CT , class IT >
typedef CT FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::internal_class_type
private

◆ internal_class_type [2/3]

template<class LT , class CKT , class CT , class IT >
typedef CT FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::internal_class_type
private

◆ internal_class_type [3/3]

template<class LT , class CKT , class CT , class IT >
typedef CT FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::internal_class_type
private

◆ internal_instance_type [1/3]

template<class LT , class CKT , class CT , class IT >
typedef IT FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::internal_instance_type
private

◆ internal_instance_type [2/3]

template<class LT , class CKT , class CT , class IT >
typedef IT FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::internal_instance_type
private

◆ internal_instance_type [3/3]

template<class LT , class CKT , class CT , class IT >
typedef IT FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::internal_instance_type
private

◆ internal_length_type [1/3]

template<class LT , class CKT , class CT , class IT >
typedef LT FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::internal_length_type
private

◆ internal_length_type [2/3]

template<class LT , class CKT , class CT , class IT >
typedef LT FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::internal_length_type
private

◆ internal_length_type [3/3]

template<class LT , class CKT , class CT , class IT >
typedef LT FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::internal_length_type
private

◆ length_type [1/3]

◆ length_type [2/3]

◆ length_type [3/3]

◆ object_type [1/3]

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

◆ object_type [2/3]

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

◆ object_type [3/3]

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

◆ promote_arg_type [1/3]

◆ promote_arg_type [2/3]

◆ promote_arg_type [3/3]

◆ promote_ret_type [1/3]

◆ promote_ret_type [2/3]

◆ promote_ret_type [3/3]

◆ self_type [1/3]

template<class LT , class CKT , class CT , class IT >
typedef StreamRef2< LT, CKT, CT, IT > FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::self_type

◆ self_type [2/3]

template<class LT , class CKT , class CT , class IT >
typedef StreamRef2< LT, CKT, CT, IT > FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::self_type

◆ self_type [3/3]

template<class LT , class CKT , class CT , class IT >
typedef StreamRef2< LT, CKT, CT, IT > FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::self_type

◆ unique_object_type [1/3]

◆ unique_object_type [2/3]

◆ unique_object_type [3/3]

Constructor & Destructor Documentation

◆ StreamRef2() [1/9]

template<typename LT , typename CKT , typename CT , typename IT >
FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::StreamRef2

Constructor.

◆ ~StreamRef2() [1/3]

template<typename LT , typename CKT , typename CT , typename IT >
FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::~StreamRef2
virtual

Destructor.

◆ StreamRef2() [2/9]

template<typename LT , typename CKT , typename CT , typename IT >
FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::StreamRef2 ( IStream Stream)
private

◆ StreamRef2() [3/9]

template<typename LT , typename CKT , typename CT , typename IT >
FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::StreamRef2 ( const StreamRef2< LT, CKT, CT, IT > &  Source)
private

◆ StreamRef2() [4/9]

template<class LT , class CKT , class CT , class IT >
FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::StreamRef2 ( )

Constructor.

◆ ~StreamRef2() [2/3]

template<class LT , class CKT , class CT , class IT >
virtual FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::~StreamRef2 ( )
virtual

Destructor.

◆ StreamRef2() [5/9]

template<class LT , class CKT , class CT , class IT >
FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::StreamRef2 ( IStream Stream)
private

◆ StreamRef2() [6/9]

template<class LT , class CKT , class CT , class IT >
FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::StreamRef2 ( const StreamRef2< LT, CKT, CT, IT > &  Source)
private

◆ StreamRef2() [7/9]

template<class LT , class CKT , class CT , class IT >
FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::StreamRef2 ( )

Constructor.

◆ ~StreamRef2() [3/3]

template<class LT , class CKT , class CT , class IT >
virtual FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::~StreamRef2 ( )
virtual

Destructor.

◆ StreamRef2() [8/9]

template<class LT , class CKT , class CT , class IT >
FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::StreamRef2 ( IStream Stream)
private

◆ StreamRef2() [9/9]

template<class LT , class CKT , class CT , class IT >
FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::StreamRef2 ( const StreamRef2< LT, CKT, CT, IT > &  Source)
private

Member Function Documentation

◆ assign() [1/3]

template<typename LT , typename CKT , typename CT , typename IT >
void FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::assign ( IStringStream Stream)
inlineprotectedvirtual

◆ assign() [2/3]

template<class LT , class CKT , class CT , class IT >
virtual void FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::assign ( IStringStream Stream)
protectedvirtual

◆ assign() [3/3]

template<class LT , class CKT , class CT , class IT >
virtual void FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::assign ( IStringStream Stream)
protectedvirtual

◆ Bytes() [1/6]

template<typename LT , typename CKT , typename CT , typename IT >
cmn_streamsize_type FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::Bytes
inlinestatic

◆ Bytes() [2/6]

template<class LT , class CKT , class CT , class IT >
static FrameSpec::size_type FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::Bytes ( )
static

◆ Bytes() [3/6]

template<class LT , class CKT , class CT , class IT >
static FrameSpec::size_type FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::Bytes ( )
static

◆ Bytes() [4/6]

template<typename LT , typename CKT , typename CT , typename IT >
cmn_streamsize_type FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::Bytes ( const 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() [5/6]

template<class LT , class CKT , class CT , class IT >
FrameSpec::size_type FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::Bytes ( const 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() [6/6]

template<class LT , class CKT , class CT , class IT >
FrameSpec::size_type FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::Bytes ( const 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.

◆ Clone() [1/3]

template<typename LT , typename CKT , typename CT , typename IT >
StreamRef2< LT, CKT, CT, IT > * FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::Clone
inlinevirtual

constructor - virtual copy constructor

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

◆ Clone() [2/3]

template<class LT , class CKT , class CT , class IT >
virtual self_type* FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::Clone ( ) const
virtual

constructor - virtual copy constructor

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

◆ Clone() [3/3]

template<class LT , class CKT , class CT , class IT >
virtual self_type* FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::Clone ( ) const
virtual

constructor - virtual copy constructor

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

◆ Create() [1/5]

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

◆ Create() [2/5]

template<typename LT , typename CKT , typename CT , typename IT >
StreamRef2< LT, CKT, CT, IT > * FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::Create ( IStream Stream) const
inlinevirtual

constructor - virtual

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

◆ Create() [3/5]

template<class LT , class CKT , class CT , class IT >
virtual self_type* FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::Create ( IStream Stream) const
virtual

constructor - virtual

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

◆ Create() [4/5]

template<class LT , class CKT , class CT , class IT >
virtual self_type* FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::Create ( IStream Stream) const
virtual

constructor - virtual

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

◆ Create() [5/5]

FrameSpec::Object * FrameCPP::Common::FrameSpec::ObjectInterface::Create ( std::istream &  Buffer) const
virtualinherited

◆ demote() [1/3]

template<typename LT , typename CKT , typename CT , typename IT >
StreamRef2< LT, CKT, CT, IT >::demote_ret_type FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::demote ( INT_2U  Target,
demote_arg_type  Obj,
IStream Stream 
) const
protectedvirtual

Down grade an object.

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

◆ demote() [2/3]

template<class LT , class CKT , class CT , class IT >
virtual demote_ret_type FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::demote ( INT_2U  Target,
demote_arg_type  Obj,
IStream Stream 
) const
protectedvirtual

Down grade an object.

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

◆ demote() [3/3]

template<class LT , class CKT , class CT , class IT >
virtual demote_ret_type FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::demote ( INT_2U  Target,
demote_arg_type  Obj,
IStream Stream 
) const
protectedvirtual

Down grade an object.

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

◆ DemoteObject() [1/3]

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

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.

◆ DemoteObject() [3/3]

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.

◆ GetChkType() [1/3]

template<typename LT , typename CKT , typename CT , typename IT >
StreamRef2< LT, CKT, CT, IT >::class_type FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::GetChkType
inlinevirtual

◆ GetChkType() [2/3]

template<class LT , class CKT , class CT , class IT >
virtual INT_2U FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::GetChkType ( ) const
virtual

◆ GetChkType() [3/3]

template<class LT , class CKT , class CT , class IT >
virtual INT_2U FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::GetChkType ( ) const
virtual

◆ getClass() [1/3]

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

Retrieve the class identifier.

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

◆ GetClass() [1/3]

template<typename LT , typename CKT , typename CT , typename IT >
StreamRef2< LT, CKT, CT, IT >::class_type FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::GetClass
inlinevirtual

◆ getClass() [2/3]

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

Retrieve the class identifier.

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

◆ GetClass() [2/3]

template<class LT , class CKT , class CT , class IT >
virtual class_type FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::GetClass ( ) const
virtual

◆ getClass() [3/3]

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

Retrieve the class identifier.

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

◆ GetClass() [3/3]

template<class LT , class CKT , class CT , class IT >
virtual class_type FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::GetClass ( ) const
virtual

◆ GetDescription() [1/3]

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

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.

◆ GetDescription() [3/3]

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.

◆ GetInstance() [1/3]

template<typename LT , typename CKT , typename CT , typename IT >
StreamRef2< LT, CKT, CT, IT >::instance_type FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::GetInstance
inlinevirtual

◆ GetInstance() [2/3]

template<class LT , class CKT , class CT , class IT >
virtual instance_type FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::GetInstance ( ) const
virtual

◆ GetInstance() [3/3]

template<class LT , class CKT , class CT , class IT >
virtual instance_type FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::GetInstance ( ) const
virtual

◆ GetLength() [1/3]

template<typename LT , typename CKT , typename CT , typename IT >
StreamRef2< LT, CKT, CT, IT >::length_type FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::GetLength
inlinevirtual

◆ GetLength() [2/3]

template<class LT , class CKT , class CT , class IT >
virtual length_type FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::GetLength ( ) const
virtual

◆ GetLength() [3/3]

template<class LT , class CKT , class CT , class IT >
virtual length_type FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::GetLength ( ) const
virtual

◆ ObjectStructName() [1/3]

template<typename LT , typename CKT , typename CT , typename IT >
const char * FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::ObjectStructName ( ) const
inlinevirtual

Retrieve the class name of the object.

Returns
The name of the class associated with the object.

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

◆ ObjectStructName() [2/3]

template<class LT , class CKT , class CT , class IT >
virtual const char* FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::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() [3/3]

template<class LT , class CKT , class CT , class IT >
virtual const char* FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::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/6]

template<typename LT , typename CKT , typename CT , typename IT >
bool FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::operator== ( const Common::FrameSpec::Object Obj) const
inlinevirtual

comparison operator

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

◆ operator==() [2/6]

template<class LT , class CKT , class CT , class IT >
virtual bool FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::operator== ( const Common::FrameSpec::Object Obj) const
virtual

comparison operator

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

◆ operator==() [3/6]

template<class LT , class CKT , class CT , class IT >
virtual bool FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::operator== ( const Common::FrameSpec::Object Obj) const
virtual

comparison operator

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

◆ operator==() [4/6]

template<typename LT , typename CKT , typename CT , typename IT >
bool FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::operator== ( const StreamRef2< LT, CKT, CT, IT > &  RHS) const
inlinevirtual

comparison operator

◆ operator==() [5/6]

template<class LT , class CKT , class CT , class IT >
virtual bool FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::operator== ( const StreamRef2< LT, CKT, CT, IT > &  RHS) const
virtual

comparison operator

◆ operator==() [6/6]

template<class LT , class CKT , class CT , class IT >
virtual bool FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::operator== ( const StreamRef2< LT, CKT, CT, IT > &  RHS) const
virtual

comparison operator

◆ promote() [1/3]

template<typename LT , typename CKT , typename CT , typename IT >
StreamRef2< LT, CKT, CT, IT >::promote_ret_type FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::promote ( INT_2U  Target,
promote_arg_type  Obj,
IStream Stream 
) const
protectedvirtual

Upgrade an object.

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

◆ promote() [2/3]

template<class LT , class CKT , class CT , class IT >
virtual promote_ret_type FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::promote ( INT_2U  Target,
promote_arg_type  Obj,
IStream Stream 
) const
protectedvirtual

Upgrade an object.

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

◆ promote() [3/3]

template<class LT , class CKT , class CT , class IT >
virtual promote_ret_type FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::promote ( INT_2U  Target,
promote_arg_type  Obj,
IStream Stream 
) const
protectedvirtual

Upgrade an object.

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

◆ PromoteObject() [1/7]

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

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

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

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

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() [6/7]

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() [7/7]

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

◆ SetChkType() [1/3]

template<typename LT , typename CKT , typename CT , typename IT >
void FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::SetChkType ( INT_2U  ChkType)
inlinevirtual

◆ SetChkType() [2/3]

template<class LT , class CKT , class CT , class IT >
virtual void FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::SetChkType ( INT_2U  ChkType)
virtual

◆ SetChkType() [3/3]

template<class LT , class CKT , class CT , class IT >
virtual void FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::SetChkType ( INT_2U  ChkType)
virtual

◆ SetClass() [1/3]

template<typename LT , typename CKT , typename CT , typename IT >
void FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::SetClass ( class_type  Class)
inlinevirtual

◆ SetClass() [2/3]

template<class LT , class CKT , class CT , class IT >
virtual void FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::SetClass ( class_type  Class)
virtual

◆ SetClass() [3/3]

template<class LT , class CKT , class CT , class IT >
virtual void FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::SetClass ( class_type  Class)
virtual

◆ SetInstance() [1/3]

template<typename LT , typename CKT , typename CT , typename IT >
void FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::SetInstance ( instance_type  Instance)
inlinevirtual

◆ SetInstance() [2/3]

template<class LT , class CKT , class CT , class IT >
virtual void FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::SetInstance ( instance_type  Instance)
virtual

◆ SetInstance() [3/3]

template<class LT , class CKT , class CT , class IT >
virtual void FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::SetInstance ( instance_type  Instance)
virtual

◆ SetLength() [1/3]

template<typename LT , typename CKT , typename CT , typename IT >
void FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::SetLength ( length_type  Length)
inlinevirtual

◆ SetLength() [2/3]

template<class LT , class CKT , class CT , class IT >
virtual void FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::SetLength ( length_type  Length)
virtual

◆ SetLength() [3/3]

template<class LT , class CKT , class CT , class IT >
virtual void FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::SetLength ( length_type  Length)
virtual

◆ SizeOf() [1/3]

template<typename LT , typename CKT , typename CT , typename IT >
FrameSpec::size_type FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::SizeOf
virtual

◆ SizeOf() [2/3]

template<class LT , class CKT , class CT , class IT >
virtual FrameSpec::size_type FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::SizeOf ( ) const
virtual

◆ SizeOf() [3/3]

template<class LT , class CKT , class CT , class IT >
virtual FrameSpec::size_type FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::SizeOf ( ) const
virtual

◆ VerifyObject() [1/3]

void FrameCPP::Common::FrameSpec::ObjectInterface::VerifyObject ( Verify Verifier,
IFrameStream Stream 
) const
virtualinherited

◆ VerifyObject() [2/3]

virtual void FrameCPP::Common::FrameSpec::ObjectInterface::VerifyObject ( Verify Verifier,
IFrameStream Stream 
) const
virtualinherited

◆ VerifyObject() [3/3]

virtual void FrameCPP::Common::FrameSpec::ObjectInterface::VerifyObject ( Verify Verifier,
IFrameStream Stream 
) const
virtualinherited

◆ Write() [1/3]

template<typename LT , typename CKT , typename CT , typename IT >
void FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::Write ( OStream Stream) const
inlinevirtual

Write object to the stream.

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

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

◆ Write() [2/3]

template<class LT , class CKT , class CT , class IT >
virtual void FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::Write ( OStream Stream) const
virtual

Write object to the stream.

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

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

◆ Write() [3/3]

template<class LT , class CKT , class CT , class IT >
virtual void FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::Write ( OStream Stream) const
virtual

Write object to the stream.

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

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

◆ WriteNext() [1/3]

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

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() [3/3]

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_chkType

template<class LT , class CKT , class CT , class IT >
internal_chkType_type FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::m_chkType
private

◆ m_class

template<class LT , class CKT , class CT , class IT >
internal_class_type FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::m_class
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_instance

template<class LT , class CKT , class CT , class IT >
internal_instance_type FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::m_instance
private

◆ m_length

template<class LT , class CKT , class CT , class IT >
internal_length_type FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::m_length
private

◆ s_object_id

static const FrameSpec::Info::frame_object_types FrameCPP::Common::StreamRefInterface::s_object_id
staticprivateinherited
Initial value:

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