FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType > Class Template Reference

Support checksumed objects. More...

#include <FrameSpec.hh>

Inherits ObjectType, and ObjectType.

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_type *	Create (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_type *	Create (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.

Protected Member Functions
virtual streamsize_type	pBytes (const StreamBase &Stream) const =0
	Number of bytes needed to write this structure. More...
virtual self_type *	pCreate (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_type *	pCreate (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

ObjectType	Frame object type
ChecksumType	Object 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]

Stream

Stream 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]

Stream

Stream 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]

Stream

The 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]

Stream

The 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]

Stream

The stream from which to the object is being read or written.

Returns

The number of bytes need to read or write this object.

Implemented in FrameCPP::Version_8::FrVect, FrameCPP::Version_8::FrVect, FrameCPP::Version_8::FrDetector, FrameCPP::Version_8::FrDetector, FrameCPP::Version_8::FrProcData, FrameCPP::Version_8::FrProcData, FrameCPP::Version_8::FrRawData, FrameCPP::Version_8::FrRawData, FrameCPP::Version_8::FrSimData, FrameCPP::Version_8::FrSimData, FrameCPP::Version_8::FrSimEvent, FrameCPP::Version_8::FrSimEvent, FrameCPP::Version_8::FrAdcData, FrameCPP::Version_8::FrAdcData, FrameCPP::Version_8::FrSerData, FrameCPP::Version_8::FrSerData, FrameCPP::Version_8::FrSummary, FrameCPP::Version_8::FrSummary, FrameCPP::Version_8::FrEvent, FrameCPP::Version_8::FrEvent, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrStatData, FrameCPP::Version_8::FrStatData, FrameCPP::Version_8::FrMsg, FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrMsg, FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrTable, FrameCPP::Version_8::FrTable, FrameCPP::Version_8::FrHistory, FrameCPP::Version_8::FrHistory, FrameCPP::Version_8::FrEndOfFrame, FrameCPP::Version_8::FrEndOfFrame, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSE, and FrameCPP::Version_8::FrSE.

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]

Stream

The stream from which to the object is being read or written.

Returns

The number of bytes need to read or write this object.

Implemented in FrameCPP::Version_8::FrVect, FrameCPP::Version_8::FrVect, FrameCPP::Version_8::FrDetector, FrameCPP::Version_8::FrDetector, FrameCPP::Version_8::FrProcData, FrameCPP::Version_8::FrProcData, FrameCPP::Version_8::FrRawData, FrameCPP::Version_8::FrRawData, FrameCPP::Version_8::FrSimData, FrameCPP::Version_8::FrSimData, FrameCPP::Version_8::FrSimEvent, FrameCPP::Version_8::FrSimEvent, FrameCPP::Version_8::FrAdcData, FrameCPP::Version_8::FrAdcData, FrameCPP::Version_8::FrSerData, FrameCPP::Version_8::FrSerData, FrameCPP::Version_8::FrSummary, FrameCPP::Version_8::FrSummary, FrameCPP::Version_8::FrEvent, FrameCPP::Version_8::FrEvent, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrStatData, FrameCPP::Version_8::FrStatData, FrameCPP::Version_8::FrMsg, FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrMsg, FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrTable, FrameCPP::Version_8::FrTable, FrameCPP::Version_8::FrHistory, FrameCPP::Version_8::FrHistory, FrameCPP::Version_8::FrEndOfFrame, FrameCPP::Version_8::FrEndOfFrame, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSE, and FrameCPP::Version_8::FrSE.

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]

Stream

The input stream from where the object is being read.

Returns

The newly allocated object.

Implemented in FrameCPP::Version_8::FrVect, FrameCPP::Version_8::FrVect, FrameCPP::Version_8::FrDetector, FrameCPP::Version_8::FrDetector, FrameCPP::Version_8::FrProcData, FrameCPP::Version_8::FrProcData, FrameCPP::Version_8::FrRawData, FrameCPP::Version_8::FrRawData, FrameCPP::Version_8::FrSimData, FrameCPP::Version_8::FrSimData, FrameCPP::Version_8::FrSimEvent, FrameCPP::Version_8::FrSimEvent, FrameCPP::Version_8::FrAdcData, FrameCPP::Version_8::FrAdcData, FrameCPP::Version_8::FrSerData, FrameCPP::Version_8::FrSerData, FrameCPP::Version_8::FrSummary, FrameCPP::Version_8::FrSummary, FrameCPP::Version_8::FrEvent, FrameCPP::Version_8::FrEvent, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrStatData, FrameCPP::Version_8::FrStatData, FrameCPP::Version_8::FrMsg, FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrMsg, FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrTable, FrameCPP::Version_8::FrTable, FrameCPP::Version_8::FrHistory, FrameCPP::Version_8::FrHistory, FrameCPP::Version_8::FrEndOfFrame, FrameCPP::Version_8::FrEndOfFrame, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSE, and FrameCPP::Version_8::FrSE.

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]

Stream

The input stream from where the object is being read.

Returns

The newly allocated object.

Implemented in FrameCPP::Version_8::FrVect, FrameCPP::Version_8::FrVect, FrameCPP::Version_8::FrDetector, FrameCPP::Version_8::FrDetector, FrameCPP::Version_8::FrProcData, FrameCPP::Version_8::FrProcData, FrameCPP::Version_8::FrRawData, FrameCPP::Version_8::FrRawData, FrameCPP::Version_8::FrSimData, FrameCPP::Version_8::FrSimData, FrameCPP::Version_8::FrSimEvent, FrameCPP::Version_8::FrSimEvent, FrameCPP::Version_8::FrAdcData, FrameCPP::Version_8::FrAdcData, FrameCPP::Version_8::FrSerData, FrameCPP::Version_8::FrSerData, FrameCPP::Version_8::FrSummary, FrameCPP::Version_8::FrSummary, FrameCPP::Version_8::FrEvent, FrameCPP::Version_8::FrEvent, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrStatData, FrameCPP::Version_8::FrStatData, FrameCPP::Version_8::FrMsg, FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrMsg, FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrTable, FrameCPP::Version_8::FrTable, FrameCPP::Version_8::FrHistory, FrameCPP::Version_8::FrHistory, FrameCPP::Version_8::FrEndOfFrame, FrameCPP::Version_8::FrEndOfFrame, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSE, and FrameCPP::Version_8::FrSE.

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]

Stream

The output stream where the object is to be written.

Implemented in FrameCPP::Version_8::FrVect, FrameCPP::Version_8::FrVect, FrameCPP::Version_8::FrRawData, FrameCPP::Version_8::FrRawData, FrameCPP::Version_8::FrSimData, FrameCPP::Version_8::FrSimData, FrameCPP::Version_8::FrSimEvent, FrameCPP::Version_8::FrSimEvent, FrameCPP::Version_8::FrSerData, FrameCPP::Version_8::FrSerData, FrameCPP::Version_8::FrSummary, FrameCPP::Version_8::FrSummary, FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrTable, FrameCPP::Version_8::FrTable, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSE, and FrameCPP::Version_8::FrSE.

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]

Stream

The output stream where the object is to be written.

Implemented in FrameCPP::Version_8::FrVect, FrameCPP::Version_8::FrVect, FrameCPP::Version_8::FrRawData, FrameCPP::Version_8::FrRawData, FrameCPP::Version_8::FrSimData, FrameCPP::Version_8::FrSimData, FrameCPP::Version_8::FrSimEvent, FrameCPP::Version_8::FrSimEvent, FrameCPP::Version_8::FrSerData, FrameCPP::Version_8::FrSerData, FrameCPP::Version_8::FrSummary, FrameCPP::Version_8::FrSummary, FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrTable, FrameCPP::Version_8::FrTable, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSE, and FrameCPP::Version_8::FrSE.

---

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

• /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-2.7.0/include/framecpp/Common/FrameSpec.hh