ldas-tools-framecpp  2.5.8
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | 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 >:

Public Types

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

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

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

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

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

Constructor & Destructor Documentation

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

Constructor - Default.

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

Constructor.

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

Constructor.

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

copy constructor

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

Constructor - Stream.

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

Member Function Documentation

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

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.

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.
template<typename ObjectType, typename ChecksumType>
virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::pBytes ( const StreamBase Stream) const
protectedpure virtual
template<typename ObjectType, typename ChecksumType>
virtual self_type* FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::pCreate ( istream_type Stream) const
protectedpure virtual
template<typename ObjectType, typename ChecksumType>
virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::pWrite ( ostream_type Stream) const
protectedpure virtual
template<typename ObjectType, typename ChecksumType>
virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Write ( ostream_type Stream) const
virtual

Write object to the stream.


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