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

#include <FrTableClassicIO.hh>

Inheritance diagram for FrameCPP::Version_8::FrTableImpl::ClassicIO< T >:
Inheritance graph
[legend]
Collaboration diagram for FrameCPP::Version_8::FrTableImpl::ClassicIO< 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
 
typedef std::string comment_type
 
typedef std::string comment_type
 
typedef INT_2U nColumn_type
 
typedef INT_2U nColumn_type
 
typedef INT_2U nColumn_type
 
typedef INT_4U nRow_type
 
typedef INT_4U nRow_type
 
typedef INT_4U nRow_type
 
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 TPTR_STRUCT ptr_struct_type
 
typedef TPTR_STRUCT ptr_struct_type
 
typedef TPTR_STRUCT ptr_struct_type
 
typedef TColumn column_type
 
typedef TColumn column_type
 
typedef TColumn column_type
 
typedef column_type::iterator iterator
 
typedef column_type::iterator iterator
 
typedef column_type::iterator iterator
 
typedef column_type::const_iterator const_iterator
 
typedef column_type::const_iterator const_iterator
 
typedef column_type::const_iterator const_iterator
 
typedef std::vector< STRINGcolumn_name_container_type
 Collection of column names. More...
 
typedef std::vector< STRINGcolumn_name_container_type
 Collection of column names. More...
 
typedef std::vector< STRINGcolumn_name_container_type
 Collection of column names. More...
 
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 ()
 
 ClassicIO ()
 
 ClassicIO ()
 
column_name_container_type GetColumnName () const
 Retrieve the list of column names. More...
 
column_name_container_type GetColumnName () const
 Retrieve the list of column names. More...
 
column_name_container_type GetColumnName () const
 Retrieve the list of column names. More...
 
nColumn_type GetNColumn () const
 Retrieve the number of columns. More...
 
nColumn_type GetNColumn () const
 Retrieve the number of columns. More...
 
nColumn_type GetNColumn () const
 Retrieve the number of columns. More...
 
nRow_type GetNRow () const
 Retrieve the number of rows. More...
 
nRow_type GetNRow () const
 Retrieve the number of rows. More...
 
nRow_type GetNRow () const
 Retrieve the number of rows. More...
 
const column_typeRefColumn () const
 Retrieve reference to columns. More...
 
column_typeRefColumn ()
 Retrieve reference to columns. More...
 
const column_typeRefColumn () const
 Retrieve reference to columns. More...
 
column_typeRefColumn ()
 Retrieve reference to columns. More...
 
const column_typeRefColumn () const
 Retrieve reference to columns. More...
 
column_typeRefColumn ()
 Retrieve reference to columns. More...
 
bool operator== (const FrTablePST &RHS)
 
bool operator== (const FrTablePST &RHS)
 
bool operator== (const FrTablePST &RHS)
 
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, Common::IStream *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, Common::IStream *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, Common::IStream *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
 
static const INT_2U MAX_REF = 1
 

Protected Member Functions

virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, Common::IStream *Stream) const
 Demotes object to previous version of the frame spec. More...
 
virtual const char * ObjectStructName () const
 The name structure name of this object. More...
 
virtual cmn_streamsize_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure. More...
 
virtual self_typepCreate (Common::IStream &Stream) const
 Virtual constructor. More...
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, Common::IStream *Stream) const
 Promotes object to another version of the frame spec. More...
 
virtual void pWrite (Common::OStream &Stream) const
 Write the structure to the stream. More...
 
virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, Common::IStream *Stream) const
 Demotes object to previous version of the frame spec. More...
 
virtual const char * ObjectStructName () const
 The name structure name of this object. More...
 
virtual cmn_streamsize_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure. More...
 
virtual self_typepCreate (Common::IStream &Stream) const
 Virtual constructor. More...
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, Common::IStream *Stream) const
 Promotes object to another version of the frame spec. More...
 
virtual void pWrite (Common::OStream &Stream) const
 Write the structure to the stream. More...
 
virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, Common::IStream *Stream) const
 Demotes object to previous version of the frame spec. More...
 
virtual const char * ObjectStructName () const
 The name structure name of this object. More...
 
virtual cmn_streamsize_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure. More...
 
