Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
iser::CCompactXmlWriteArchiveBase Class Reference

Base class of compact XML write archive. More...

#include <CCompactXmlWriteArchiveBase.h>

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

Public Types

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

virtual ~CCompactXmlWriteArchiveBase ()
 
virtual bool IsTagSkippingSupported () const
 Check if skiping to the end of tag on EndTag is supported. More...
 
virtual bool BeginTag (const iser::CArchiveTag &tag)
 Begin of archive tag. More...
 
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. More...
 
virtual bool EndTag (const iser::CArchiveTag &tag)
 End of archive tag. More...
 
virtual bool Process (QString &value)
 Process primitive type. More...
 
- Public Member Functions inherited from iser::CTextWriteArchiveBase
virtual bool Process (bool &value)
 Process primitive type. More...
 
virtual bool Process (char &value)
 Process primitive type. More...
 
virtual bool Process (quint8 &value)
 Process primitive type. More...
 
virtual bool Process (qint8 &value)
 Process primitive type. More...
 
virtual bool Process (quint16 &value)
 Process primitive type. More...
 
virtual bool Process (qint16 &value)
 Process primitive type. More...
 
virtual bool Process (quint32 &value)
 Process primitive type. More...
 
virtual bool Process (qint32 &value)
 Process primitive type. More...
 
virtual bool Process (quint64 &value)
 Process primitive type. More...
 
virtual bool Process (qint64 &value)
 Process primitive type. More...
 
virtual bool Process (float &value)
 Process primitive type. More...
 
virtual bool Process (double &value)
 Process primitive type. More...
 
virtual bool Process (QByteArray &value)
 Process primitive type. More...
 
virtual bool ProcessData (void *dataPtr, int size)
 Process binary data block. More...
 
- Public Member Functions inherited from iser::CWriteArchiveBase
virtual bool IsStoring () const
 Check if this archive is loading or storing. More...
 
virtual const IVersionInfoGetVersionInfo () const
 Get version of archived stream for specific versioning type. More...
 
virtual bool ProcessBits (void *dataPtr, int bitsCount, int bytesCount)
 Process binary data block. More...
 
- 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. More...
 
void SetCommentEnabled (bool state=true)
 Allows comments in XML document. More...
 

Protected Member Functions

 CCompactXmlWriteArchiveBase (const iser::IVersionInfo *versionInfoPtr, bool serializeHeader, const iser::CArchiveTag &rootTag)
 
bool InitArchive (QIODevice *devicePtr)
 
bool Flush ()
 
bool WriteStringNode (const QString &text)
 
virtual bool WriteTextNode (const QByteArray &text)
 Write single unformatted text node. More...
 
- Protected Member Functions inherited from iser::CTextWriteArchiveBase
 CTextWriteArchiveBase (const IVersionInfo *versionInfoPtr)
 
- Protected Member Functions inherited from iser::CWriteArchiveBase
 CWriteArchiveBase (const IVersionInfo *versionInfoPtr)
 Constructor. More...
 
bool SerializeAcfHeader ()
 Serialize standard header. More...
 
- 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. More...
 
virtual bool IsLogConsumed (const IInformationProvider::InformationCategory *categoryPtr=NULL, const int *flagsPtr=NULL) const
 Check if any log message is consumed. More...
 
virtual bool SendLogMessage (IInformationProvider::InformationCategory category, int id, const QString &message, const QString &messageSource, int flags=0) const
 Send any message to log. More...
 

Protected Attributes

QXmlStreamWriter m_xmlWriter
 

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 ()
 
- Static Protected Attributes inherited from iser::CArchiveBase
static CArchiveTag s_acfRootTag
 

Detailed Description

Base class of compact XML write archive.

Definition at line 25 of file CCompactXmlWriteArchiveBase.h.

Member Typedef Documentation

Definition at line 30 of file CCompactXmlWriteArchiveBase.h.

Constructor & Destructor Documentation

virtual iser::CCompactXmlWriteArchiveBase::~CCompactXmlWriteArchiveBase ( )
virtual
iser::CCompactXmlWriteArchiveBase::CCompactXmlWriteArchiveBase ( const iser::IVersionInfo versionInfoPtr,
bool  serializeHeader,
const iser::CArchiveTag rootTag 
)
protected

Member Function Documentation

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

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

See Also
BeginTag.
Parameters
tagmain tag.
subTagtype of subelement tag.
countnumber of subelements. If it is read archive this value will be set. If it storing archive this is input value.
useTagSkippingflag 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.

virtual bool iser::CCompactXmlWriteArchiveBase::BeginTag ( const iser::CArchiveTag tag)
virtual

Begin of archive tag.

Parameters
tagtag object.
useTagSkippingflag signalling that support of tag skipping should be enabled.

Implements iser::IArchive.

virtual bool iser::CCompactXmlWriteArchiveBase::EndTag ( const iser::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.

bool iser::CCompactXmlWriteArchiveBase::Flush ( )
protected
bool iser::CCompactXmlWriteArchiveBase::InitArchive ( QIODevice *  devicePtr)
protected
virtual bool iser::CCompactXmlWriteArchiveBase::IsTagSkippingSupported ( ) const
virtual

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

See Also
EndTag.

Reimplemented from iser::CArchiveBase.

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

Process primitive type.

Implements iser::IArchive.

bool iser::CCompactXmlWriteArchiveBase::WriteStringNode ( const QString &  text)
protected
virtual bool iser::CCompactXmlWriteArchiveBase::WriteTextNode ( const QByteArray &  text)
protectedvirtual

Write single unformatted text node.

Implements iser::CTextWriteArchiveBase.

Reimplemented in ifile::CCompactXmlFileWriteArchive.

Member Data Documentation

QXmlStreamWriter iser::CCompactXmlWriteArchiveBase::m_xmlWriter
protected

Definition at line 55 of file CCompactXmlWriteArchiveBase.h.


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

© 2007-2017 Witold Gantzke and Kirill Lepskiy