iser::CMinimalVersionInfo Class Reference

Implementation of interface iser::IVersionInfo using information about minimal needed version from interface iser::ISerializable. More...

#include <CMinimalVersionInfo.h>

Inheritance diagram for iser::CMinimalVersionInfo:

Collaboration diagram for iser::CMinimalVersionInfo:

Public Member Functions
	CMinimalVersionInfo (const ISerializable *serializablePtr, bool addStandardIds=true)
	Constructor with initialization of reference to iser::ISerializable and registring of standard ID's.
bool	AddId (int versionId, const QString &description="")
	Add new version ID.
virtual bool	GetVersionNumber (int versionId, quint32 &result) const
	Get version of archived stream for specific versioning type.
virtual QString	GetVersionIdDescription (int versionId) const
	Get description of version ID.
virtual VersionIds	GetVersionIds () const
	Get list of version ID's.
virtual QString	GetEncodedVersionName (int versionId, quint32 versionNumber) const
	Encode version number to human readable form.
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	CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS)
	Copy this object from another one.
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.

Additional Inherited Members
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...
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.
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

Implementation of interface iser::IVersionInfo using information about minimal needed version from interface iser::ISerializable.

Please note, that list of ID's for version info must be separate created, becouse this information can not be retrived from iser::ISerializable.

Definition at line 29 of file CMinimalVersionInfo.h.

Constructor & Destructor Documentation

CMinimalVersionInfo()

iser::CMinimalVersionInfo::CMinimalVersionInfo	(	const ISerializable *	serializablePtr,
		bool	addStandardIds = true )

Constructor with initialization of reference to iser::ISerializable and registring of standard ID's.

Parameters

serializablePtr	pointer to serializable parent object for which minimal needed version will be calculated.
addStandardIds	if it is true, standard ID will be registered.

Member Function Documentation

AddId()

bool iser::CMinimalVersionInfo::AddId	(	int	versionId,
		const QString &	description = "" )

Add new version ID.

Parameters

versionId	ID of registered version.
description	description of this ID.

Returns

true, if success.

GetEncodedVersionName()

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

virtual

Encode version number to human readable form.

Implements iser::IVersionInfo.

GetVersionIdDescription()

virtual QString iser::CMinimalVersionInfo::GetVersionIdDescription ( int versionId ) const

virtual

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()

virtual VersionIds iser::CMinimalVersionInfo::GetVersionIds ( ) const

virtual

Get list of version ID's.

Implements iser::IVersionInfo.

GetVersionNumber()

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

virtual

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.

---

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

• iser/CMinimalVersionInfo.h