Base class for XML storing archives. More...

#include <CXmlWriteArchiveBase.h>

Inheritance diagram for iser::CXmlWriteArchiveBase:

Collaboration diagram for iser::CXmlWriteArchiveBase:

Public Types
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
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
	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.

virtual bool	WriteString (const QByteArray &value)=0

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

Base class for XML storing archives.

Definition at line 21 of file CXmlWriteArchiveBase.h.

Member Typedef Documentation

◆ BaseClass

CTextWriteArchiveBase iser::CXmlWriteArchiveBase::BaseClass

Definition at line 24 of file CXmlWriteArchiveBase.h.

Constructor & Destructor Documentation

◆ CXmlWriteArchiveBase()

iser::CXmlWriteArchiveBase::CXmlWriteArchiveBase	(	const IVersionInfo *	versionInfoPtr,
		const CArchiveTag &	rootTag )

protected

Member Function Documentation

◆ BeginMultiTag()

virtual bool iser::CXmlWriteArchiveBase::BeginMultiTag	(	const CArchiveTag &	tag,
		const CArchiveTag &	subTag,
		int &	count )

virtual

Begin of archive tag containing set of subelements of the same type.

See also: BeginTag.

Parameters

tag	main tag.
subTag	type of subelement tag.
count	number of subelements. If it is read archive this value will be set. If it storing archive this is input value.
useTagSkipping	flag signalling that support of tag skipping should be enabled.

Returns: true if success. In this case you have to call EndTag after serializing of subelements.

Reimplemented from iser::CArchiveBase.

◆ BeginTag()

virtual bool iser::CXmlWriteArchiveBase::BeginTag ( const CArchiveTag & tag )

virtual

Begin of archive tag.

Parameters

tag	tag object.
useTagSkipping	flag signalling that support of tag skipping should be enabled.

Implements iser::IArchive.

◆ EndTag()

virtual bool iser::CXmlWriteArchiveBase::EndTag ( const CArchiveTag & tag )

virtual

End of archive tag.

This method should be allways called after BeginTag is successfull called. If skipping of tag contains is supported, this will skip to the end of tag while archive reading. Otherwise you have to read contains of archive completely.

See also: IsTagSkippingSupported.

Implements iser::IArchive.

◆ IsTagSkippingSupported()

virtual bool iser::CXmlWriteArchiveBase::IsTagSkippingSupported ( ) const

virtual

Check if skiping to the end of tag on EndTag is supported.

See also: EndTag.

Reimplemented from iser::CArchiveBase.

◆ MakeIndent()

bool iser::CXmlWriteArchiveBase::MakeIndent ( )

protected

◆ Process() [1/14]

virtual bool iser::CTextWriteArchiveBase::Process ( bool & value )

virtual

Process primitive type.

Reimplemented from iser::CTextWriteArchiveBase.

◆ Process() [2/14]

virtual bool iser::CTextWriteArchiveBase::Process ( char & value )

virtual

Process primitive type.

Reimplemented from iser::CTextWriteArchiveBase.

◆ Process() [3/14]

virtual bool iser::CTextWriteArchiveBase::Process ( double & value )

virtual

Process primitive type.

Reimplemented from iser::CTextWriteArchiveBase.

◆ Process() [4/14]

virtual bool iser::CTextWriteArchiveBase::Process ( float & value )

virtual

Process primitive type.

Reimplemented from iser::CTextWriteArchiveBase.

◆ Process() [5/14]

virtual bool iser::CXmlWriteArchiveBase::Process ( QByteArray & value )

virtual

Process primitive type.

Reimplemented from iser::CTextWriteArchiveBase.

◆ Process() [6/14]

virtual bool iser::CTextWriteArchiveBase::Process ( qint16 & value )

virtual

Process primitive type.

Reimplemented from iser::CTextWriteArchiveBase.

◆ Process() [7/14]

virtual bool iser::CTextWriteArchiveBase::Process ( qint32 & value )

virtual

Process primitive type.

Reimplemented from iser::CTextWriteArchiveBase.

◆ Process() [8/14]

virtual bool iser::CTextWriteArchiveBase::Process ( qint64 & value )

virtual

Process primitive type.

Reimplemented from iser::CTextWriteArchiveBase.

◆ Process() [9/14]

virtual bool iser::CTextWriteArchiveBase::Process ( qint8 & value )

virtual

Process primitive type.

Reimplemented from iser::CTextWriteArchiveBase.

◆ Process() [10/14]

virtual bool iser::CXmlWriteArchiveBase::Process ( QString & value )

virtual

Process primitive type.

Implements iser::IArchive.

◆ Process() [11/14]

virtual bool iser::CTextWriteArchiveBase::Process ( quint16 & value )

virtual

Process primitive type.

Reimplemented from iser::CTextWriteArchiveBase.

◆ Process() [12/14]

virtual bool iser::CTextWriteArchiveBase::Process ( quint32 & value )

virtual

Process primitive type.

Reimplemented from iser::CTextWriteArchiveBase.

◆ Process() [13/14]

virtual bool iser::CTextWriteArchiveBase::Process ( quint64 & value )

virtual

Process primitive type.

Reimplemented from iser::CTextWriteArchiveBase.

◆ Process() [14/14]

virtual bool iser::CTextWriteArchiveBase::Process ( quint8 & value )

virtual

Process primitive type.

Reimplemented from iser::CTextWriteArchiveBase.

◆ WriteString()

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

protectedpure virtual

Implemented in ifile::CSimpleXmlFileWriteArchive, and iser::CXmlStringWriteArchive.

◆ WriteTextNode()

bool iser::CXmlWriteArchiveBase::WriteTextNode ( const QByteArray & text )

protectedvirtual

Write single unformatted text node.

Implements iser::CTextWriteArchiveBase.

◆ WriteXmlFooter()

bool iser::CXmlWriteArchiveBase::WriteXmlFooter ( )

protected

Write XML footer.

◆ WriteXmlHeader()

bool iser::CXmlWriteArchiveBase::WriteXmlHeader ( )

protected

Write XML header.

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

iser/CXmlWriteArchiveBase.h

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BaseClass

Constructor & Destructor Documentation

◆ CXmlWriteArchiveBase()

Member Function Documentation

◆ BeginMultiTag()

◆ BeginTag()

◆ EndTag()

◆ IsTagSkippingSupported()

◆ MakeIndent()

◆ Process() [1/14]

◆ Process() [2/14]

◆ Process() [3/14]

◆ Process() [4/14]

◆ Process() [5/14]

◆ Process() [6/14]

◆ Process() [7/14]

◆ Process() [8/14]

◆ Process() [9/14]

◆ Process() [10/14]

◆ Process() [11/14]

◆ Process() [12/14]

◆ Process() [13/14]

◆ Process() [14/14]

◆ WriteString()

◆ WriteTextNode()

◆ WriteXmlFooter()

◆ WriteXmlHeader()