ICF 3.0.5.47
Technical documentation of ICF Libraries
iser::CXmlStringReadArchive Class Reference

Simple implementation for reading of a XML from a string. More...

#include <CXmlStringReadArchive.h>

Inheritance diagram for iser::CXmlStringReadArchive:
Collaboration diagram for iser::CXmlStringReadArchive:

Public Types

typedef CXmlStreamReadArchiveBase BaseClass
 
- Public Types inherited from iser::CXmlStreamReadArchiveBase
typedef CXmlReadArchiveBase BaseClass
 
- Public Types inherited from iser::CXmlReadArchiveBase
typedef CTextReadArchiveBase BaseClass
 
- Public Types inherited from iser::CTextReadArchiveBase
typedef CReadArchiveBase BaseClass
 
- Public Types inherited from iser::IArchive
enum  MessageId { MI_TAG_ERROR = 0x3f320a0 , MI_TAG_SKIPPED }
 

Public Member Functions

 CXmlStringReadArchive (const QByteArray &inputString, bool serializeHeader=true, const CArchiveTag &rootTag=s_acfRootTag)
 
- Public Member Functions inherited from iser::CXmlStreamReadArchiveBase
int GetLastReadLine () const
 
- Public Member Functions inherited from iser::CXmlReadArchiveBase
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::CTextReadArchiveBase
virtual bool ProcessData (void *dataPtr, int size)
 Process binary data block.
 
- Public Member Functions inherited from iser::CReadArchiveBase
bool IsChanging () const override
 Check if this archive processing change the object state.
 
const IVersionInfoGetVersionInfo () 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.
 

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 ()
 
- Protected Member Functions inherited from iser::CXmlStreamReadArchiveBase
 CXmlStreamReadArchiveBase (const CArchiveTag &rootTag=s_acfRootTag)
 
virtual bool ReadToDelimeter (const QByteArray &delimeters, QByteArray &result, bool skipDelimeter=true, char *foundDelimeterPtr=nullptr)
 Read input stream till one of specified delimeters is found.
 
virtual void DecorateMessage (istd::IInformationProvider::InformationCategory category, int id, int flags, QString &message, QString &messageSource) const
 Decorate message parts before outputting.
 
- Protected Member Functions inherited from iser::CXmlReadArchiveBase
 CXmlReadArchiveBase (const CArchiveTag &rootTag)
 
bool InternEndTag (const CArchiveTag &tag, bool &wasTagSkipped)
 Extended implementation of EndTag() with additional flag signalizing that tag is skipped.
 
virtual bool ReadXmlHeader ()
 
virtual bool ReadXmlFooter ()
 
virtual bool ReadTextNode (QByteArray &text)
 Read single unformatted text node.
 
- Protected Member Functions inherited from iser::CTextReadArchiveBase
- Protected Member Functions inherited from iser::CReadArchiveBase
bool SerializeIcfHeader ()
 Serialize standard header.
 
- Protected Member Functions inherited from iser::CArchiveBase
 CArchiveBase ()
 
- Protected Member Functions inherited from istd::ILogger
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.
 
- Protected Attributes inherited from iser::CXmlStreamReadArchiveBase
QTextStream m_stream
 
- Static Protected Attributes inherited from iser::CArchiveBase
static CArchiveTag s_acfRootTag
 

Detailed Description

Simple implementation for reading of a XML from a string.

This imlementation uses only single pass and is very fast, but it needs counter attribute idicating number of subtags for each mutli tag node.

Definition at line 25 of file CXmlStringReadArchive.h.

Member Typedef Documentation

◆ BaseClass

Constructor & Destructor Documentation

◆ CXmlStringReadArchive()

iser::CXmlStringReadArchive::CXmlStringReadArchive ( const QByteArray & inputString,
bool serializeHeader = true,
const CArchiveTag & rootTag = s_acfRootTag )

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

© Witold Gantzke and Kirill Lepskiy