ldas-tools-framecpp 3.0.4
Loading...
Searching...
No Matches
FrameCPP::Version_4::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType > Class Template Referenceabstract

Support checksumed objects. More...

#include <FrameSpec.hh>

Public Member Functions

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

Detailed Description

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

Support checksumed objects.

Template Parameters
ObjectTypeFrame object type
ChecksumTypeObject used for checksum calculation

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

◆ Create() [1/2]

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

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

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

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

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

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

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

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:
  • /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/build/include/framecpp/Common/FrameSpec.hh
  • Common/FrameSpec.hh
  • /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/Common/FrameSpec.cc