ldas-tools-framecpp  2.8.1
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | Private Types | Private Member Functions | Private Attributes | List of all members
FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T > Class Template Reference

#include <FrSHClassicIO.hh>

Inheritance diagram for FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >:
Inheritance graph
[legend]
Collaboration diagram for FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >:
Collaboration graph
[legend]

Public Types

typedef std::string name_type
 
typedef std::string name_type
 
typedef std::string name_type
 
typedef std::string comment_type
 Comment. More...
 
typedef std::string comment_type
 Comment. More...
 
typedef std::string comment_type
 Comment. More...
 
typedef INT_2U class_type
 Class number of structure being described. More...
 
typedef INT_2U class_type
 Class number of structure being described. More...
 
typedef INT_2U class_type
 Class number of structure being described. More...
 
typedef const char *const struct_name_type
 
typedef const char *const struct_name_type
 
typedef const char *const struct_name_type
 
typedef const char *const struct_desc_type
 
typedef const char *const struct_desc_type
 
typedef const char *const struct_desc_type
 
typedef INT_2U const struct_id_type
 
typedef INT_2U const struct_id_type
 
typedef INT_2U const struct_id_type
 
typedef ObjectWithChecksum< ObjectType, ChecksumType > self_type
 
typedef ObjectWithChecksum< ObjectType, ChecksumType > self_type
 
typedef ObjectWithChecksum< ObjectType, ChecksumType > self_type
 
typedef IStream istream_type
 
typedef IStream istream_type
 
typedef IStream istream_type
 
typedef OStream ostream_type
 
typedef OStream ostream_type
 
typedef OStream ostream_type
 

Public Member Functions

 ClassicIO ()
 
virtual const char * ObjectStructName () const
 The name structure name of this object. More...
 
Common::FrameSpec::ObjectClone () const
 
 ClassicIO ()
 
virtual const char * ObjectStructName () const
 The name structure name of this object. More...
 
Common::FrameSpec::ObjectClone () const
 
 ClassicIO ()
 
virtual const char * ObjectStructName () const
 The name structure name of this object. More...
 
Common::FrameSpec::ObjectClone () const
 
class_type GetClass () const
 Return class of object. More...
 
class_type GetClass () const
 Return class of object. More...
 
class_type GetClass () const
 Return class of object. More...
 
const comment_typeGetComment () const
 Return comment of object. More...
 
const comment_typeGetComment () const
 Return comment of object. More...
 
const comment_typeGetComment () const
 Return comment of object. More...
 
const name_typeGetName () const
 Return name of object. More...
 
const name_typeGetName () const
 Return name of object. More...
 
const name_typeGetName () const
 Return name of object. More...
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object. More...
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object. More...
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object. More...
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor. More...
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor. More...
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor. More...
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream. More...
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream. More...
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream. More...
 

Static Public Member Functions

static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream)
 Promote previous version of object to this version. More...
 
static const Common::DescriptionStructDescription ()
 The description of structure. More...
 
static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream)
 Promote previous version of object to this version. More...
 
static const Common::DescriptionStructDescription ()
 The description of structure. More...
 
static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream)
 Promote previous version of object to this version. More...
 
static const Common::DescriptionStructDescription ()
 The description of structure. More...
 
static struct_name_type FrameSpecName ()
 
static struct_name_type FrameSpecName ()
 
static struct_name_type FrameSpecName ()
 
static struct_name_type StructName ()
 
static struct_name_type StructName ()
 
static struct_name_type StructName ()
 
static struct_desc_type FrameSpecDescription ()
 Return the dictionary name of the structure. More...
 
static struct_desc_type FrameSpecDescription ()
 Return the dictionary name of the structure. More...
 
static struct_desc_type FrameSpecDescription ()
 Return the dictionary name of the structure. More...
 
static struct_id_type FrameSpecId ()
 Return the dictionary name of the structure. More...
 
static struct_id_type FrameSpecId ()
 Return the dictionary name of the structure. More...
 
static struct_id_type FrameSpecId ()
 Return the dictionary name of the structure. More...
 
static const char * CheckSumDataClass ()
 Data class to be used in class field of FrSE. More...
 
static const char * CheckSumDataClass ()
 Data class to be used in class field of FrSE. More...
 
static const char * CheckSumDataClass ()
 Data class to be used in class field of FrSE. More...
 
