Classes | Public Types | Public Member Functions | Static Public Member Functions | List of all members
iser::CArchiveHeaderInfo Class Reference

Represents functions related to ACF header. More...

#include <CArchiveHeaderInfo.h>

Inheritance diagram for iser::CArchiveHeaderInfo:
iser::IVersionInfo istd::IChangeable istd::IPolymorphic

Classes

struct  VersionIdElement
 

Public Types

enum  ChangeFlags { CF_VERSIONS_UPDATED = 0xb6eca0 }
 
- Public Types inherited from iser::IVersionInfo
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...
 

Public Member Functions

void Reset ()
 Remove all stored version infos. More...
 
bool InsertVersionId (int versionId, quint32 versionNumber, const QString &description)
 Insert new version id with its actual version number and its description. More...
 
bool RemoveVersionId (int versionId)
 Remove single version info. More...
 
bool SerializeArchiveHeader (IArchive &archive)
 
virtual VersionIds GetVersionIds () const
 Get list of version ID's. More...
 
virtual bool GetVersionNumber (int versionId, quint32 &result) const
 Get version of archived stream for specific versioning type. More...
 
virtual QString GetVersionIdDescription (int versionId) const
 Get description of version ID. More...
 
virtual QString GetEncodedVersionName (int versionId, quint32 versionNumber) const
 Encode version number to human readable form. More...
 
virtual bool CopyFrom (const istd::IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS)
 Copy this object from another one. More...
 
- Public Member Functions inherited from istd::IChangeable
virtual int GetSupportedOperations () const
 Get set of flags for supported operations. More...
 
virtual bool IsEqual (const IChangeable &object) const
 Compare this object with another object. More...
 
virtual IChangeableCloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const
 Make a copy of this object. More...
 
virtual bool ResetData (CompatibilityMode mode=CM_WITHOUT_REFS)
 Reset data to its default state. More...
 
virtual void BeginChanges (const ChangeSet &changeSet)
 Starts the change transaction. More...
 
virtual void EndChanges (const ChangeSet &changeSet)
 Ends the change transaction. More...
 
virtual void BeginChangeGroup (const ChangeSet &changeSet)
 Starts group of changes. More...
 
virtual void EndChangeGroup (const ChangeSet &changeSet)
 Ends group of changes. More...
 
- Public Member Functions inherited from istd::IPolymorphic
virtual ~IPolymorphic ()
 

Static Public Member Functions

static bool WriteArchiveHeader (IArchive &archive, const IVersionInfo *versionInfoPtr)
 
- Static Public Member Functions inherited from istd::IChangeable
static const ChangeSetGetNoChanges ()
 Get empty set of changes. More...
 
static const ChangeSetGetAnyChange ()
 Get anonymous change set. More...
 
static const ChangeSetGetAllChanges ()
 Get anonymous change set. More...
 
static const ChangeSetGetDelegatedChanges ()
 Get delegated change set. More...
 

Additional Inherited Members

- Protected Member Functions inherited from istd::IChangeable
virtual void OnBeginChanges ()
 Callback function for begin change event. More...
 
virtual void OnEndChanges (const ChangeSet &changeSet)
 Callback function for end change event. More...
 

Detailed Description

Represents functions related to ACF header.

See Also
iser::CReadArchiveBase.

Definition at line 25 of file CArchiveHeaderInfo.h.

Member Enumeration Documentation

Enumerator
CF_VERSIONS_UPDATED 

Definition at line 28 of file CArchiveHeaderInfo.h.

Member Function Documentation

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

Copy this object from another one.

Default implementation in istd::IChangeable does nothing.

Reimplemented from istd::IChangeable.

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

Encode version number to human readable form.

Implements iser::IVersionInfo.

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

Get description of version ID.

Parameters
versionIdversioning 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.

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

Get list of version ID's.

Implements iser::IVersionInfo.

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

Get version of archived stream for specific versioning type.

Parameters
versionIdversioning type. It allows you to distinguish different version aspects. For example version number of framework cann differ from application version.
See Also
VersionId.
Parameters
resultoutput 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.

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
versionIdID of version info.
versionNumberversion number for specified version info ID.
descriptiondescription of role of specified version info.
bool iser::CArchiveHeaderInfo::RemoveVersionId ( int  versionId)

Remove single version info.

Parameters
versionIdID of version info.
void iser::CArchiveHeaderInfo::Reset ( )

Remove all stored version infos.

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

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

© 2007-2017 Witold Gantzke and Kirill Lepskiy