ACF $AcfVersion:0$
Public Types | Public Member Functions | Protected Member Functions | List of all members
iser::CTextReadArchiveBase Class Referenceabstract

Common archive implementation of text-based reading archives. More...

#include <CTextReadArchiveBase.h>

Inheritance diagram for iser::CTextReadArchiveBase:
iser::CReadArchiveBase iser::CArchiveBase iser::IArchive istd::ILogger istd::IPolymorphic istd::IPolymorphic iqt::CSettingsReadArchive iser::CCompactXmlReadArchiveBase iser::CJsonReadArchiveBase iser::CXmlReadArchiveBase ifile::CCompactXmlFileReadArchive ifile::CCompressedXmlFileReadArchive iser::CCompactXmlMemReadArchive ifile::CJsonFileReadArchive iser::CJsonMemReadArchive iser::CXmlStreamReadArchiveBase ifile::CSimpleXmlFileReadArchive iser::CXmlStringReadArchive

Public Types

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

Public Member Functions

virtual bool Process (bool &value) override
 Processes (reads or writes) a boolean value.
 
virtual bool Process (char &value) override
 Process primitive type.
 
virtual bool Process (quint8 &value) override
 Process primitive type.
 
virtual bool Process (qint8 &value) override
 Process primitive type.
 
virtual bool Process (quint16 &value) override
 Process primitive type.
 
virtual bool Process (qint16 &value) override
 Process primitive type.
 
virtual bool Process (quint32 &value) override
 Process primitive type.
 
virtual bool Process (qint32 &value) override
 Process primitive type.
 
virtual bool Process (quint64 &value) override
 Process primitive type.
 
virtual bool Process (qint64 &value) override
 Process primitive type.
 
virtual bool Process (float &value) override
 Process primitive type.
 
virtual bool Process (double &value) override
 Process primitive type.
 
virtual bool Process (QByteArray &value) override
 Process primitive type.
 
virtual bool ProcessData (void *dataPtr, int size) override
 Process binary data block.
 
- Public Member Functions inherited from iser::CReadArchiveBase
virtual bool IsStoring () const override
 Checks if this archive is in storing (writing) or loading (reading) mode.
 
virtual const IVersionInfoGetVersionInfo () const override
 Gets version information for the archived stream.
 
virtual bool ProcessBits (void *dataPtr, int bitsCount, int bytesCount) override
 Process binary data block.
 
- Public Member Functions inherited from iser::CArchiveBase
virtual bool IsTagSkippingSupported () const override
 Checks if skipping to the end of a tag on EndTag() is supported.
 
virtual bool BeginMultiTag (const CArchiveTag &tag, const CArchiveTag &subTag, int &count) override
 Begins a tagged section containing multiple elements of the same type.
 
- Public Member Functions inherited from iser::IArchive
virtual bool BeginTag (const CArchiveTag &tag)=0
 Begins a tagged section in the archive.
 
virtual bool EndTag (const CArchiveTag &tag)=0
 Ends a tagged section in the archive.
 
virtual bool Process (QString &value)=0
 Process primitive type.
 
template<typename Primitive >
bool TagAndProcess (const CArchiveTag &tag, Primitive &value)
 
- Public Member Functions inherited from istd::IPolymorphic
virtual ~IPolymorphic ()
 

Protected Member Functions

virtual bool ReadTextNode (QByteArray &text)=0
 Read single unformatted text node.
 
- Protected Member Functions inherited from iser::CReadArchiveBase
bool SerializeAcfHeader ()
 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=NULL, const int *flagsPtr=NULL) 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

Common archive implementation of text-based reading archives.

Definition at line 19 of file CTextReadArchiveBase.h.

Member Typedef Documentation

◆ BaseClass

Definition at line 22 of file CTextReadArchiveBase.h.

Member Function Documentation

◆ Process() [1/13]

virtual bool iser::CTextReadArchiveBase::Process ( bool &  value)
overridevirtual

Processes (reads or writes) a boolean value.

Parameters
value[in/out] For writing: the value to store For reading: receives the loaded value
Returns
true if successful, false on error
See also
IsStoring(), Process() overloads for other types

