Represents functions related to ICF header. More...

#include <CArchiveHeaderInfo.h>

Inheritance diagram for iser::CArchiveHeaderInfo:

Collaboration diagram for iser::CArchiveHeaderInfo:

Classes
struct	VersionIdElement

Public Types
enum	ChangeFlags { CF_VERSIONS_UPDATED = 0xb6eca0 }

Public Types inherited from iser::IVersionInfo
enum	VersionId { IcfVersionId = 1000 , QtVersionId = 1023 , UserVersionId = 1024 }
	Type of version. More...

enum	{ UnknownVersion = 0xffffffff }

typedef QSet< int >	VersionIds

Public Types inherited from istd::IChangeable
enum	ChangeFlags { CF_ICF_INTERNAL = 0 , CF_ALL_DATA , CF_ANY , CF_DESTROYING , CF_DELEGATED , CF_NO_UNDO }
	Data model change notification flags. More...

enum	SupportedOperations { SO_NONE = 0 , SO_OBSERVE = 1 << 0 , SO_COPY = 1 << 1 , SO_CLONE = 1 << 2 , SO_COMPARE = 1 << 3 , SO_RESET = 1 << 4 , SO_CHANGE_LOCK = 1 << 5 }
	Flags for supported operations. More...

enum	CompatibilityMode { CM_STRICT , CM_WITHOUT_REFS , CM_WITH_REFS , CM_CONVERT }
	Control how relationship betweeen objects are interpreted. More...

Public Member Functions
void	Reset ()
	Remove all stored version infos.

bool	InsertVersionId (int versionId, quint32 versionNumber, const QString &description)
	Insert new version id with its actual version number and its description.

bool	RemoveVersionId (int versionId)
	Remove single version info.

bool	SerializeArchiveHeader (IArchive &archive)

VersionIds	GetVersionIds () const override
	Get list of version ID's.

bool	GetVersionNumber (int versionId, quint32 &result) const override
	Get version of archived stream for specific versioning type.

QString	GetVersionIdDescription (int versionId) const override
	Get description of version ID.

QString	GetEncodedVersionName (int versionId, quint32 versionNumber) const override
	Encode version number to human readable form.

bool	CopyFrom (const istd::IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS) override
	Copy this object from another one.

Public Member Functions inherited from iser::IVersionInfo
Public Member Functions inherited from istd::IChangeable
virtual int	GetSupportedOperations () const
	Get set of flags for supported operations.

virtual bool	IsEqual (const IChangeable &object) const
	Compare this object with another object.

virtual std::unique_ptr< IChangeable >	CloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const
	Make a copy of this object.

virtual bool	ResetData (CompatibilityMode mode=CM_WITHOUT_REFS)
	Reset data to its default state.

virtual QMutex *	GetChangesLock () const
	Get mutex beeing locked during changes, if available.

virtual void	BeginChanges (const ChangeSet &changeSet)
	Starts the change transaction.

virtual void	EndChanges (const ChangeSet &changeSet)
	Ends the change transaction.

virtual void	BeginChangeGroup (const ChangeSet &changeSet)
	Starts group of changes.

virtual void	EndChangeGroup (const ChangeSet &changeSet)
	Ends group of changes.

Static Public Member Functions
static bool	WriteArchiveHeader (IArchive &archive, const IVersionInfo *versionInfoPtr)

Static Public Member Functions inherited from istd::IChangeable
static const ChangeSet &	GetNoChanges ()
	Get empty set of changes.

static const ChangeSet &	GetAnyChange ()
	Get anonymous change set.

static const ChangeSet &	GetAllChanges ()
	Get anonymous change set.

static const ChangeSet &	GetDelegatedChanges ()
	Get delegated change set.

Additional Inherited Members
Protected Member Functions inherited from istd::IChangeable
virtual void	OnBeginChanges ()
	Callback function for begin change event.

virtual void	OnEndChanges (const ChangeSet &changeSet)
	Callback function for end change event.

Detailed Description

Represents functions related to ICF header.

See also: iser::CReadArchiveBase.

Definition at line 27 of file CArchiveHeaderInfo.h.

Member Enumeration Documentation

◆ ChangeFlags

enum iser::CArchiveHeaderInfo::ChangeFlags

Enumerator
CF_VERSIONS_UPDATED

Definition at line 30 of file CArchiveHeaderInfo.h.

Member Function Documentation

◆ CopyFrom()

bool iser::CArchiveHeaderInfo::CopyFrom	(	const istd::IChangeable &	object,
		CompatibilityMode	mode = CM_WITHOUT_REFS )

overridevirtual

Copy this object from another one.

Default implementation in istd::IChangeable does nothing. You may check, if this functionality is supported over GetSupportedOperations().

Reimplemented from istd::IChangeable.

◆ GetEncodedVersionName()

QString iser::CArchiveHeaderInfo::GetEncodedVersionName	(	int	versionId,
		quint32	versionNumber ) const

overridevirtual

Encode version number to human readable form.

Implements iser::IVersionInfo.

◆ GetVersionIdDescription()

QString iser::CArchiveHeaderInfo::GetVersionIdDescription ( int versionId ) const

overridevirtual

Get description of version ID.

Parameters

versionId versioning type. It allows you to distinguish different version aspects. For example version number of framework cann differ from application version.

See also: VersionId, GetVersionNumber.

Implements iser::IVersionInfo.

◆ GetVersionIds()

VersionIds iser::CArchiveHeaderInfo::GetVersionIds ( ) const

overridevirtual

Get list of version ID's.

Implements iser::IVersionInfo.

◆ GetVersionNumber()

bool iser::CArchiveHeaderInfo::GetVersionNumber	(	int	versionId,
		quint32 &	result ) const

overridevirtual

Get version of archived stream for specific versioning type.

Parameters

versionId versioning type. It allows you to distinguish different version aspects. For example version number of framework cann differ from application version.

See also: VersionId.

Parameters

result output version number. For unknown version it will be set to bigg number to indicate of using the newest version.

Returns: true, if version is known.

Implements iser::IVersionInfo.

◆ InsertVersionId()

bool iser::CArchiveHeaderInfo::InsertVersionId	(	int	versionId,
		quint32	versionNumber,
		const QString &	description )

Insert new version id with its actual version number and its description.

See also: iser::IVersionInfo.

Parameters

versionId	ID of version info.
versionNumber	version number for specified version info ID.
description	description of role of specified version info.

◆ RemoveVersionId()

bool iser::CArchiveHeaderInfo::RemoveVersionId ( int versionId )

Remove single version info.

Parameters

versionId ID of version info.

◆ Reset()

void iser::CArchiveHeaderInfo::Reset ( )

Remove all stored version infos.

◆ SerializeArchiveHeader()

bool iser::CArchiveHeaderInfo::SerializeArchiveHeader ( IArchive & archive )

◆ WriteArchiveHeader()

static bool iser::CArchiveHeaderInfo::WriteArchiveHeader	(	IArchive &	archive,
		const IVersionInfo *	versionInfoPtr )

static

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

iser/CArchiveHeaderInfo.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ChangeFlags

Member Function Documentation

◆ CopyFrom()

◆ GetEncodedVersionName()

◆ GetVersionIdDescription()

◆ GetVersionIds()

◆ GetVersionNumber()

◆ InsertVersionId()

◆ RemoveVersionId()

◆ Reset()

◆ SerializeArchiveHeader()

◆ WriteArchiveHeader()