Simple implementation of archive for writing of XML given as a string. More...

#include <CXmlStringWriteArchive.h>

Inheritance diagram for iser::CXmlStringWriteArchive:

Collaboration diagram for iser::CXmlStringWriteArchive:

Public Types
typedef CXmlWriteArchiveBase	BaseClass

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
	CXmlStringWriteArchive (const IVersionInfo *versionInfoPtr=nullptr, bool serializeHeader=true, const CArchiveTag &rootTag=s_acfRootTag)

virtual	~CXmlStringWriteArchive ()

virtual const QByteArray &	GetString () const
	Close the archive and get the created XML string.

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

virtual bool	BeginTag (const CArchiveTag &tag)
	Begin of archive tag.

virtual bool	BeginMultiTag (const CArchiveTag &tag, const CArchiveTag &subTag, int &count)
	Begin of archive tag containing set of subelements of the same type.

virtual bool	EndTag (const CArchiveTag &tag)
	End of archive tag.

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

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.

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.

Protected Member Functions
void	EnsureArchiveClosed ()

virtual bool	WriteString (const QByteArray &value)

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)
	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	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 ()

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

Detailed Description

Simple implementation of archive for writing of XML given as a string.

Definition at line 23 of file CXmlStringWriteArchive.h.

Member Typedef Documentation

◆ BaseClass

CXmlWriteArchiveBase iser::CXmlStringWriteArchive::BaseClass

Definition at line 26 of file CXmlStringWriteArchive.h.

Constructor & Destructor Documentation

◆ CXmlStringWriteArchive()

iser::CXmlStringWriteArchive::CXmlStringWriteArchive	(	const IVersionInfo *	versionInfoPtr = nullptr,
		bool	serializeHeader = true,
		const CArchiveTag &	rootTag = s_acfRootTag )

◆ ~CXmlStringWriteArchive()

virtual iser::CXmlStringWriteArchive::~CXmlStringWriteArchive ( )

virtual

Member Function Documentation

◆ EnsureArchiveClosed()

void iser::CXmlStringWriteArchive::EnsureArchiveClosed ( )

protected

◆ GetString()

virtual const QByteArray & iser::CXmlStringWriteArchive::GetString ( ) const

virtual

Close the archive and get the created XML string.

◆ WriteString()

virtual bool iser::CXmlStringWriteArchive::WriteString ( const QByteArray & value )

protectedvirtual

Implements iser::CXmlWriteArchiveBase.

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

iser/CXmlStringWriteArchive.h

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members