static const char * CheckSumDataComment ()
 Comment to be used in comment field of FrSE. More...
 
static const char * CheckSumDataComment ()
 Comment to be used in comment field of FrSE. More...
 
static const char * CheckSumDataComment ()
 Comment to be used in comment field of FrSE. More...
 

Static Public Attributes

static struct_name_type struct_name
 
static struct_desc_type struct_desc
 
static struct_id_type struct_id
 

Protected Types

typedef STRING io_name_type
 
typedef STRING io_comment_type
 
typedef STRING io_name_type
 
typedef STRING io_comment_type
 
typedef STRING io_name_type
 
typedef STRING io_comment_type
 

Protected Member Functions

virtual void assign (assign_stream_type &Stream)
 Assign the contents of the instance. More...
 
virtual const std::string & name () const
 
virtual cmn_classId_type classId () const
 
virtual demote_ret_type demote (frame_spec_version_type Target, demote_arg_type Obj, istream_type *Stream) const
 Demotes object to previous version of the frame spec. More...
 
virtual promote_ret_type promote (frame_spec_version_type Target, promote_arg_type Obj, istream_type *Stream) const
 Promotes object to another version of the frame spec. More...
 
cmn_streamsize_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure. More...
 
virtual self_typepCreate (istream_type &Stream) const
 Virtual constructor. More...
 
virtual void pWrite (ostream_type &Stream) const
 Write the structure to the stream. More...
 
virtual void assign (assign_stream_type &Stream)
 Assign the contents of the instance. More...
 
virtual const std::string & name () const
 
virtual cmn_classId_type classId () const
 
virtual demote_ret_type demote (frame_spec_version_type Target, demote_arg_type Obj, istream_type *Stream) const
 Demotes object to previous version of the frame spec. More...
 
virtual promote_ret_type promote (frame_spec_version_type Target, promote_arg_type Obj, istream_type *Stream) const
 Promotes object to another version of the frame spec. More...
 
cmn_streamsize_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure. More...
 
virtual self_typepCreate (istream_type &Stream) const
 Virtual constructor. More...
 
virtual void pWrite (ostream_type &Stream) const
 Write the structure to the stream. More...
 
virtual void assign (assign_stream_type &Stream)
 Assign the contents of the instance. More...
 
virtual const std::string & name () const
 
virtual cmn_classId_type classId () const
 
virtual demote_ret_type demote (frame_spec_version_type Target, demote_arg_type Obj, istream_type *Stream) const
 Demotes object to previous version of the frame spec. More...
 
virtual promote_ret_type promote (frame_spec_version_type Target, promote_arg_type Obj, istream_type *Stream) const
 Promotes object to another version of the frame spec. More...
 
cmn_streamsize_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure. More...
 
virtual self_typepCreate (istream_type &Stream) const
 Virtual constructor. More...
 
virtual void pWrite (ostream_type &Stream) const
 Write the structure to the stream. More...
 

Protected Attributes

name_type name
 
comment_type comment
 
class_type klass
 

Private Types

typedef ObjectWithChecksum< Common::FrameSpec::Objectobject_type
 
typedef ObjectWithChecksum< Common::FrameSpec::Objectobject_type
 
typedef ObjectWithChecksum< Common::FrameSpec::Objectobject_type
 
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_typeobject_base_type
 
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_typeobject_base_type
 
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_typeobject_base_type
 

Private Member Functions

virtual ObjectCreate () const
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual More...
 
virtual ObjectCreate () const
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual More...
 
virtual ObjectCreate () const
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual More...
 

Private Attributes

ChecksumType m_chkSum
 Structure checksum. More...
 

Member Typedef Documentation

◆ class_type [1/3]

Class number of structure being described.

◆ class_type [2/3]

Class number of structure being described.

◆ class_type [3/3]

Class number of structure being described.

◆ comment_type [1/3]

Comment.

◆ comment_type [2/3]

Comment.

◆ comment_type [3/3]

Comment.

◆ io_comment_type [1/3]

template<typename FR_SH_T >
typedef STRING FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::io_comment_type
protected

◆ io_comment_type [2/3]

template<typename FR_SH_T >
typedef STRING FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::io_comment_type
protected

◆ io_comment_type [3/3]

