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

#include <CSettingsWriteArchive.h>

Inheritance diagram for ifile::CSettingsWriteArchive:

Collaboration diagram for ifile::CSettingsWriteArchive:

Public Types
typedef iser::CTextWriteArchiveBase	BaseClass

typedef ifile::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 ifile::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=nullptr)
	Constructor.

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.

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.

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
virtual bool	IsTagSkippingSupported () const
	Check if skiping to the end of tag on EndTag is supported.

Public Member Functions inherited from iser::IArchive
Public Member Functions inherited from ifile::CSettingsArchiveBase
	CSettingsArchiveBase (const QString &organizationName, const QString &applicationName, const QString &rootKey, QSettings::Scope settingsScope=QSettings::UserScope)
	Constructor.

Protected Member Functions
bool	WriteTextNode (const QByteArray &text)
	Write single unformatted text node.

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.

Protected Member Functions inherited from ifile::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 CArchiveTag &	GetAcfRootTag ()

Protected Types inherited from ifile::CSettingsArchiveBase
typedef QList< TagInfo >	OpenTagsList

Protected Attributes inherited from ifile::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 21 of file CSettingsWriteArchive.h.

Member Typedef Documentation

◆ BaseClass

iser::CTextWriteArchiveBase ifile::CSettingsWriteArchive::BaseClass

Definition at line 24 of file CSettingsWriteArchive.h.

◆ BaseClass2

ifile::CSettingsArchiveBase ifile::CSettingsWriteArchive::BaseClass2

Definition at line 25 of file CSettingsWriteArchive.h.

Constructor & Destructor Documentation

◆ CSettingsWriteArchive()

ifile::CSettingsWriteArchive::CSettingsWriteArchive	(	const QString &	organizationName,
		const QString &	applicationName,
		const QString &	rootKey,
		QSettings::Scope	settingsScope = QSettings::UserScope,
		const iser::IVersionInfo *	versionInfoPtr = nullptr )

Constructor.

Parameters

organizationName	Name of the organization.
applicationName	Name of the application.
rootKey	The root key.
settingsScope	(Optional) the settings scope.
versionInfoPtr	(Optional) pointer to the version information instance.

Member Function Documentation

◆ BeginMultiTag()

virtual bool ifile::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

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 ifile::CSettingsWriteArchive::BeginTag ( const iser::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 ifile::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.