ICF 3.0.5.47
Technical documentation of ICF Libraries
ifile::CCompactXmlFileReadArchive Class Reference

Qt-based implementation of archive reading from XML file. More...

#include <CCompactXmlFileReadArchive.h>

Inheritance diagram for ifile::CCompactXmlFileReadArchive:
Collaboration diagram for ifile::CCompactXmlFileReadArchive:

Public Types

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

Public Member Functions

 CCompactXmlFileReadArchive (const QString &filePath="", bool serializeHeader=true, const iser::CArchiveTag &rootTag=s_acfRootTag)
 Constructor initializing archive to work with file.
 
bool OpenFile (const QString &filePath)
 
- Public Member Functions inherited from iser::CCompactXmlReadArchiveBase
 CCompactXmlReadArchiveBase (bool serializeHeader=true, const iser::CArchiveTag &rootTag=s_acfRootTag)
 
virtual bool IsTagSkippingSupported () const
 Check if skiping to the end of tag on EndTag is supported.
 
virtual bool BeginTag (const iser::CArchiveTag &tag)
 Begin of archive tag.
 
virtual bool BeginMultiTag (const iser::CArchiveTag &tag, const iser::CArchiveTag &subTag, int &count)
 Begin of archive tag containing set of subelements of the same type.
 
virtual bool EndTag (const iser::CArchiveTag &tag)
 End of archive tag.
 
virtual bool Process (QString &value)
 Process primitive type.
 
- Public Member Functions inherited from iser::CTextReadArchiveBase
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 ProcessData (void *dataPtr, int size)
 Process binary data block.
 
- Public Member Functions inherited from iser::CReadArchiveBase
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
- Public Member Functions inherited from iser::IArchive
- Public Member Functions inherited from iser::CXmlDocumentInfoBase
 CXmlDocumentInfoBase ()
 
bool IsCommentEnabled () const
 Check if comments in XML document are enabled.
 
void SetCommentEnabled (bool state=true)
 Allows comments in XML document.
 
- Public Member Functions inherited from ifile::CFileArchiveInfo
 CFileArchiveInfo (const QString &filePath)
 
virtual const QString & GetCurrentFilePath () const
 
- Public Member Functions inherited from ifile::IFileArchiveInfo

Protected Member Functions

virtual void DecorateMessage (istd::IInformationProvider::InformationCategory category, int id, int flags, QString &message, QString &messageSource) const
 Decorate message parts before outputting.
 
- Protected Member Functions inherited from iser::CCompactXmlReadArchiveBase
bool ReadStringNode (QString &text)
 
bool SetContent (QIODevice *devicePtr)
 
virtual bool ReadTextNode (QByteArray &text)
 Read single unformatted text node.
 
- Protected Member Functions inherited from iser::CTextReadArchiveBase
- Protected Member Functions inherited from iser::CReadArchiveBase
bool SerializeIcfHeader ()
 Serialize standard header.
 
- Protected Member Functions inherited from iser::CArchiveBase
 CArchiveBase ()
 
- Protected Member Functions inherited from istd::ILogger
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 Public Member Functions inherited from iser::CXmlDocumentInfoBase
static void EncodeXml (const QByteArray &text, QByteArray &xmlText)
 
static void DecodeXml (const QByteArray &xmlText, QByteArray &text)
 
static void EncodeXml (const QString &text, QByteArray &xmlText)
 
static void DecodeXml (const QByteArray &xmlText, QString &text)
 
static const QString & GetElementSeparator ()
 
- Protected Attributes inherited from iser::CCompactXmlReadArchiveBase
QDomDocument m_document
 
QDomElement m_currentParent
 
- Protected Attributes inherited from ifile::CFileArchiveInfo
QString m_filePath
 
- Static Protected Attributes inherited from iser::CArchiveBase
static CArchiveTag s_acfRootTag
 

Detailed Description

Qt-based implementation of archive reading from XML file.

Definition at line 27 of file CCompactXmlFileReadArchive.h.

Member Typedef Documentation

◆ BaseClass

◆ BaseClass2

Constructor & Destructor Documentation

◆ CCompactXmlFileReadArchive()

ifile::CCompactXmlFileReadArchive::CCompactXmlFileReadArchive ( const QString & filePath = "",
bool serializeHeader = true,
const iser::CArchiveTag & rootTag = s_acfRootTag )

Constructor initializing archive to work with file.

Member Function Documentation

◆ DecorateMessage()

virtual void ifile::CCompactXmlFileReadArchive::DecorateMessage ( istd::IInformationProvider::InformationCategory category,
int id,
int flags,
QString & message,
QString & messageSource ) const
protectedvirtual

Decorate message parts before outputting.

Reimplemented from iser::CCompactXmlReadArchiveBase.

◆ OpenFile()

bool ifile::CCompactXmlFileReadArchive::OpenFile ( const QString & filePath)

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

© Witold Gantzke and Kirill Lepskiy