template<typename FR_SH_T >
typedef STRING FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::io_comment_type
protected

◆ io_name_type [1/3]

template<typename FR_SH_T >
typedef STRING FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::io_name_type
protected

◆ io_name_type [2/3]

template<typename FR_SH_T >
typedef STRING FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::io_name_type
protected

◆ io_name_type [3/3]

template<typename FR_SH_T >
typedef STRING FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::io_name_type
protected

◆ istream_type [1/3]

template<typename ObjectType , typename ChecksumType >
typedef IStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::istream_type
inherited

◆ istream_type [2/3]

template<typename ObjectType , typename ChecksumType >
typedef IStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::istream_type
inherited

◆ istream_type [3/3]

template<typename ObjectType , typename ChecksumType >
typedef IStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::istream_type
inherited

◆ name_type [1/3]

typedef std::string FrameCPP::Version_8::FrSHImpl::Data::name_type
inherited

Name of structure being described by this dictionary structure

◆ name_type [2/3]

typedef std::string FrameCPP::Version_8::FrSHImpl::Data::name_type
inherited

Name of structure being described by this dictionary structure

◆ name_type [3/3]

typedef std::string FrameCPP::Version_8::FrSHImpl::Data::name_type
inherited

Name of structure being described by this dictionary structure

◆ object_base_type [1/3]

◆ object_base_type [2/3]

◆ object_base_type [3/3]

◆ object_type [1/3]

template<typename FR_SH_T >
typedef ObjectWithChecksum< Common::FrameSpec::Object > FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::object_type
private

◆ object_type [2/3]

template<typename FR_SH_T >
typedef ObjectWithChecksum< Common::FrameSpec::Object > FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::object_type
private

◆ object_type [3/3]

template<typename FR_SH_T >
typedef ObjectWithChecksum< Common::FrameSpec::Object > FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::object_type
private

◆ ostream_type [1/3]

template<typename ObjectType , typename ChecksumType >
typedef OStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::ostream_type
inherited

◆ ostream_type [2/3]

template<typename ObjectType , typename ChecksumType >
typedef OStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::ostream_type
inherited

◆ ostream_type [3/3]

template<typename ObjectType , typename ChecksumType >
typedef OStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::ostream_type
inherited

◆ self_type [1/3]

template<typename ObjectType , typename ChecksumType >
typedef ObjectWithChecksum< ObjectType, ChecksumType > FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::self_type
inherited

◆ self_type [2/3]

template<typename ObjectType , typename ChecksumType >
typedef ObjectWithChecksum< ObjectType, ChecksumType > FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::self_type
inherited

◆ self_type [3/3]

template<typename ObjectType , typename ChecksumType >
typedef ObjectWithChecksum< ObjectType, ChecksumType > FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::self_type
inherited

◆ struct_desc_type [1/3]

typedef const char* const FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::struct_desc_type
inherited

◆ struct_desc_type [2/3]

typedef const char* const FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::struct_desc_type
inherited

◆ struct_desc_type [3/3]

typedef const char* const FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::struct_desc_type
inherited

◆ struct_id_type [1/3]

◆ struct_id_type [2/3]

◆ struct_id_type [3/3]

◆ struct_name_type [1/3]

typedef const char* const FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::struct_name_type
inherited

◆ struct_name_type [2/3]

typedef const char* const FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::struct_name_type
inherited

◆ struct_name_type [3/3]

typedef const char* const FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::struct_name_type
inherited

Constructor & Destructor Documentation

◆ ClassicIO() [1/3]

template<typename FR_SH_T >
FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::ClassicIO ( )
inline

◆ ClassicIO() [2/3]

template<typename FR_SH_T >
FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::ClassicIO ( )
inline

◆ ClassicIO() [3/3]

template<typename FR_SH_T >
FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::ClassicIO ( )
inline

Member Function Documentation

◆ assign() [1/3]

template<typename FR_SH_T >
virtual void FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::assign ( assign_stream_type &  Stream)
inlineprotectedvirtual

Assign the contents of the instance.

Parameters
[in]StreamAn input stream from which to read information for the instance.

◆ assign() [2/3]

template<typename FR_SH_T >
virtual void FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::assign ( assign_stream_type &  Stream)
inlineprotectedvirtual

Assign the contents of the instance.

Parameters
[in]StreamAn input stream from which to read information for the instance.

