ifile::CCompactXmlFileWriteArchive Class Reference

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

#include <CCompactXmlFileWriteArchive.h>

Inheritance diagram for ifile::CCompactXmlFileWriteArchive:

Collaboration diagram for ifile::CCompactXmlFileWriteArchive:

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=nullptr, 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
	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.
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.
Public Member Functions inherited from iser::CTextWriteArchiveBase
virtual bool	ProcessData (void *dataPtr, int size)
	Process binary data block.
Public Member Functions inherited from iser::CWriteArchiveBase
bool	IsChanging () const override
	Check if this archive processing change the object state.
const IVersionInfo &	GetVersionInfo () 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 bool	WriteTextNode (const QByteArray &text)
	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	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 CArchiveTag &	GetAcfRootTag ()
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 27 of file CCompactXmlFileWriteArchive.h.

Member Typedef Documentation

BaseClass

iser::CCompactXmlWriteArchiveBase ifile::CCompactXmlFileWriteArchive::BaseClass

Definition at line 32 of file CCompactXmlFileWriteArchive.h.

BaseClass2

ifile::CFileArchiveInfo ifile::CCompactXmlFileWriteArchive::BaseClass2

Definition at line 33 of file CCompactXmlFileWriteArchive.h.

Constructor & Destructor Documentation

CCompactXmlFileWriteArchive()

ifile::CCompactXmlFileWriteArchive::CCompactXmlFileWriteArchive	(	const QString &	filePath,
		const iser::IVersionInfo *	versionInfoPtr = nullptr,
		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 )

protectedvirtual

Write single unformatted text node.

Reimplemented from iser::CCompactXmlWriteArchiveBase.

---

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

• ifile/CCompactXmlFileWriteArchive.h