virtual self_typepCreate (Common::IStream &Stream) const
 Virtual constructor. More...
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, Common::IStream *Stream) const
 Promotes object to another version of the frame spec. More...
 
virtual void pWrite (Common::OStream &Stream) const
 Write the structure to the stream. More...
 

Protected Attributes

refs_type m_refs
 

Private Types

typedef STRING io_name_type
 
typedef STRING io_comment_type
 
typedef ObjectWithChecksum< Common::FrameSpec::Objectobject_type
 Object with checksum data. More...
 
typedef STRING io_name_type
 
typedef STRING io_comment_type
 
typedef ObjectWithChecksum< Common::FrameSpec::Objectobject_type
 Object with checksum data. More...
 
typedef STRING io_name_type
 
typedef STRING io_comment_type
 
typedef ObjectWithChecksum< Common::FrameSpec::Objectobject_type
 Object with checksum data. More...
 
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_typeobject_base_type
 
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_typeobject_base_type
 
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, 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

◆ column_name_container_type [1/3]

template<typename TPTR_STRUCT , typename TColumn >
typedef std::vector< STRING > FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::column_name_container_type
inherited

Collection of column names.

This storage class is used to abstract the container type used to maintain the collection of column names used in the table. The container maintains the column order of the column names.

◆ column_name_container_type [2/3]

template<typename TPTR_STRUCT , typename TColumn >
typedef std::vector< STRING > FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::column_name_container_type
inherited

Collection of column names.

This storage class is used to abstract the container type used to maintain the collection of column names used in the table. The container maintains the column order of the column names.

◆ column_name_container_type [3/3]

template<typename TPTR_STRUCT , typename TColumn >
typedef std::vector< STRING > FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::column_name_container_type
inherited

Collection of column names.

This storage class is used to abstract the container type used to maintain the collection of column names used in the table. The container maintains the column order of the column names.

◆ column_type [1/3]

template<typename TPTR_STRUCT , typename TColumn >
typedef TColumn FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::column_type
inherited

◆ column_type [2/3]

template<typename TPTR_STRUCT , typename TColumn >
typedef TColumn FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::column_type
inherited

◆ column_type [3/3]

template<typename TPTR_STRUCT , typename TColumn >
typedef TColumn FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::column_type
inherited

◆ comment_type [1/3]

◆ comment_type [2/3]

◆ comment_type [3/3]

◆ const_iterator [1/3]

template<typename TPTR_STRUCT , typename TColumn >
typedef column_type::const_iterator FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::const_iterator
inherited

◆ const_iterator [2/3]

template<typename TPTR_STRUCT , typename TColumn >
typedef column_type::const_iterator FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::const_iterator
inherited

◆ const_iterator [3/3]

template<typename TPTR_STRUCT , typename TColumn >
typedef column_type::const_iterator FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::const_iterator
inherited

◆ io_comment_type [1/3]

template<typename T >
typedef STRING FrameCPP::Version_8::FrTableImpl::ClassicIO< T >::io_comment_type
private

◆ io_comment_type [2/3]

template<typename T >
typedef STRING FrameCPP::Version_8::FrTableImpl::ClassicIO< T >::io_comment_type
private

◆ io_comment_type [3/3]

template<typename T >
typedef STRING FrameCPP::Version_8::FrTableImpl::ClassicIO< T >::io_comment_type
private

◆ io_name_type [1/3]

template<typename T >
typedef STRING FrameCPP::Version_8::FrTableImpl::ClassicIO< T >::io_name_type
private

◆ io_name_type [2/3]

template<typename T >
typedef STRING FrameCPP::Version_8::FrTableImpl::ClassicIO< T >::io_name_type
private

◆ io_name_type [3/3]

template<typename T >
typedef STRING FrameCPP::Version_8::FrTableImpl::ClassicIO< T >::io_name_type
private

◆ 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

◆ iterator [1/3]

template<typename TPTR_STRUCT , typename TColumn >
typedef column_type::iterator FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::iterator
inherited

◆ iterator [2/3]

template<typename TPTR_STRUCT , typename TColumn >
typedef column_type::iterator FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::iterator
inherited

◆ iterator [3/3]

template<typename TPTR_STRUCT , typename TColumn >
typedef column_type::iterator FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::iterator
inherited

◆ name_type [1/3]

◆ name_type [2/3]