◆ assign() [3/3]

template<typename FR_SH_T >
virtual void FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::assign ( assign_stream_type &  Stream)
inlineprotectedvirtual

Assign the contents of the instance.

Parameters
[in]StreamAn input stream from which to read information for the instance.

◆ Bytes() [1/3]

template<typename ObjectType , typename ChecksumType >
virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Bytes ( const StreamBase Stream) const
virtualinherited

Return the number of bytes for this object.

Parameters
[in]StreamStream characteristics used to determine the number of bytes needed to format the object for the Stream.
Returns
The number of bytes for this object

◆ Bytes() [2/3]

template<typename ObjectType , typename ChecksumType >
virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Bytes ( const StreamBase Stream) const
virtualinherited

Return the number of bytes for this object.

Parameters
[in]StreamStream characteristics used to determine the number of bytes needed to format the object for the Stream.
Returns
The number of bytes for this object

◆ Bytes() [3/3]

template<typename ObjectType , typename ChecksumType >
virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Bytes ( const StreamBase Stream) const
virtualinherited

Return the number of bytes for this object.

Parameters
[in]StreamStream characteristics used to determine the number of bytes needed to format the object for the Stream.
Returns
The number of bytes for this object

◆ CheckSumDataClass() [1/3]

template<typename ObjectType , typename ChecksumType >
template const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataClass ( )
staticinherited

Data class to be used in class field of FrSE.

◆ CheckSumDataClass() [2/3]

template<typename ObjectType , typename ChecksumType >
static const char* FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataClass ( )
staticinherited

Data class to be used in class field of FrSE.

◆ CheckSumDataClass() [3/3]

template<typename ObjectType , typename ChecksumType >
static const char* FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataClass ( )
staticinherited

Data class to be used in class field of FrSE.

◆ CheckSumDataComment() [1/3]

template<typename ObjectType , typename ChecksumType >
template const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataComment ( )
staticinherited

Comment to be used in comment field of FrSE.

◆ CheckSumDataComment() [2/3]

template<typename ObjectType , typename ChecksumType >
static const char* FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataComment ( )
staticinherited

Comment to be used in comment field of FrSE.

◆ CheckSumDataComment() [3/3]

template<typename ObjectType , typename ChecksumType >
static const char* FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataComment ( )
staticinherited

Comment to be used in comment field of FrSE.

◆ classId() [1/3]

template<typename FR_SH_T >
virtual cmn_classId_type FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::classId ( ) const
inlineprotectedvirtual

◆ classId() [2/3]

template<typename FR_SH_T >
virtual cmn_classId_type FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::classId ( ) const
inlineprotectedvirtual

◆ classId() [3/3]

template<typename FR_SH_T >
virtual cmn_classId_type FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::classId ( ) const
inlineprotectedvirtual

◆ Clone() [1/3]

template<typename FR_SH_T >
Common::FrameSpec::Object* FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::Clone ( ) const
inline

◆ Clone() [2/3]

template<typename FR_SH_T >
Common::FrameSpec::Object* FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::Clone ( ) const
inline

◆ Clone() [3/3]

template<typename FR_SH_T >
Common::FrameSpec::Object* FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::Clone ( ) const
inline

◆ Create() [1/9]

template<typename ObjectType , typename ChecksumType >
virtual Object* FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( ) const
inlineprivatevirtualinherited

◆ Create() [2/9]

template<typename ObjectType , typename ChecksumType >
virtual Object* FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( ) const
inlineprivatevirtualinherited

◆ Create() [3/9]

template<typename ObjectType , typename ChecksumType >
virtual Object* FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( ) const
inlineprivatevirtualinherited

◆ Create() [4/9]

template<typename ObjectType , typename ChecksumType >
virtual self_type* FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( istream_type Stream) const
virtualinherited

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.
Returns
Return pointer to the newly allocated resource.

◆ Create() [5/9]

template<typename ObjectType , typename ChecksumType >
virtual self_type* FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( istream_type Stream) const
virtualinherited

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.
Returns
Return pointer to the newly allocated resource.

◆ Create() [6/9]

template<typename ObjectType , typename ChecksumType >
virtual self_type* FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( istream_type Stream) const
virtualinherited

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.
Returns
Return pointer to the newly allocated resource.

◆ Create() [7/9]

