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

#include <CSettingsWriteArchive.h>

Inheritance diagram for iqt::CSettingsWriteArchive:

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.

virtual bool	BeginTag (const iser::CArchiveTag &tag) override
	Begins a tagged section in the archive.

virtual bool	BeginMultiTag (const iser::CArchiveTag &tag, const iser::CArchiveTag &subTag, int &count) override
	Begins a tagged section containing multiple elements of the same type.

virtual bool	EndTag (const iser::CArchiveTag &tag) override
	Ends a tagged section in the archive.

virtual bool	Process (QString &value) override
	Process primitive type.

virtual bool	Process (bool &value) override
	Processes (reads or writes) a boolean value.

virtual bool	Process (char &value) override
	Process primitive type.

virtual bool	Process (quint8 &value) override
	Process primitive type.

virtual bool	Process (qint8 &value) override
	Process primitive type.

virtual bool	Process (quint16 &value) override
	Process primitive type.

virtual bool	Process (qint16 &value) override
	Process primitive type.

virtual bool	Process (quint32 &value) override
	Process primitive type.

virtual bool	Process (qint32 &value) override
	Process primitive type.

virtual bool	Process (quint64 &value) override
	Process primitive type.

virtual bool	Process (qint64 &value) override
	Process primitive type.

virtual bool	Process (float &value) override
	Process primitive type.

virtual bool	Process (double &value) override
	Process primitive type.

virtual bool	Process (QByteArray &value) override
	Process primitive type.

Public Member Functions inherited from iser::CTextWriteArchiveBase
virtual bool	ProcessData (void *dataPtr, int size) override
	Process binary data block.

Public Member Functions inherited from iser::CWriteArchiveBase
virtual bool	IsStoring () const override
	Checks if this archive is in storing (writing) or loading (reading) mode.

virtual const IVersionInfo &	GetVersionInfo () const override
	Gets version information for the archived stream.

virtual bool	ProcessBits (void *dataPtr, int bitsCount, int bytesCount) override
	Process binary data block.

Public Member Functions inherited from iser::CArchiveBase
virtual bool	IsTagSkippingSupported () const override
	Checks if skipping to the end of a tag on EndTag() is supported.

Public Member Functions inherited from iser::IArchive
template<typename Primitive >
bool	TagAndProcess (const CArchiveTag &tag, Primitive &value)

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.

Protected Member Functions
virtual bool	WriteTextNode (const QByteArray &text) override
	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	SerializeAcfHeader ()
	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=NULL, const int flagsPtr=NULL) 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 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 CArchiveTag &	GetAcfRootTag ()

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

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

◆ BaseClass

typedef iser::CTextWriteArchiveBase iqt::CSettingsWriteArchive::BaseClass

Definition at line 22 of file CSettingsWriteArchive.h.

◆ BaseClass2

typedef iqt::CSettingsArchiveBase iqt::CSettingsWriteArchive::BaseClass2

Definition at line 23 of file CSettingsWriteArchive.h.

Constructor & Destructor Documentation

◆ CSettingsWriteArchive()

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

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 iqt::CSettingsWriteArchive::BeginMultiTag	(	const iser::CArchiveTag &	tag,
		const iser::CArchiveTag &	subTag,
		int &	count
	)

overridevirtual

Begins a tagged section containing multiple elements of the same type.

BeginMultiTag is used for serializing collections, arrays, or lists where you have multiple items of the same structure. The count parameter works differently for reading vs. writing:

Writing: Pass the number of elements you will serialize
Reading: The archive sets count to the number of elements stored

Parameters

tag	Main container tag for the entire collection
subTag	Tag type for each individual element in the collection
count	[in/out] For writing: number of elements to serialize For reading: set by archive to number of stored elements

Returns: true if successful, false on error

// Writing a list
if (archive.IsStoring()) {
       int count = m_items.count();
       archive.BeginMultiTag(listTag, itemTag, count);
       for (const Item& item : m_items) {
              archive.BeginTag(itemTag);
              item.Serialize(archive);
              archive.EndTag(itemTag);
       }
       archive.EndTag(listTag);
}
// Reading a list
else {
       int count;
       archive.BeginMultiTag(listTag, itemTag, count);
       m_items.clear();
       for (int i = 0; i < count; ++i) {
              archive.BeginTag(itemTag);
              Item item;
              item.Serialize(archive);
              m_items.append(item);
              archive.EndTag(itemTag);
       }
       archive.EndTag(listTag);
}

See also: BeginTag(), EndTag()

Reimplemented from iser::CArchiveBase.

◆ BeginTag()

virtual bool iqt::CSettingsWriteArchive::BeginTag ( const iser::CArchiveTag & tag )

overridevirtual

Begins a tagged section in the archive.

Tags organize data into logical units with names and descriptions. Every BeginTag() must be matched with an EndTag() call. Tags can be nested to create hierarchical data structures.

Parameters

tag	The tag object describing this section. Use static CArchiveTag instances to avoid repeated construction overhead.

Returns: true if the tag was successfully opened, false on error

Note: Always match BeginTag() with EndTag(); Check the return value and propagate errors; For collections, use BeginMultiTag() instead

static iser::CArchiveTag personTag("Person", "Person data");
if (archive.BeginTag(personTag)) {
       archive.Process(name);
       archive.Process(age);
       archive.EndTag(personTag);
}

See also: EndTag(), BeginMultiTag(), CArchiveTag

Implements iser::IArchive.

◆ EndTag()

virtual bool iqt::CSettingsWriteArchive::EndTag ( const iser::CArchiveTag & tag )

overridevirtual

Ends a tagged section in the archive.

Must be called after BeginTag() or BeginMultiTag() to close the section. If tag skipping is supported and not all data was read, this will skip to the end of the tag section, enabling forward compatibility.

Parameters

tag	The same tag object passed to BeginTag() or BeginMultiTag()

Returns: true if successful, false on error

Note: Always call EndTag() even if errors occurred within the tag; The tag parameter must match the one used in BeginTag(); If IsTagSkippingSupported() returns false, you must read all data before calling EndTag()

static iser::CArchiveTag dataTag("Data", "My data");
if (archive.BeginTag(dataTag)) {
       bool success = archive.Process(myData);
       archive.EndTag(dataTag);  // Always call, even if Process failed
       if (!success) return false;
}