◆ name_type [3/3]

◆ nColumn_type [1/3]

◆ nColumn_type [2/3]

◆ nColumn_type [3/3]

◆ nRow_type [1/3]

◆ nRow_type [2/3]

◆ nRow_type [3/3]

◆ object_base_type [1/3]

◆ object_base_type [2/3]

◆ object_base_type [3/3]

◆ object_type [1/3]

Object with checksum data.

◆ object_type [2/3]

Object with checksum data.

◆ object_type [3/3]

Object with checksum data.

◆ 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

◆ ptr_struct_type [1/3]

template<typename TPTR_STRUCT , typename TColumn >
typedef TPTR_STRUCT FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::ptr_struct_type
inherited

◆ ptr_struct_type [2/3]

template<typename TPTR_STRUCT , typename TColumn >
typedef TPTR_STRUCT FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::ptr_struct_type
inherited

◆ ptr_struct_type [3/3]

template<typename TPTR_STRUCT , typename TColumn >
typedef TPTR_STRUCT FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::ptr_struct_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]

template<typename Object_T >
typedef const char* const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_desc_type
inherited

◆ struct_desc_type [2/3]

template<typename Object_T >
typedef const char* const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_desc_type
inherited

◆ struct_desc_type [3/3]

template<typename Object_T >
typedef const char* const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_desc_type
inherited

◆ struct_id_type [1/3]

template<typename Object_T >
typedef INT_2U const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_id_type
inherited

◆ struct_id_type [2/3]

template<typename Object_T >
typedef INT_2U const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_id_type
inherited

◆ struct_id_type [3/3]

template<typename Object_T >
typedef INT_2U const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_id_type
inherited

◆ struct_name_type [1/3]

template<typename Object_T >
typedef const char* const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_name_type
inherited

◆ struct_name_type [2/3]

template<typename Object_T >
typedef const char* const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_name_type
inherited

◆ struct_name_type [3/3]

template<typename Object_T >
typedef const char* const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_name_type
inherited

Constructor & Destructor Documentation

◆ ClassicIO() [1/3]

template<typename T >
FrameCPP::Version_8::FrTableImpl::ClassicIO< T >::ClassicIO ( )
inline

◆ ClassicIO() [2/3]

template<typename T >
FrameCPP::Version_8::FrTableImpl::ClassicIO< T >::ClassicIO ( )
inline

◆ ClassicIO() [3/3]

template<typename T >
FrameCPP::Version_8::FrTableImpl::ClassicIO< T >::ClassicIO ( )
inline

Member Function Documentation

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