template<typename ObjectType , typename ChecksumType >
virtual Object* FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( std::istream &  Buffer) const
inlineprivatevirtualinherited

constructor - virtual

◆ Create() [8/9]

template<typename ObjectType , typename ChecksumType >
virtual Object* FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( std::istream &  Buffer) const
inlineprivatevirtualinherited

constructor - virtual

◆ Create() [9/9]

template<typename ObjectType , typename ChecksumType >
virtual Object* FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( std::istream &  Buffer) const
inlineprivatevirtualinherited

constructor - virtual

◆ demote() [1/3]

template<typename FR_SH_T >
virtual demote_ret_type FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::demote ( frame_spec_version_type  Target,
demote_arg_type  Obj,
istream_type Stream 
) const
inlineprotectedvirtual

Demotes object to previous version of the frame spec.

Parameters
[in]TargetThe version of the frame specification to demote too.
[in]ObjThe version of the object to demote.
[in]StreamThe input stream from which the original object was read.
Returns
An object of the previous generation.

◆ demote() [2/3]

template<typename FR_SH_T >
virtual demote_ret_type FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::demote ( frame_spec_version_type  Target,
demote_arg_type  Obj,
istream_type Stream 
) const
inlineprotectedvirtual

Demotes object to previous version of the frame spec.

Parameters
[in]TargetThe version of the frame specification to demote too.
[in]ObjThe version of the object to demote.
[in]StreamThe input stream from which the original object was read.
Returns
An object of the previous generation.

◆ demote() [3/3]

template<typename FR_SH_T >
virtual demote_ret_type FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::demote ( frame_spec_version_type  Target,
demote_arg_type  Obj,
istream_type Stream 
) const
inlineprotectedvirtual

Demotes object to previous version of the frame spec.

Parameters
[in]TargetThe version of the frame specification to demote too.
[in]ObjThe version of the object to demote.
[in]StreamThe input stream from which the original object was read.
Returns
An object of the previous generation.

◆ FrameSpecDescription() [1/3]

static struct_desc_type FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::FrameSpecDescription ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecDescription() [2/3]

static struct_desc_type FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::FrameSpecDescription ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecDescription() [3/3]

static struct_desc_type FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::FrameSpecDescription ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecId() [1/3]

static struct_id_type FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::FrameSpecId ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecId() [2/3]

static struct_id_type FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::FrameSpecId ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecId() [3/3]

static struct_id_type FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::FrameSpecId ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecName() [1/3]

static struct_name_type FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::FrameSpecName ( )
inlinestaticinherited

◆ FrameSpecName() [2/3]

static struct_name_type FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::FrameSpecName ( )
inlinestaticinherited

◆ FrameSpecName() [3/3]

static struct_name_type FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::FrameSpecName ( )
inlinestaticinherited

◆ GetClass() [1/3]

Data::class_type FrameCPP::Version_8::FrSHImpl::Data::GetClass ( ) const
inlineinherited

Return class of object.

Returns
Class number of structure being described

◆ GetClass() [2/3]

class_type FrameCPP::Version_8::FrSHImpl::Data::GetClass ( ) const
inherited

Return class of object.

Returns
Class number of structure being described

◆ GetClass() [3/3]

class_type FrameCPP::Version_8::FrSHImpl::Data::GetClass ( ) const
inherited

Return class of object.

Returns
Class number of structure being described

◆ GetComment() [1/3]

const Data::comment_type & FrameCPP::Version_8::FrSHImpl::Data::GetComment ( ) const
inlineinherited

Return comment of object.

Returns
Comment

◆ GetComment() [2/3]

const comment_type& FrameCPP::Version_8::FrSHImpl::Data::GetComment ( ) const
inherited

Return comment of object.

Returns
Comment

◆ GetComment() [3/3]

const comment_type& FrameCPP::Version_8::FrSHImpl::Data::GetComment ( ) const
inherited

Return comment of object.

Returns
Comment

◆ GetName() [1/3]

const Data::name_type & FrameCPP::Version_8::FrSHImpl::Data::GetName ( ) const
inlineinherited

Return name of object.

Returns
Name of structure being described by this dictionary structure

◆ GetName() [2/3]

const name_type& FrameCPP::Version_8::FrSHImpl::Data::GetName ( ) const
inherited

