ldas-tools-framecpp 3.0.4
Loading...
Searching...
No Matches
FrameCPP::Version_8::ObjectWithChecksum< ObjectType > Class Template Referenceabstract

#include <FrameSpec.hh>

Inheritance diagram for FrameCPP::Version_8::ObjectWithChecksum< ObjectType >:
Collaboration diagram for FrameCPP::Version_8::ObjectWithChecksum< ObjectType >:

Public Types

typedef ObjectWithChecksum< ObjectType, checksum_typeself_type
 
typedef IStream istream_type
 
typedef OStream ostream_type
 

Public Member Functions

 ObjectWithChecksum ()
 
 ObjectWithChecksum (const Common::Description *Description)
 Constructor.
 
 ObjectWithChecksum (class_type Class, const Common::Description *Description)
 Constructor.
 
 ObjectWithChecksum (const ObjectWithChecksum &Source)
 copy constructor
 
 ObjectWithChecksum (Common::IStream &Source)
 Constructor - Stream.
 
 ~ObjectWithChecksum ()
 Destructor.
 
 ObjectWithChecksum ()
 
 ObjectWithChecksum (const Common::Description *Description)
 Constructor.
 
 ObjectWithChecksum (class_type Class, const Common::Description *Description)
 Constructor.
 
 ObjectWithChecksum (const ObjectWithChecksum &Source)
 copy constructor
 
 ObjectWithChecksum (Common::IStream &Source)
 Constructor - Stream.
 
 ~ObjectWithChecksum ()
 Destructor.
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object.
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object.
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 

Static Public Member Functions

static const char * CheckSumDataClass ()
 Data class to be used in class field of FrSE.
 
static const char * CheckSumDataClass ()
 Data class to be used in class field of FrSE.
 
static const char * CheckSumDataComment ()
 Comment to be used in comment field of FrSE.
 
static const char * CheckSumDataComment ()
 Comment to be used in comment field of FrSE.
 

Protected Member Functions

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

Private Types

typedef Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_typeobject_base_type
 

Private Member Functions

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

Private Attributes

checksum_type m_chkSum
 Structure checksum.
 

Member Typedef Documentation

◆ istream_type

typedef IStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::istream_type
inherited

◆ object_base_type

template<typename ObjectType >
typedef Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type > FrameCPP::Version_8::ObjectWithChecksum< ObjectType >::object_base_type
private

◆ ostream_type

typedef OStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::ostream_type
inherited

◆ self_type

typedef ObjectWithChecksum< ObjectType, checksum_type > FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::self_type
inherited

Constructor & Destructor Documentation

◆ ObjectWithChecksum() [1/10]

template<typename ObjectType >
FrameCPP::Version_8::ObjectWithChecksum< ObjectType >::ObjectWithChecksum ( )
inline

◆ ObjectWithChecksum() [2/10]

template<typename ObjectType >
FrameCPP::Version_8::ObjectWithChecksum< ObjectType >::ObjectWithChecksum ( const Common::Description * Description)
inline

Constructor.

◆ ObjectWithChecksum() [3/10]

template<typename ObjectType >
FrameCPP::Version_8::ObjectWithChecksum< ObjectType >::ObjectWithChecksum ( class_type Class,
const Common::Description * Description )
inline

Constructor.

◆ ObjectWithChecksum() [4/10]

template<typename ObjectType >
FrameCPP::Version_8::ObjectWithChecksum< ObjectType >::ObjectWithChecksum ( const ObjectWithChecksum< ObjectType > & Source)
inline

copy constructor

◆ ObjectWithChecksum() [5/10]

template<typename ObjectType >
FrameCPP::Version_8::ObjectWithChecksum< ObjectType >::ObjectWithChecksum ( Common::IStream & Source)
inline

Constructor - Stream.

◆ ~ObjectWithChecksum() [1/2]

template<typename ObjectType >
FrameCPP::Version_8::ObjectWithChecksum< ObjectType >::~ObjectWithChecksum ( )
inlinevirtual

◆ ObjectWithChecksum() [6/10]

template<typename ObjectType >
FrameCPP::Version_8::ObjectWithChecksum< ObjectType >::ObjectWithChecksum ( )
inline

◆ ObjectWithChecksum() [7/10]

template<typename ObjectType >
FrameCPP::Version_8::ObjectWithChecksum< ObjectType >::ObjectWithChecksum ( const Common::Description * Description)
inline

Constructor.

◆ ObjectWithChecksum() [8/10]

template<typename ObjectType >
FrameCPP::Version_8::ObjectWithChecksum< ObjectType >::ObjectWithChecksum ( class_type Class,
const Common::Description * Description )
inline

Constructor.

◆ ObjectWithChecksum() [9/10]

template<typename ObjectType >
FrameCPP::Version_8::ObjectWithChecksum< ObjectType >::ObjectWithChecksum ( const ObjectWithChecksum< ObjectType > & Source)
inline

copy constructor

◆ ObjectWithChecksum() [10/10]

template<typename ObjectType >
FrameCPP::Version_8::ObjectWithChecksum< ObjectType >::ObjectWithChecksum ( Common::IStream & Source)
inline

Constructor - Stream.

◆ ~ObjectWithChecksum() [2/2]

template<typename ObjectType >
FrameCPP::Version_8::ObjectWithChecksum< ObjectType >::~ObjectWithChecksum ( )
inlinevirtual

Member Function Documentation

◆ Bytes() [1/2]

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::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/2]

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::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/2]

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

Data class to be used in class field of FrSE.

◆ CheckSumDataClass() [2/2]

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

Data class to be used in class field of FrSE.

◆ CheckSumDataComment() [1/2]

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

Comment to be used in comment field of FrSE.

◆ CheckSumDataComment() [2/2]

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

Comment to be used in comment field of FrSE.

◆ Create() [1/6]

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

◆ Create() [2/6]

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

◆ Create() [3/6]

virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::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() [4/6]

virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::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/6]

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

constructor - virtual

◆ Create() [6/6]

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

constructor - virtual

◆ pBytes() [1/2]

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::pBytes ( const StreamBase & Stream) const
protectedpure virtualinherited

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.

◆ pBytes() [2/2]

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::pBytes ( const StreamBase & Stream) const
protectedpure virtualinherited

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.

◆ pCreate() [1/2]

virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::pCreate ( istream_type & Stream) const
protectedpure virtualinherited

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.
Returns
The newly allocated object.

◆ pCreate() [2/2]

virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::pCreate ( istream_type & Stream) const
protectedpure virtualinherited

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.
Returns
The newly allocated object.

◆ pWrite() [1/2]

virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::pWrite ( ostream_type & Stream) const
protectedpure virtualinherited

Write the structure to the stream.

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

◆ pWrite() [2/2]

virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::pWrite ( ostream_type & Stream) const
protectedpure virtualinherited

Write the structure to the stream.

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

◆ Write() [1/2]

virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::Write ( ostream_type & Stream) const
virtualinherited

Write object to the stream.

◆ Write() [2/2]

virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::Write ( ostream_type & Stream) const
virtualinherited

Write object to the stream.

Member Data Documentation

◆ m_chkSum

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 files: