ICF 3.0.5.47
Technical documentation of ICF Libraries
iser::CBinaryWriteArchiveBase Class Reference

Base class for archive implementations writting data based on its binary representation. More...

#include <CBinaryWriteArchiveBase.h>

Inheritance diagram for iser::CBinaryWriteArchiveBase:
Collaboration diagram for iser::CBinaryWriteArchiveBase:

Public Types

typedef CWriteArchiveBase BaseClass
 
- Public Types inherited from iser::IArchive
enum  MessageId { MI_TAG_ERROR = 0x3f320a0 , MI_TAG_SKIPPED }
 

Public Member Functions

virtual bool BeginTag (const CArchiveTag &tag)
 Begin of archive tag.
 
virtual bool EndTag (const CArchiveTag &tag)
 End of archive tag.
 
virtual bool Process (bool &value)
 Process primitive type.
 
virtual bool Process (char &value)
 Process primitive type.
 
virtual bool Process (quint8 &value)
 Process primitive type.
 
virtual bool Process (qint8 &value)
 Process primitive type.
 
virtual bool Process (quint16 &value)
 Process primitive type.
 
virtual bool Process (qint16 &value)
 Process primitive type.
 
virtual bool Process (quint32 &value)
 Process primitive type.
 
virtual bool Process (qint32 &value)
 Process primitive type.
 
virtual bool Process (quint64 &value)
 Process primitive type.
 
virtual bool Process (qint64 &value)
 Process primitive type.
 
virtual bool Process (float &value)
 Process primitive type.
 
virtual bool Process (double &value)
 Process primitive type.
 
virtual bool Process (QByteArray &value)
 Process primitive type.
 
virtual bool Process (QString &value)
 Process primitive type.
 
- Public Member Functions inherited from iser::CWriteArchiveBase
bool IsChanging () const override
 Check if this archive processing change the object state.
 
const IVersionInfoGetVersionInfo () const override
 Get version of archived stream for specific versioning type.
 
bool ProcessBits (void *dataPtr, int bitsCount, int bytesCount) override
 Process binary data block.
 
- Public Member Functions inherited from iser::CArchiveBase
virtual bool IsTagSkippingSupported () const
 Check if skiping to the end of tag on EndTag is supported.
 
virtual bool BeginMultiTag (const CArchiveTag &tag, const CArchiveTag &subTag, int &count)
 Begin of archive tag containing set of subelements of the same type.
 
- Public Member Functions inherited from iser::IArchive
virtual bool ProcessData (void *dataPtr, int size)=0
 Process binary data block.
 

Protected Member Functions

 CBinaryWriteArchiveBase (const IVersionInfo *versionInfoPtr)
 
- Protected Member Functions inherited from iser::CWriteArchiveBase
 CWriteArchiveBase (const IVersionInfo *versionInfoPtr)
 Constructor.
 
bool SerializeIcfHeader ()
 Serialize standard header.
 
- Protected Member Functions inherited from iser::CArchiveBase
 CArchiveBase ()
 
- Protected Member Functions inherited from istd::ILogger
virtual void DecorateMessage (IInformationProvider::InformationCategory category, int id, int flags, QString &message, QString &messageSource) const
 Decorate message parts before outputting.
 
virtual bool IsLogConsumed (const IInformationProvider::InformationCategory *categoryPtr=nullptr, const int *flagsPtr=nullptr) const
 Check if any log message is consumed.
 
virtual bool SendLogMessage (IInformationProvider::InformationCategory category, int id, const QString &message, const QString &messageSource, int flags=0) const
 Send any message to log.
 

Additional Inherited Members

- Static Public Member Functions inherited from iser::CArchiveBase
static const CArchiveTagGetAcfRootTag ()
 
- Static Protected Attributes inherited from iser::CArchiveBase
static CArchiveTag s_acfRootTag
 

Detailed Description

Base class for archive implementations writting data based on its binary representation.

Definition at line 20 of file CBinaryWriteArchiveBase.h.

Member Typedef Documentation

◆ BaseClass

Constructor & Destructor Documentation

◆ CBinaryWriteArchiveBase()

iser::CBinaryWriteArchiveBase::CBinaryWriteArchiveBase ( const IVersionInfo * versionInfoPtr)
explicitprotected

Member Function Documentation

◆ BeginTag()

virtual bool iser::CBinaryWriteArchiveBase::BeginTag ( const CArchiveTag & tag)
virtual

Begin of archive tag.

Parameters
tagtag object.
useTagSkippingflag signalling that support of tag skipping should be enabled.

Implements iser::IArchive.

Reimplemented in ifile::CFileWriteArchive.

◆ EndTag()

virtual bool iser::CBinaryWriteArchiveBase::EndTag ( const CArchiveTag & tag)
virtual

End of archive tag.

This method should be allways called after BeginTag is successfull called. If skipping of tag contains is supported, this will skip to the end of tag while archive reading. Otherwise you have to read contains of archive completely.

See also
IsTagSkippingSupported.

Implements iser::IArchive.

Reimplemented in ifile::CFileWriteArchive.

◆ Process() [1/14]

virtual bool iser::CBinaryWriteArchiveBase::Process ( bool & value)
virtual

Process primitive type.

Implements iser::IArchive.

◆ Process() [2/14]

virtual bool iser::CBinaryWriteArchiveBase::Process ( char & value)
virtual

Process primitive type.

Implements iser::IArchive.

◆ Process() [3/14]

virtual bool iser::CBinaryWriteArchiveBase::Process ( double & value)
virtual

Process primitive type.

Implements iser::IArchive.

◆ Process() [4/14]

virtual bool iser::CBinaryWriteArchiveBase::Process ( float & value)
virtual

Process primitive type.

Implements iser::IArchive.

◆ Process() [5/14]

virtual bool iser::CBinaryWriteArchiveBase::Process ( QByteArray & value)
virtual

Process primitive type.

Implements iser::IArchive.

◆ Process() [6/14]

virtual bool iser::CBinaryWriteArchiveBase::Process ( qint16 & value)
virtual

Process primitive type.

Implements iser::IArchive.

◆ Process() [7/14]

virtual bool iser::CBinaryWriteArchiveBase::Process ( qint32 & value)
virtual

Process primitive type.

Implements iser::IArchive.

◆ Process() [8/14]

virtual bool iser::CBinaryWriteArchiveBase::Process ( qint64 & value)
virtual

Process primitive type.

Implements iser::IArchive.

◆ Process() [9/14]

virtual bool iser::CBinaryWriteArchiveBase::Process ( qint8 & value)
virtual

Process primitive type.

Implements iser::IArchive.

◆ Process() [10/14]

virtual bool iser::CBinaryWriteArchiveBase::Process ( QString & value)
virtual

Process primitive type.

Implements iser::IArchive.

◆ Process() [11/14]

virtual bool iser::CBinaryWriteArchiveBase::Process ( quint16 & value)
virtual

Process primitive type.

Implements iser::IArchive.

◆ Process() [12/14]

virtual bool iser::CBinaryWriteArchiveBase::Process ( quint32 & value)
virtual

Process primitive type.

Implements iser::IArchive.

◆ Process() [13/14]

virtual bool iser::CBinaryWriteArchiveBase::Process ( quint64 & value)
virtual

Process primitive type.

Implements iser::IArchive.

◆ Process() [14/14]

virtual bool iser::CBinaryWriteArchiveBase::Process ( quint8 & value)
virtual

Process primitive type.

Implements iser::IArchive.


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

© Witold Gantzke and Kirill Lepskiy