Implements iser::IArchive.

Reimplemented in iqt::CSettingsReadArchive, and iser::CXmlReadArchiveBase.

◆ Process() [2/13]

virtual bool iser::CTextReadArchiveBase::Process ( char &  value)
overridevirtual

Process primitive type.

Implements iser::IArchive.

Reimplemented in iqt::CSettingsReadArchive, and iser::CXmlReadArchiveBase.

◆ Process() [3/13]

virtual bool iser::CTextReadArchiveBase::Process ( double &  value)
overridevirtual

Process primitive type.

Implements iser::IArchive.

Reimplemented in iqt::CSettingsReadArchive, and iser::CXmlReadArchiveBase.

◆ Process() [4/13]

virtual bool iser::CTextReadArchiveBase::Process ( float &  value)
overridevirtual

Process primitive type.

Implements iser::IArchive.

Reimplemented in iqt::CSettingsReadArchive, and iser::CXmlReadArchiveBase.

◆ Process() [5/13]

virtual bool iser::CTextReadArchiveBase::Process ( QByteArray &  value)
overridevirtual

Process primitive type.

Implements iser::IArchive.

Reimplemented in iqt::CSettingsReadArchive, iser::CXmlReadArchiveBase, and iser::CXmlReadArchiveBase.

◆ Process() [6/13]

virtual bool iser::CTextReadArchiveBase::Process ( qint16 &  value)
overridevirtual

Process primitive type.

Implements iser::IArchive.

Reimplemented in iqt::CSettingsReadArchive, and iser::CXmlReadArchiveBase.

◆ Process() [7/13]

virtual bool iser::CTextReadArchiveBase::Process ( qint32 &  value)
overridevirtual

Process primitive type.

Implements iser::IArchive.

Reimplemented in iqt::CSettingsReadArchive, and iser::CXmlReadArchiveBase.

◆ Process() [8/13]

virtual bool iser::CTextReadArchiveBase::Process ( qint64 &  value)
overridevirtual

Process primitive type.

Implements iser::IArchive.

Reimplemented in iqt::CSettingsReadArchive, and iser::CXmlReadArchiveBase.

◆ Process() [9/13]

virtual bool iser::CTextReadArchiveBase::Process ( qint8 &  value)
overridevirtual

Process primitive type.

Implements iser::IArchive.

Reimplemented in iqt::CSettingsReadArchive, and iser::CXmlReadArchiveBase.

◆ Process() [10/13]

virtual bool iser::CTextReadArchiveBase::Process ( quint16 &  value)
overridevirtual

Process primitive type.

Implements iser::IArchive.

Reimplemented in iqt::CSettingsReadArchive, and iser::CXmlReadArchiveBase.

◆ Process() [11/13]

virtual bool iser::CTextReadArchiveBase::Process ( quint32 &  value)
overridevirtual

Process primitive type.

Implements iser::IArchive.

Reimplemented in iqt::CSettingsReadArchive, and iser::CXmlReadArchiveBase.

◆ Process() [12/13]

virtual bool iser::CTextReadArchiveBase::Process ( quint64 &  value)
overridevirtual

Process primitive type.

Implements iser::IArchive.

Reimplemented in iqt::CSettingsReadArchive, and iser::CXmlReadArchiveBase.

◆ Process() [13/13]

virtual bool iser::CTextReadArchiveBase::Process ( quint8 &  value)
overridevirtual

Process primitive type.

Implements iser::IArchive.

Reimplemented in iqt::CSettingsReadArchive, and iser::CXmlReadArchiveBase.

◆ ProcessData()

virtual bool iser::CTextReadArchiveBase::ProcessData ( void *  dataPtr,
int  size 
)
overridevirtual

Process binary data block.

Parameters
dataPtrpointer to memory block.
sizesize of memory block in bytes.

Implements iser::IArchive.

◆ ReadTextNode()

virtual bool iser::CTextReadArchiveBase::ReadTextNode ( QByteArray &  text)
protectedpure virtual

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