Return name of object.

Returns
Name of structure being described by this dictionary structure

◆ GetName() [3/3]

const name_type& FrameCPP::Version_8::FrSHImpl::Data::GetName ( ) const
inherited

Return name of object.

Returns
Name of structure being described by this dictionary structure

◆ name() [1/3]

template<typename FR_SH_T >
virtual const std::string& FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::name ( ) const
inlineprotectedvirtual
Todo:
See about storing name in this class and eliminate the need for this virtual method.

◆ name() [2/3]

template<typename FR_SH_T >
virtual const std::string& FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::name ( ) const
inlineprotectedvirtual
Todo:
See about storing name in this class and eliminate the need for this virtual method.

◆ name() [3/3]

template<typename FR_SH_T >
virtual const std::string& FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::name ( ) const
inlineprotectedvirtual
Todo:
See about storing name in this class and eliminate the need for this virtual method.

◆ ObjectStructName() [1/3]

template<typename FR_SH_T >
virtual const char* FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::ObjectStructName ( ) const
inlinevirtual

The name structure name of this object.

Returns
The name of the structure as specified by the frame specification.

◆ ObjectStructName() [2/3]

template<typename FR_SH_T >
virtual const char* FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::ObjectStructName ( ) const
inlinevirtual

The name structure name of this object.

Returns
The name of the structure as specified by the frame specification.

◆ ObjectStructName() [3/3]

template<typename FR_SH_T >
virtual const char* FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::ObjectStructName ( ) const
inlinevirtual

The name structure name of this object.

Returns
The name of the structure as specified by the frame specification.

◆ pBytes() [1/3]

template<typename FR_SH_T >
cmn_streamsize_type FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::pBytes ( const Common::StreamBase Stream) const
inlineprotectedvirtual

Number of bytes needed to write this structure.

Parameters
[in]StreamThe stream from which to the object is being read or written.
Returns
The number of bytes need to read or write this object.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.

◆ pBytes() [2/3]

template<typename FR_SH_T >
cmn_streamsize_type FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::pBytes ( const Common::StreamBase Stream) const
inlineprotectedvirtual

Number of bytes needed to write this structure.

Parameters
[in]StreamThe stream from which to the object is being read or written.
Returns
The number of bytes need to read or write this object.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.

◆ pBytes() [3/3]

template<typename FR_SH_T >
cmn_streamsize_type FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::pBytes ( const Common::StreamBase Stream) const
inlineprotectedvirtual

Number of bytes needed to write this structure.

Parameters
[in]StreamThe stream from which to the object is being read or written.
Returns
The number of bytes need to read or write this object.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.

◆ pCreate() [1/3]

template<typename FR_SH_T >
virtual self_type* FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::pCreate ( istream_type Stream) const
inlineprotectedvirtual

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.

◆ pCreate() [2/3]

template<typename FR_SH_T >
virtual self_type* FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::pCreate ( istream_type Stream) const
inlineprotectedvirtual

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.

◆ pCreate() [3/3]

template<typename FR_SH_T >
virtual self_type* FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::pCreate ( istream_type Stream) const
inlineprotectedvirtual

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.

◆ promote() [1/3]

template<typename FR_SH_T >
virtual promote_ret_type FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::promote ( frame_spec_version_type  Target,
promote_arg_type  Obj,
istream_type Stream 
) const
inlineprotectedvirtual

Promotes object to another version of the frame spec.

Parameters
[in]TargetThe version of the promoted frame specification.
[in]ObjThe object to be promoted.
[in]StreamThe input stream from which the original object was read.
Returns
An object promoted to the next generation.

◆ promote() [2/3]

template<typename FR_SH_T >
virtual promote_ret_type FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::promote ( frame_spec_version_type  Target,
promote_arg_type  Obj,
istream_type Stream 
) const
inlineprotectedvirtual

Promotes object to another version of the frame spec.

Parameters
[in]TargetThe version of the promoted frame specification.
[in]ObjThe object to be promoted.
[in]StreamThe input stream from which the original object was read.
Returns
An object promoted to the next generation.

◆ promote() [3/3]

template<typename FR_SH_T >
virtual promote_ret_type FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::promote ( frame_spec_version_type  Target,
promote_arg_type  Obj,
istream_type Stream 
) const
inlineprotectedvirtual

Promotes object to another version of the frame spec.

