Public Types | Public Member Functions | Protected Member Functions | List of all members
iqt::CSettingsWriteArchive Class Reference

Write archive implementation for serialization based on QSettings. More...

#include <CSettingsWriteArchive.h>

Inheritance diagram for iqt::CSettingsWriteArchive:
iser::CTextWriteArchiveBase iqt::CSettingsArchiveBase iser::CWriteArchiveBase iser::CArchiveBase iser::IArchive istd::ILogger istd::IPolymorphic istd::IPolymorphic

Public Types

typedef iser::CTextWriteArchiveBase BaseClass
 
typedef iqt::CSettingsArchiveBase BaseClass2
 
- 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 Types inherited from iqt::CSettingsArchiveBase
typedef QSettings BaseClass
 

Public Member Functions

 CSettingsWriteArchive (const QString &organizationName, const QString &applicationName, const QString &rootKey, QSettings::Scope settingsScope=QSettings::UserScope, const iser::IVersionInfo *versionInfoPtr=NULL)
 Constructor. 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 iser::CArchiveBase
virtual bool IsTagSkippingSupported () const
 Check if skiping to the end of tag on EndTag is supported. More...
 
- Public Member Functions inherited from istd::IPolymorphic
virtual ~IPolymorphic ()
 
- Public Member Functions inherited from iqt::CSettingsArchiveBase
 CSettingsArchiveBase (const QString &organizationName, const QString &applicationName, const QString &rootKey, QSettings::Scope settingsScope=QSettings::UserScope)
 Constructor. More...
 

Protected Member Functions

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 Member Functions inherited from iqt::CSettingsArchiveBase
bool EnterTag (const QByteArray &tagId)
 
bool LeaveTag (const QByteArray &tagId)
 
QString GetCurrentCountKey () const
 
QString CreateNextValueKey ()
 
QString GetBaseKey () const
 

Additional Inherited Members

- Static Public Member Functions inherited from iser::CArchiveBase
static const CArchiveTagGetAcfRootTag ()
 
- Protected Types inherited from iqt::CSettingsArchiveBase
typedef QList< TagInfoOpenTagsList
 
- Protected Attributes inherited from iqt::CSettingsArchiveBase
OpenTagsList m_openTagsList
 
QString m_rootKey
 
int m_valuesCount
 
- Static Protected Attributes inherited from iser::CArchiveBase
static CArchiveTag s_acfRootTag
 

Detailed Description

Write archive implementation for serialization based on QSettings.

Definition at line 19 of file CSettingsWriteArchive.h.

Member Typedef Documentation

Definition at line 22 of file CSettingsWriteArchive.h.

Definition at line 23 of file CSettingsWriteArchive.h.

Constructor & Destructor Documentation

iqt::CSettingsWriteArchive::CSettingsWriteArchive ( const QString &  organizationName,
const QString &  applicationName,
const QString &  rootKey,
QSettings::Scope  settingsScope = QSettings::UserScope,
const iser::IVersionInfo versionInfoPtr = NULL 
)

Constructor.

Parameters
organizationNameName of the organization.
applicationNameName of the application.
rootKeyThe root key.
settingsScope(Optional) the settings scope.
versionInfoPtr(Optional) pointer to the version information instance.

Member Function Documentation

virtual bool iqt::CSettingsWriteArchive::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 iqt::CSettingsWriteArchive::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 iqt::CSettingsWriteArchive::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.

virtual bool iqt::CSettingsWriteArchive::Process ( QString &  value)
virtual

Process primitive type.

Implements iser::IArchive.

bool iqt::CSettingsWriteArchive::WriteTextNode ( const QByteArray &  text)
protectedvirtual

Write single unformatted text node.

Implements iser::CTextWriteArchiveBase.


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

© 2007-2017 Witold Gantzke and Kirill Lepskiy