Simple implementation of archive for writing in XML format. More...

#include <CSimpleXmlFileWriteArchive.h>

Inheritance diagram for ifile::CSimpleXmlFileWriteArchive:

Public Types
typedef iser::CXmlWriteArchiveBase	BaseClass

typedef CFileArchiveInfo	BaseClass2

Public Types inherited from iser::CXmlWriteArchiveBase
typedef 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
	CSimpleXmlFileWriteArchive (const QString &filePath, const iser::IVersionInfo *versionInfoPtr=NULL, bool serializeHeader=true, const iser::CArchiveTag &rootTag=s_acfRootTag)

virtual	~CSimpleXmlFileWriteArchive ()

Public Member Functions inherited from iser::CXmlWriteArchiveBase
virtual bool	IsTagSkippingSupported () const override
	Checks if skipping to the end of a tag on EndTag() is supported.

virtual bool	BeginTag (const CArchiveTag &tag) override
	Begins a tagged section in the archive.

virtual bool	BeginMultiTag (const CArchiveTag &tag, const CArchiveTag &subTag, int &count) override
	Begins a tagged section containing multiple elements of the same type.

virtual bool	EndTag (const CArchiveTag &tag) override
	Ends a tagged section in the archive.

virtual bool	Process (QByteArray &value) override
	Process primitive type.

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 IVersionInfo &	GetVersionInfo () 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	WriteString (const QByteArray &value) override

Protected Member Functions inherited from iser::CXmlWriteArchiveBase
	CXmlWriteArchiveBase (const IVersionInfo *versionInfoPtr, const CArchiveTag &rootTag)

bool	MakeIndent ()

bool	WriteXmlHeader ()
	Write XML header.

bool	WriteXmlFooter ()
	Write XML footer.

bool	WriteTextNode (const QByteArray &text) override
	Write single unformatted text node.

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 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 ifile::CFileArchiveInfo
QString	m_filePath

Static Protected Attributes inherited from iser::CArchiveBase
static CArchiveTag	s_acfRootTag

Detailed Description

Simple implementation of archive for writing in XML format.

This implementation doesn't use any external parser. It creates counter attribute indicating number of subtags for each mutli tag node. XML file in this format are needed by ifile::CSimpleXmlFileReadArchive.

Definition at line 25 of file CSimpleXmlFileWriteArchive.h.

Member Typedef Documentation

◆ BaseClass

typedef iser::CXmlWriteArchiveBase ifile::CSimpleXmlFileWriteArchive::BaseClass

Definition at line 30 of file CSimpleXmlFileWriteArchive.h.

◆ BaseClass2

typedef CFileArchiveInfo ifile::CSimpleXmlFileWriteArchive::BaseClass2

Definition at line 31 of file CSimpleXmlFileWriteArchive.h.

Constructor & Destructor Documentation

◆ CSimpleXmlFileWriteArchive()

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

explicit

◆ ~CSimpleXmlFileWriteArchive()

virtual ifile::CSimpleXmlFileWriteArchive::~CSimpleXmlFileWriteArchive ( )

virtual

Member Function Documentation

◆ WriteString()

virtual bool ifile::CSimpleXmlFileWriteArchive::WriteString ( const QByteArray & value )

overrideprotectedvirtual

Implements iser::CXmlWriteArchiveBase.

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

Acf/Include/ifile/CSimpleXmlFileWriteArchive.h

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members