ldas-tools-framecpp  2.6.2
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
FrameCPP::Version_8::ObjectWithChecksum< ObjectType > Class Template Referenceabstract

#include <FrameSpec.hh>

Inheritance diagram for FrameCPP::Version_8::ObjectWithChecksum< ObjectType >:
FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >

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. More...
 
 ObjectWithChecksum (class_type Class, const Common::Description *Description)
 Constructor. More...
 
 ObjectWithChecksum (const ObjectWithChecksum &Source)
 copy constructor More...
 
 ObjectWithChecksum (Common::IStream &Source)
 Constructor - Stream. More...
 
 ~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...
 

Member Typedef Documentation

◆ istream_type

◆ ostream_type

◆ self_type

Constructor & Destructor Documentation

◆ ObjectWithChecksum() [1/5]

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

◆ ObjectWithChecksum() [2/5]

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

Constructor.

◆ ObjectWithChecksum() [3/5]

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

Constructor.

◆ ObjectWithChecksum() [4/5]

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

copy constructor

◆ ObjectWithChecksum() [5/5]

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

Constructor - Stream.

◆ ~ObjectWithChecksum()

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

Member Function Documentation

◆ Bytes()

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()

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

Data class to be used in class field of FrSE.

◆ CheckSumDataComment()

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

Comment to be used in comment field of FrSE.

◆ Create()

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.

◆ pBytes()

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()

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()

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()

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

Write object to the stream.


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