Provides access to version information. More...

#include <IVersionInfo.h>

Inheritance diagram for iser::IVersionInfo:

Public Types
enum	VersionId { AcfVersionId = 0 , QtVersionId = 1023 , UserVersionId = 1024 }
	Type of version. More...

enum	{ UnknownVersion = 0xffffffff }

typedef QSet< int >	VersionIds

Public Types inherited from istd::IChangeable
enum	ChangeFlags { CF_ACF_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 }
	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...

typedef QMultiMap< QByteArray, QVariant >	ChangeInfoMap

Public Member Functions
virtual VersionIds	GetVersionIds () const =0
	Get list of version ID's.

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

virtual QString	GetVersionIdDescription (int versionId) const =0
	Get description of version ID.

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

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 istd::TUniqueInterfacePtr< istd::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 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.

Public Member Functions inherited from istd::IPolymorphic
virtual	~IPolymorphic ()

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

Provides access to version information.

Definition at line 22 of file IVersionInfo.h.

Member Typedef Documentation

◆ VersionIds

typedef QSet<int> iser::IVersionInfo::VersionIds

Definition at line 45 of file IVersionInfo.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
UnknownVersion	Biggest version value used if no version is needed or known.

Definition at line 38 of file IVersionInfo.h.

◆ VersionId

enum iser::IVersionInfo::VersionId

Type of version.

This is needed for the sake of supporting mutliply separated versions for separated modules. Whole ACF framework lay under single versioning mechanism and has one version number identified by AcfVersionId type ID. User version type ID should be greater or equal UserVersionId value.

Enumerator
AcfVersionId
QtVersionId
UserVersionId

Definition at line 31 of file IVersionInfo.h.

Member Function Documentation

◆ GetEncodedVersionName()

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

pure virtual

Encode version number to human readable form.

Implemented in ibase::CApplicationInfoComp, ibase::CQtVersionInfoComp, ibase::CVersionInfoComp, ibase::TVersionInfoBase< BaseComponent >, iser::CArchiveHeaderInfo, iser::CMinimalVersionInfo, and iser::CWriteArchiveBase::EmptyVersionInfo.

◆ GetVersionIdDescription()

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

pure 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.

Implemented in ibase::CApplicationInfoComp, ibase::CQtVersionInfoComp, ibase::CVersionInfoComp, ibase::TVersionInfoBase< BaseComponent >, iser::CArchiveHeaderInfo, iser::CMinimalVersionInfo, and iser::CWriteArchiveBase::EmptyVersionInfo.

◆ GetVersionIds()

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

pure virtual

Get list of version ID's.

Implemented in ibase::CApplicationInfoComp, ibase::CQtVersionInfoComp, ibase::CVersionInfoComp, ibase::TVersionInfoBase< BaseComponent >, iser::CArchiveHeaderInfo, iser::CMinimalVersionInfo, and iser::CWriteArchiveBase::EmptyVersionInfo.

Referenced by ifile::TDeviceBasedSerializerComp< ReadArchive, WriteArchive >::CheckMinimalVersion().

◆ GetVersionNumber()

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

pure 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.

Implemented in ibase::CApplicationInfoComp, ibase::CQtVersionInfoComp, ibase::CVersionInfoComp, ibase::TVersionInfoBase< BaseComponent >, iser::CArchiveHeaderInfo, iser::CMinimalVersionInfo, and iser::CWriteArchiveBase::EmptyVersionInfo.

Referenced by ifile::TDeviceBasedSerializerComp< ReadArchive, WriteArchive >::CheckMinimalVersion(), and ilog::TExtMessage< Element >::Serialize().

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

Acf/Include/iser/IVersionInfo.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ VersionIds

Member Enumeration Documentation

◆ anonymous enum

◆ VersionId

Member Function Documentation

◆ GetEncodedVersionName()

◆ GetVersionIdDescription()

◆ GetVersionIds()

◆ GetVersionNumber()