ldas-tools-framecpp  2.8.1
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>

Inherits ObjectType, ObjectType, and ObjectType.

Inherited by FrameCPP::Version_8::ObjectWithChecksum< Common::FrameSpec::Object >, FrameCPP::Version_8::ObjectWithChecksum< Common::FrSH >, FrameCPP::Version_8::ObjectWithChecksum< Common::FrTOC >, FrameCPP::Version_8::ObjectWithChecksum< Common::FrDetector >, FrameCPP::Version_8::ObjectWithChecksum< Common::FrameH >, FrameCPP::Version_8::ObjectWithChecksum< base_object_type >, FrameCPP::Version_8::ObjectWithChecksum< Common::FrameSpec::Object >, FrameCPP::Version_8::ObjectWithChecksum< Common::FrSH >, FrameCPP::Version_8::ObjectWithChecksum< Common::FrTOC >, FrameCPP::Version_8::ObjectWithChecksum< Common::FrDetector >, FrameCPP::Version_8::ObjectWithChecksum< Common::FrameH >, FrameCPP::Version_8::ObjectWithChecksum< base_object_type >, FrameCPP::Version_8::ObjectWithChecksum< Common::FrameSpec::Object >, FrameCPP::Version_8::ObjectWithChecksum< Common::FrSH >, FrameCPP::Version_8::ObjectWithChecksum< Common::FrTOC >, FrameCPP::Version_8::ObjectWithChecksum< Common::FrDetector >, FrameCPP::Version_8::ObjectWithChecksum< Common::FrameH >, and FrameCPP::Version_8::ObjectWithChecksum< base_object_type >.

Public Member Functions

 ObjectWithChecksum ()
 Constructor - Default.
 
 ObjectWithChecksum (const Description *Description)
 Constructor.
 
 ObjectWithChecksum (class_type Class, const Description *Description)
 Constructor.
 
 ObjectWithChecksum (const ObjectWithChecksum &Source)
 copy constructor
 
 ObjectWithChecksum (istream_type &Source)
 Constructor - Stream.
 
virtual ~ObjectWithChecksum ()
 destructor
 
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.
 
 ObjectWithChecksum ()
 Constructor - Default.
 
 ObjectWithChecksum (const Description *Description)
 Constructor.
 
 ObjectWithChecksum (class_type Class, const Description *Description)
 Constructor.
 
 ObjectWithChecksum (const ObjectWithChecksum &Source)
 copy constructor
 
 ObjectWithChecksum (istream_type &Source)
 Constructor - Stream.
 
virtual ~ObjectWithChecksum ()
 destructor
 
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.
 
 ObjectWithChecksum ()
 Constructor - Default.
 
 ObjectWithChecksum (const Description *Description)
 Constructor.
 
 ObjectWithChecksum (class_type Class, const Description *Description)
 Constructor.
 
 ObjectWithChecksum (const ObjectWithChecksum &Source)
 copy constructor
 
 ObjectWithChecksum (istream_type &Source)
 Constructor - Stream.
 
virtual ~ObjectWithChecksum ()
 destructor
 
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.
 

Static Public Member Functions

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 * 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 * CheckSumDataClass ()
 Data class to be used in class 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. 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...
 
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 Function Documentation

◆ Bytes() [1/3]

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

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

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

◆ Create() [1/3]

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

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

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.

◆ pBytes() [1/3]

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

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

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

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

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

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

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

Virtual constructor.

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

◆ pCreate() [2/3]

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

Virtual constructor.

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

◆ pCreate() [3/3]

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

Virtual constructor.

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

◆ pWrite() [1/3]

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

Write the structure to the stream.

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

◆ pWrite() [2/3]

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

Write the structure to the stream.

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

◆ pWrite() [3/3]

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

Write the structure to the stream.

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

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