ldas-tools-framecpp  2.7.0
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType > Class Template Referenceabstract

Support checksumed objects. More...

#include <FrameSpec.hh>

Inheritance diagram for FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >:
Inheritance graph
[legend]
Collaboration diagram for FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >:
Collaboration graph
[legend]

Public Types

typedef ObjectWithChecksum< ObjectType, ChecksumType > self_type
 
typedef IStream istream_type
 
typedef OStream ostream_type
 
typedef ObjectWithChecksum< ObjectType, ChecksumType > self_type
 
typedef IStream istream_type
 
typedef OStream ostream_type
 

Public Member Functions

 ObjectWithChecksum ()
 Constructor - Default. More...
 
 ObjectWithChecksum (const Description *Description)
 Constructor. More...
 
 ObjectWithChecksum (class_type Class, const Description *Description)
 Constructor. More...
 
 ObjectWithChecksum (const ObjectWithChecksum &Source)
 copy constructor More...
 
 ObjectWithChecksum (istream_type &Source)
 Constructor - Stream. More...
 
virtual ~ObjectWithChecksum ()
 destructor 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 void Write (ostream_type &Stream) const
 Write object to the stream. More...
 
 ObjectWithChecksum ()
 Constructor - Default. More...
 
 ObjectWithChecksum (const Description *Description)
 Constructor. More...
 
 ObjectWithChecksum (class_type Class, const Description *Description)
 Constructor. More...
 
 ObjectWithChecksum (const ObjectWithChecksum &Source)
 copy constructor More...
 
 ObjectWithChecksum (istream_type &Source)
 Constructor - Stream. More...
 
virtual ~ObjectWithChecksum ()
 destructor 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 void Write (ostream_type &Stream) const
 Write object to the stream. More...
 

Static Public Member Functions

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

Protected Member Functions

virtual streamsize_type pBytes (const StreamBase &Stream) const =0
 Number of bytes needed to write this structure. More...
 
virtual self_typepCreate (istream_type &Stream) const =0
 Virtual constructor. More...
 
virtual void pWrite (ostream_type &Stream) const =0
 Write the structure to the stream. More...
 
virtual streamsize_type pBytes (const StreamBase &Stream) const =0
 Number of bytes needed to write this structure. More...
 
virtual self_typepCreate (istream_type &Stream) const =0
 Virtual constructor. More...
 
virtual void pWrite (ostream_type &Stream) const =0
 Write the structure to the stream. More...
 

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

Private Attributes

ChecksumType m_chkSum
 Structure checksum. More...
 

Detailed Description

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

Support checksumed objects.

Template Parameters
ObjectTypeFrame object type
ChecksumTypeObject used for checksum calculation

Member Typedef Documentation

◆ istream_type [1/2]

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

◆ istream_type [2/2]

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

◆ ostream_type [1/2]

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

◆ ostream_type [2/2]

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

◆ self_type [1/2]

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

◆ self_type [2/2]

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

Constructor & Destructor Documentation

◆ ObjectWithChecksum() [1/10]

template<typename ObjectType , typename ChecksumType >
FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::ObjectWithChecksum ( )

Constructor - Default.

◆ ObjectWithChecksum() [2/10]

template<typename ObjectType , typename ChecksumType >
FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::ObjectWithChecksum ( const Description Description)

Constructor.

◆ ObjectWithChecksum() [3/10]

template<typename ObjectType , typename ChecksumType >
FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::ObjectWithChecksum ( class_type  Class,
const Description Description 
)

Constructor.

◆ ObjectWithChecksum() [4/10]

template<typename ObjectType , typename ChecksumType >
FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::ObjectWithChecksum ( const ObjectWithChecksum< ObjectType, ChecksumType > &  Source)

copy constructor

◆ ObjectWithChecksum() [5/10]

template<typename ObjectType , typename ChecksumType >
FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::ObjectWithChecksum ( istream_type Source)

Constructor - Stream.

◆ ~ObjectWithChecksum() [1/2]

template<typename ObjectType , typename ChecksumType >
virtual FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::~ObjectWithChecksum ( )
virtual

◆ ObjectWithChecksum() [6/10]

template<typename ObjectType , typename ChecksumType >
FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::ObjectWithChecksum ( )

Constructor - Default.

◆ ObjectWithChecksum() [7/10]

template<typename ObjectType , typename ChecksumType >
FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::ObjectWithChecksum ( const Description Description)

Constructor.

◆ ObjectWithChecksum() [8/10]

template<typename ObjectType , typename ChecksumType >
FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::ObjectWithChecksum ( class_type  Class,
const Description Description 
)

Constructor.

◆ ObjectWithChecksum() [9/10]

template<typename ObjectType , typename ChecksumType >
FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::ObjectWithChecksum ( const ObjectWithChecksum< ObjectType, ChecksumType > &  Source)

copy constructor

◆ ObjectWithChecksum() [10/10]

template<typename ObjectType , typename ChecksumType >
FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::ObjectWithChecksum ( istream_type Source)

Constructor - Stream.

◆ ~ObjectWithChecksum() [2/2]

template<typename ObjectType , typename ChecksumType >
virtual FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::~ObjectWithChecksum ( )
virtual

Member Function Documentation

◆ Bytes() [1/2]

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

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

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

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

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

Data class to be used in class field of FrSE.

◆ CheckSumDataClass() [2/2]

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

Data class to be used in class field of FrSE.

◆ CheckSumDataComment() [1/2]

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

Comment to be used in comment field of FrSE.

◆ CheckSumDataComment() [2/2]

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

Comment to be used in comment field of FrSE.

◆ Create() [1/6]

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

◆ Create() [2/6]

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

◆ Create() [3/6]

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

Virtual constructor.

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

◆ Create() [4/6]

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

Virtual constructor.

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

◆ Create() [5/6]

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

constructor - virtual

◆ Create() [6/6]

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

constructor - virtual

◆ pBytes() [1/2]

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

◆ pBytes() [2/2]

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

◆ pCreate() [1/2]

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

◆ pCreate() [2/2]

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

◆ pWrite() [1/2]

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

◆ pWrite() [2/2]

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

◆ Write() [1/2]

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

Write object to the stream.

◆ Write() [2/2]

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

Write object to the stream.

Member Data Documentation

◆ m_chkSum

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

Structure checksum.

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


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