Parameters
[in]TargetThe version of the promoted frame specification.
[in]ObjThe object to be promoted.
[in]StreamThe input stream from which the original object was read.
Returns
An object promoted to the next generation.

◆ Promote() [1/3]

template<typename FR_SH_T >
static promote_ret_type FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::Promote ( INT_2U  Source,
promote_arg_type  Obj,
istream_type Stream 
)
inlinestatic

Promote previous version of object to this version.

Parameters
[in]SourceThe frame specification version of the object.
[in]ObjThe previous version of the object.
[in]StreamStream from which the origional object was created.
Returns
A new instance of FrameH based on Obj

◆ Promote() [2/3]

template<typename FR_SH_T >
static promote_ret_type FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::Promote ( INT_2U  Source,
promote_arg_type  Obj,
istream_type Stream 
)
inlinestatic

Promote previous version of object to this version.

Parameters
[in]SourceThe frame specification version of the object.
[in]ObjThe previous version of the object.
[in]StreamStream from which the origional object was created.
Returns
A new instance of FrameH based on Obj

◆ Promote() [3/3]

template<typename FR_SH_T >
static promote_ret_type FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::Promote ( INT_2U  Source,
promote_arg_type  Obj,
istream_type Stream 
)
inlinestatic

Promote previous version of object to this version.

Parameters
[in]SourceThe frame specification version of the object.
[in]ObjThe previous version of the object.
[in]StreamStream from which the origional object was created.
Returns
A new instance of FrameH based on Obj

◆ pWrite() [1/3]

template<typename FR_SH_T >
virtual void FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::pWrite ( ostream_type Stream) const
inlineprotectedvirtual

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.

◆ pWrite() [2/3]

template<typename FR_SH_T >
virtual void FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::pWrite ( ostream_type Stream) const
inlineprotectedvirtual

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.

◆ pWrite() [3/3]

template<typename FR_SH_T >
virtual void FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::pWrite ( ostream_type Stream) const
inlineprotectedvirtual

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.

◆ StructDescription() [1/3]

template<typename FR_SH_T >
static const Common::Description* FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::StructDescription ( )
inlinestatic

The description of structure.

Returns
A Description object which describes this structure as specified by the frame specification.

◆ StructDescription() [2/3]

template<typename FR_SH_T >
static const Common::Description* FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::StructDescription ( )
inlinestatic

The description of structure.

Returns
A Description object which describes this structure as specified by the frame specification.

◆ StructDescription() [3/3]

template<typename FR_SH_T >
static const Common::Description* FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::StructDescription ( )
inlinestatic

The description of structure.

Returns
A Description object which describes this structure as specified by the frame specification.

◆ StructName() [1/3]

static struct_name_type FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::StructName ( )
inlinestaticinherited

◆ StructName() [2/3]

static struct_name_type FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::StructName ( )
inlinestaticinherited

◆ StructName() [3/3]

static struct_name_type FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::StructName ( )
inlinestaticinherited

◆ Write() [1/3]

template<typename ObjectType , typename ChecksumType >
virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Write ( ostream_type Stream) const
virtualinherited

Write object to the stream.

◆ Write() [2/3]

template<typename ObjectType , typename ChecksumType >
virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Write ( ostream_type Stream) const
virtualinherited

Write object to the stream.

◆ Write() [3/3]

template<typename ObjectType , typename ChecksumType >
virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Write ( ostream_type Stream) const
virtualinherited

Write object to the stream.

Member Data Documentation

◆ comment

comment_type FrameCPP::Version_8::FrSHImpl::Data::comment
protectedinherited

Comment

◆ klass

class_type FrameCPP::Version_8::FrSHImpl::Data::klass
protectedinherited

Class number of structure being described

◆ m_chkSum

template<typename ObjectType , typename ChecksumType >
ChecksumType FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::m_chkSum
privateinherited

Structure checksum.

The checksum for the structure when the structure is contained in a stream.

◆ name

name_type FrameCPP::Version_8::FrSHImpl::Data::name
protectedinherited

Name of structure being described by this dictionary structure

◆ struct_desc

static struct_desc_type FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::struct_desc
staticinherited

◆ struct_id

static struct_id_type FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::struct_id
staticinherited

◆ struct_name

static struct_name_type FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::struct_name
staticinherited

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