◆ 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 T >
virtual demote_ret_type FrameCPP::Version_8::FrTableImpl::ClassicIO< T >::demote ( INT_2U  Target,
demote_arg_type  Obj,
Common::IStream 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 T >
virtual demote_ret_type FrameCPP::Version_8::FrTableImpl::ClassicIO< T >::demote ( INT_2U  Target,
demote_arg_type  Obj,
Common::IStream 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 T >
virtual demote_ret_type FrameCPP::Version_8::FrTableImpl::ClassicIO< T >::demote ( INT_2U  Target,
demote_arg_type  Obj,
Common::IStream 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]

template<typename Object_T >
static struct_desc_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecDescription ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecDescription() [2/3]

template<typename Object_T >
static struct_desc_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecDescription ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecDescription() [3/3]

template<typename Object_T >
static struct_desc_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecDescription ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecId() [1/3]

template<typename Object_T >
static struct_id_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecId ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecId() [2/3]

template<typename Object_T >
static struct_id_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecId ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecId() [3/3]

template<typename Object_T >
static struct_id_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecId ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecName() [1/3]

template<typename Object_T >
static struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecName ( )
inlinestaticinherited

◆ FrameSpecName() [2/3]

template<typename Object_T >
static struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecName ( )
inlinestaticinherited

◆ FrameSpecName() [3/3]

template<typename Object_T >
static struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecName ( )
inlinestaticinherited

◆ GetColumnName() [1/3]

template<typename TPTR_STRUCT , typename TColumn >
column_name_container_type FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::GetColumnName ( ) const
inlineinherited

Retrieve the list of column names.

Returns
The set of column names in column order.

◆ GetColumnName() [2/3]

template<typename TPTR_STRUCT , typename TColumn >
column_name_container_type FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::GetColumnName ( ) const
inlineinherited

Retrieve the list of column names.

Returns
The set of column names in column order.

◆ GetColumnName() [3/3]

template<typename TPTR_STRUCT , typename TColumn >
column_name_container_type FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::GetColumnName ( ) const
inlineinherited

Retrieve the list of column names.

Returns
The set of column names in column order.

◆ GetNColumn() [1/3]

template<typename TPTR_STRUCT , typename TColumn >
nColumn_type FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::GetNColumn ( ) const
inlineinherited

Retrieve the number of columns.

Returns
The number of columns in the table.

◆ GetNColumn() [2/3]

template<typename TPTR_STRUCT , typename TColumn >
nColumn_type FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::GetNColumn ( ) const
inlineinherited

Retrieve the number of columns.

Returns
The number of columns in the table.

◆ GetNColumn() [3/3]

template<typename TPTR_STRUCT , typename TColumn >
nColumn_type FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::GetNColumn ( ) const
inlineinherited

Retrieve the number of columns.

Returns
The number of columns in the table.

◆ GetNRow() [1/3]

template<typename TPTR_STRUCT , typename TColumn >
nRow_type FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::GetNRow ( ) const
inlineinherited

Retrieve the number of rows.

Returns
The number of rows in the table.

◆ GetNRow() [2/3]

template<typename TPTR_STRUCT , typename TColumn >
nRow_type FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::GetNRow ( ) const
inlineinherited

Retrieve the number of rows.

Returns
The number of rows in the table.

◆ GetNRow() [3/3]

template<typename TPTR_STRUCT , typename TColumn >
nRow_type FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::GetNRow ( ) const
inlineinherited

Retrieve the number of rows.

Returns
The number of rows in the table.

◆ ObjectStructName() [1/3]

template<typename T >
virtual const char* FrameCPP::Version_8::FrTableImpl::ClassicIO< T >::ObjectStructName ( ) const
inlineprotectedvirtual

The name structure name of this object.

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

◆ ObjectStructName() [2/3]

template<typename T >
virtual const char* FrameCPP::Version_8::FrTableImpl::ClassicIO< T >::ObjectStructName ( ) const
inlineprotectedvirtual

The name structure name of this object.

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

◆ ObjectStructName() [3/3]

template<typename T >
virtual const char* FrameCPP::Version_8::FrTableImpl::ClassicIO< T >::ObjectStructName ( ) const
inlineprotectedvirtual

The name structure name of this object.

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

◆ operator==() [1/3]

template<typename TPTR_STRUCT , typename TColumn >
bool FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::operator== ( const FrTablePST< TPTR_STRUCT, TColumn > &  RHS)
inherited

◆ operator==() [2/3]

template<typename TPTR_STRUCT , typename TColumn >
bool FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::operator== ( const FrTablePST< TPTR_STRUCT, TColumn > &  RHS)
inherited

◆ operator==() [3/3]

template<typename TPTR_STRUCT , typename TColumn >
bool FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::operator== ( const FrTablePST< TPTR_STRUCT, TColumn > &  RHS)
inherited

◆ pBytes() [1/3]

template<typename T >
virtual cmn_streamsize_type FrameCPP::Version_8::FrTableImpl::ClassicIO< 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 T >
virtual cmn_streamsize_type FrameCPP::Version_8::FrTableImpl::ClassicIO< 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 T >
virtual cmn_streamsize_type FrameCPP::Version_8::FrTableImpl::ClassicIO< 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 T >
virtual self_type* FrameCPP::Version_8::FrTableImpl::ClassicIO< T >::pCreate ( Common::IStream 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 T >
virtual self_type* FrameCPP::Version_8::FrTableImpl::ClassicIO< T >::pCreate ( Common::IStream 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 T >
virtual self_type* FrameCPP::Version_8::FrTableImpl::ClassicIO< T >::pCreate ( Common::IStream 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 T >
ClassicIO< T >::promote_ret_type FrameCPP::Version_8::FrTableImpl::ClassicIO< T >::Promote ( INT_2U  Source,
promote_arg_type  Obj,
Common::IStream Stream 
)
static

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 T >
static promote_ret_type FrameCPP::Version_8::FrTableImpl::ClassicIO< T >::Promote ( INT_2U  Source,
promote_arg_type  Obj,
Common::IStream Stream 
)
static

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 T >
static promote_ret_type FrameCPP::Version_8::FrTableImpl::ClassicIO< T >::Promote ( INT_2U  Source,
promote_arg_type  Obj,
Common::IStream Stream 
)
static

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

template<typename T >
virtual promote_ret_type FrameCPP::Version_8::FrTableImpl::ClassicIO< T >::promote ( INT_2U  Target,
promote_arg_type  Obj,
Common::IStream 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 T >
virtual promote_ret_type FrameCPP::Version_8::FrTableImpl::ClassicIO< T >::promote ( INT_2U  Target,
promote_arg_type  Obj,
Common::IStream 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 T >
virtual promote_ret_type FrameCPP::Version_8::FrTableImpl::ClassicIO< T >::promote ( INT_2U  Target,
promote_arg_type  Obj,
Common::IStream 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.

◆ pWrite() [1/3]

template<typename T >
virtual void FrameCPP::Version_8::FrTableImpl::ClassicIO< T >::pWrite ( Common::OStream 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 T >
virtual void FrameCPP::Version_8::FrTableImpl::ClassicIO< T >::pWrite ( Common::OStream 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 T >
virtual void FrameCPP::Version_8::FrTableImpl::ClassicIO< T >::pWrite ( Common::OStream 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 >.

◆ RefColumn() [1/6]

template<typename TPTR_STRUCT , typename TColumn >
FrTablePST< TPTR_STRUCT, TColumn >::column_type & FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::RefColumn
inlineinherited

Retrieve reference to columns.

Returns
A reference to the container of columns.

◆ RefColumn() [2/6]

template<typename TPTR_STRUCT , typename TColumn >
column_type& FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::RefColumn ( )
inherited

Retrieve reference to columns.

Returns
A reference to the container of columns.

◆ RefColumn() [3/6]

template<typename TPTR_STRUCT , typename TColumn >
column_type& FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::RefColumn ( )
inherited

Retrieve reference to columns.

Returns
A reference to the container of columns.

◆ RefColumn() [4/6]

template<typename TPTR_STRUCT , typename TColumn >
const FrTablePST< TPTR_STRUCT, TColumn >::column_type & FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::RefColumn
inlineinherited

Retrieve reference to columns.

Returns
A constant reference to the container of columns.

◆ RefColumn() [5/6]

template<typename TPTR_STRUCT , typename TColumn >
const column_type& FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::RefColumn ( ) const
inherited

Retrieve reference to columns.

Returns
A constant reference to the container of columns.

◆ RefColumn() [6/6]

template<typename TPTR_STRUCT , typename TColumn >
const column_type& FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::RefColumn ( ) const
inherited

Retrieve reference to columns.

Returns
A constant reference to the container of columns.

◆ StructDescription() [1/3]

template<typename T >
static const Common::Description* FrameCPP::Version_8::FrTableImpl::ClassicIO< 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 T >
static const Common::Description* FrameCPP::Version_8::FrTableImpl::ClassicIO< 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 T >
static const Common::Description* FrameCPP::Version_8::FrTableImpl::ClassicIO< T >::StructDescription ( )
inlinestatic

The description of structure.

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

◆ StructName() [1/3]

template<typename Object_T >
static struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::StructName ( )
inlinestaticinherited

◆ StructName() [2/3]

template<typename Object_T >
static struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::StructName ( )
inlinestaticinherited

◆ StructName() [3/3]

template<typename Object_T >
static struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::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

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

◆ m_refs

template<typename TPTR_STRUCT , typename TColumn >
refs_type FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::m_refs
protectedinherited

◆ MAX_REF

template<typename TPTR_STRUCT , typename TColumn >
static const INT_2U FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::MAX_REF = 1
staticinherited

◆ struct_desc

template<typename Object_T >
static struct_desc_type FrameCPP::v3::FrObjectMetaData< Object_T >::struct_desc
staticinherited

◆ struct_id

template<typename Object_T >
static struct_id_type FrameCPP::v3::FrObjectMetaData< Object_T >::struct_id
staticinherited

◆ struct_name

template<typename Object_T >
static struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::struct_name
staticinherited

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