ICF 3.0.5.47
Technical documentation of ICF Libraries
icomp::IRegistryElement Class Referenceabstract

Represents element of registry describing component parameters. More...

#include <IRegistryElement.h>

Inheritance diagram for icomp::IRegistryElement:
Collaboration diagram for icomp::IRegistryElement:

Classes

struct  AttributeInfo
 Describe information stored with each attribute. More...
 

Public Types

enum  ChangeFlags { CF_ATTRIBUTE_CHANGED = 0x29734ba , CF_FLAGS_CHANGED }
 
enum  ElementFlags { EF_AUTO_INSTANCE = 0x0001 , EF_IS_DETACHED = 0x0002 }
 
typedef std::unique_ptr< iser::IObjectAttributePtr
 
- Public Types inherited from iattr::IAttributesProvider
enum  ChangeFlags { CF_RESET = 0xb812936 , CF_ATTR_REMOVED , CF_ATTR_ADDED }
 Data model change notification flags. More...
 
typedef QSet< QByteArray > AttributeIds
 
- 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

virtual quint32 GetElementFlags () const =0
 Get flags of this registry element.
 
virtual void SetElementFlags (quint32 flags)=0
 Set flags of this registry element.
 
virtual AttributeInfoInsertAttributeInfo (const QByteArray &attributeId, const QByteArray &attributeType)=0
 Insert new attribute info object to collection of attributes.
 
virtual std::unique_ptr< iser::IObjectCreateAttribute (const QByteArray &attributeType) const =0
 Create attribute object for specified ID.
 
virtual const AttributeInfoGetAttributeInfo (const QByteArray &attributeId) const =0
 Get access to stored attribute info structure.
 
virtual bool RemoveAttribute (const QByteArray &attributeId)=0
 Removes attribute info structure from this collection.
 
- Public Member Functions inherited from iattr::IAttributesProvider
virtual AttributeIds GetAttributeIds () const =0
 Get list of all attribute IDs.
 
virtual iser::IObjectGetAttribute (const QByteArray &attributeId) const =0
 Get attribute for the given ID.
 
- 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< IChangeableCloneMe (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.
 
- Public Member Functions inherited from iser::ISerializable
virtual bool Serialize (IArchive &archive)=0
 Load or store state of this object as a archive stream.
 
virtual quint32 GetMinimalVersion (int versionId) const
 Get minimal needed version to correct storing of this data.
 

Additional Inherited Members

- Static Public Member Functions inherited from istd::IChangeable
static const ChangeSetGetNoChanges ()
 Get empty set of changes.
 
static const ChangeSetGetAnyChange ()
 Get anonymous change set.
 
static const ChangeSetGetAllChanges ()
 Get anonymous change set.
 
static const ChangeSetGetDelegatedChanges ()
 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

Represents element of registry describing component parameters.

Registry reflects state of registry files.

Definition at line 30 of file IRegistryElement.h.

Member Typedef Documentation

◆ AttributePtr

Definition at line 35 of file IRegistryElement.h.

Member Enumeration Documentation

◆ ChangeFlags

Enumerator
CF_ATTRIBUTE_CHANGED 

Indicate that data model is changed.

CF_FLAGS_CHANGED 

Definition at line 37 of file IRegistryElement.h.

◆ ElementFlags

Enumerator
EF_AUTO_INSTANCE 

Indicate that instance of this element should be automatically created.

EF_IS_DETACHED 

Indicate that this element is detached from container and can be used as factory.

Definition at line 46 of file IRegistryElement.h.

Member Function Documentation

◆ CreateAttribute()

virtual std::unique_ptr< iser::IObject > icomp::IRegistryElement::CreateAttribute ( const QByteArray & attributeType) const
pure virtual

Create attribute object for specified ID.

Implemented in icomp::CRegistryElement.

◆ GetAttributeInfo()

virtual const AttributeInfo * icomp::IRegistryElement::GetAttributeInfo ( const QByteArray & attributeId) const
pure virtual

Get access to stored attribute info structure.

Implemented in icomp::CRegistryElement.

◆ GetElementFlags()

virtual quint32 icomp::IRegistryElement::GetElementFlags ( ) const
pure virtual

Get flags of this registry element.

See also
ElementFlags

Implemented in icomp::CRegistryElement.

◆ InsertAttributeInfo()

virtual AttributeInfo * icomp::IRegistryElement::InsertAttributeInfo ( const QByteArray & attributeId,
const QByteArray & attributeType )
pure virtual

Insert new attribute info object to collection of attributes.

Parameters
attributeIdunique ID of new attribute.
createAttributeif it is true, new attribute instance will be created.

Implemented in icomp::CRegistryElement.

◆ RemoveAttribute()

virtual bool icomp::IRegistryElement::RemoveAttribute ( const QByteArray & attributeId)
pure virtual

Removes attribute info structure from this collection.

Implemented in icomp::CRegistryElement.

◆ SetElementFlags()

virtual void icomp::IRegistryElement::SetElementFlags ( quint32 flags)
pure virtual

Set flags of this registry element.

See also
ElementFlags

Implemented in icomp::CRegistryElement.


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

© Witold Gantzke and Kirill Lepskiy