ACF $AcfVersion:0$
Public Types | Public Member Functions | Protected Member Functions | List of all members
ifile::CCompactXmlFileWriteArchive Class Reference

Qt-based implementation of archive for writing in compact XML format. More...

#include <CCompactXmlFileWriteArchive.h>

Inheritance diagram for ifile::CCompactXmlFileWriteArchive:
iser::CCompactXmlWriteArchiveBase ifile::CFileArchiveInfo iser::CTextWriteArchiveBase iser::CXmlDocumentInfoBase ifile::IFileArchiveInfo iser::CWriteArchiveBase istd::IPolymorphic iser::CArchiveBase iser::IArchive istd::ILogger istd::IPolymorphic istd::IPolymorphic

Public Types

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

Public Member Functions

 CCompactXmlFileWriteArchive (const QString &filePath, const iser::IVersionInfo *versionInfoPtr=NULL, bool serializeHeader=true, const iser::CArchiveTag &rootTag=s_acfRootTag)
 Constructor initializing archive to open file immediatelly.
 
 ~CCompactXmlFileWriteArchive ()
 
bool OpenFile (const QString &filePath)
 
bool Flush ()
 
- Public Member Functions inherited from iser::CCompactXmlWriteArchiveBase
virtual ~CCompactXmlWriteArchiveBase ()
 
virtual bool IsTagSkippingSupported () const override
 Checks if skipping to the end of a tag on EndTag() is supported.
 
virtual bool BeginTag (const iser::CArchiveTag &tag) override
 Begins a tagged section in the archive.
 
virtual bool BeginMultiTag (const iser::CArchiveTag &tag, const iser::CArchiveTag &subTag, int &count) override
 Begins a tagged section containing multiple elements of the same type.
 
virtual bool EndTag (const iser::CArchiveTag &tag) override
 Ends a tagged section in the archive.
 
virtual bool Process (QString &value) override
 Process primitive type.
 
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.
 
- Public Member Functions inherited from iser::CTextWriteArchiveBase
virtual bool ProcessData (void *dataPtr, int size) override
 Process binary data block.
 
- Public Member Functions inherited from iser::CWriteArchiveBase
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::IArchive
template<typename Primitive >
bool TagAndProcess (const CArchiveTag &tag, Primitive &value)
 
- Public Member Functions inherited from istd::IPolymorphic
virtual ~IPolymorphic ()
 
- 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 override
 

Protected Member Functions

virtual bool WriteTextNode (const QByteArray &text) override
 Write single unformatted text node.
 
- Protected Member Functions inherited from iser::CCompactXmlWriteArchiveBase
 CCompactXmlWriteArchiveBase (const iser::IVersionInfo *versionInfoPtr, bool serializeHeader, const iser::CArchiveTag &rootTag)
 
bool InitArchive (QIODevice *devicePtr)
 
bool Flush ()
 
bool WriteStringNode (const QString &text)
 
- Protected Member Functions inherited from iser::CTextWriteArchiveBase
 CTextWriteArchiveBase (const IVersionInfo *versionInfoPtr)
 
- Protected Member Functions inherited from iser::CWriteArchiveBase
 CWriteArchiveBase (const IVersionInfo *versionInfoPtr)
 Constructor.
 
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 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::CCompactXmlWriteArchiveBase
QXmlStreamWriter m_xmlWriter
 
- 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 for writing in compact XML format.

Definition at line 24 of file CCompactXmlFileWriteArchive.h.

Member Typedef Documentation

◆ BaseClass

Definition at line 29 of file CCompactXmlFileWriteArchive.h.

◆ BaseClass2

Definition at line 30 of file CCompactXmlFileWriteArchive.h.

Constructor & Destructor Documentation

◆ CCompactXmlFileWriteArchive()

ifile::CCompactXmlFileWriteArchive::CCompactXmlFileWriteArchive ( const QString &  filePath,
const iser::IVersionInfo versionInfoPtr = NULL,
bool  serializeHeader = true,
const iser::CArchiveTag rootTag = s_acfRootTag 
)

Constructor initializing archive to open file immediatelly.

◆ ~CCompactXmlFileWriteArchive()

ifile::CCompactXmlFileWriteArchive::~CCompactXmlFileWriteArchive ( )

Member Function Documentation

◆ Flush()

bool ifile::CCompactXmlFileWriteArchive::Flush ( )

◆ OpenFile()

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

◆ WriteTextNode()

virtual bool ifile::CCompactXmlFileWriteArchive::WriteTextNode ( const QByteArray &  text)
overrideprotectedvirtual

Write single unformatted text node.

Reimplemented from iser::CCompactXmlWriteArchiveBase.


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