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

Implementation of an ICF archive deserializing from a JSON string. More...

#include <CJsonStringReadArchive.h>

Inheritance diagram for iser::CJsonStringReadArchive:
Collaboration diagram for iser::CJsonStringReadArchive:

Public Types

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

 CJsonStringReadArchive (const QByteArray &inputString)
 
virtual bool BeginTag (const iser::CArchiveTag &tag)
 Begin of archive tag.
 
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.
 
virtual bool EndTag (const iser::CArchiveTag &tag)
 End of archive tag.
 
virtual bool Process (QString &value)
 Process primitive type.
 
- Public Member Functions inherited from iser::CTextReadArchiveBase
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.
 
virtual bool Process (QByteArray &value)
 Process primitive type.
 
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
virtual bool IsTagSkippingSupported () const
 Check if skiping to the end of tag on EndTag is supported.
 
- Public Member Functions inherited from iser::IArchive

Protected Member Functions

bool ReadStringNode (QString &text)
 
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 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 CArchiveTagGetAcfRootTag ()
 
- Static Protected Attributes inherited from iser::CArchiveBase
static CArchiveTag s_acfRootTag
 

Detailed Description

Implementation of an ICF archive deserializing from a JSON string.

Note
As to simplify decoding of some more complicated data structures support for special annotation tags was added. They are used for guiding the deserialization algorithm in some special cases.

Definition at line 30 of file CJsonStringReadArchive.h.

Member Typedef Documentation

◆ BaseClass

Constructor & Destructor Documentation

◆ CJsonStringReadArchive()

iser::CJsonStringReadArchive::CJsonStringReadArchive ( const QByteArray & inputString)

Member Function Documentation

◆ BeginMultiTag()

virtual bool iser::CJsonStringReadArchive::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.

◆ BeginTag()

virtual bool iser::CJsonStringReadArchive::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.

◆ EndTag()

virtual bool iser::CJsonStringReadArchive::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.

◆ Process()

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

Process primitive type.

Implements iser::IArchive.

◆ ReadStringNode()

bool iser::CJsonStringReadArchive::ReadStringNode ( QString & text)
protected

◆ ReadTextNode()

virtual bool iser::CJsonStringReadArchive::ReadTextNode ( QByteArray & text)
protectedvirtual

Read single unformatted text node.

Implements iser::CTextReadArchiveBase.


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

© Witold Gantzke and Kirill Lepskiy