Classes | Public Types | Public Member Functions | List of all members
icomp::IRegistry Class Referenceabstract

Interface representing information stored in component registry. More...

#include <IRegistry.h>

Inheritance diagram for icomp::IRegistry:
iser::ISerializable istd::IChangeable istd::IPolymorphic icomp::CRegistry ipackage::CPackagesLoaderComp::LogingRegistry

Classes

struct  ElementInfo
 Describe information stored with each element. More...
 

Public Types

enum  ChangeFlags {
  CF_ELEMENT_ADDED = 0xf72390, CF_ELEMENT_REMOVED, CF_ELEMENT_EXPORTED, CF_ELEMENT_RENAMED,
  CF_EMBEDDED
}
 Change flags. More...
 
typedef QSet< QByteArray > Ids
 
typedef istd::TDelPtr
< IRegistryElement
ElementPtr
 
typedef QMap< QByteArray,
QByteArray > 
ExportedInterfacesMap
 Map assigning interface ID (undecorated) to component ID exporting this interface. More...
 
typedef QMap< QByteArray,
QByteArray > 
ExportedElementsMap
 Map assigning exported sub-component names to internal subcomponent ID's. More...
 
- 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

virtual Ids GetElementIds () const =0
 Get ID list of existing elements. More...
 
virtual const ElementInfoGetElementInfo (const QByteArray &elementId) const =0
 Get access to stored attribute info structure. More...
 
virtual ElementInfoInsertElementInfo (const QByteArray &elementId, const icomp::CComponentAddress &address, bool ensureElementCreated=true)=0
 Insert new attribute info object to collection of attributes. More...
 
virtual bool RemoveElementInfo (const QByteArray &elementId)=0
 Removes attribute info structure from this collection. More...
 
virtual bool RenameElement (const QByteArray &oldElementId, const QByteArray &newElementId)=0
 Rename an registry element. More...
 
virtual Ids GetEmbeddedRegistryIds () const =0
 Get list of IDs of embedded registries. More...
 
virtual IRegistryGetEmbeddedRegistry (const QByteArray &registryId) const =0
 Get access to embedded registry using its ID. More...
 
virtual IRegistryInsertEmbeddedRegistry (const QByteArray &registryId)=0
 Insert embedded registry with specified ID. More...
 
virtual bool RemoveEmbeddedRegistry (const QByteArray &registryId)=0
 Remove embedded registry with specified ID. More...
 
virtual bool RenameEmbeddedRegistry (const QByteArray &oldRegistryId, const QByteArray &newRegistryId)=0
 Rename a embedded registry. More...
 
virtual const
ExportedInterfacesMap
GetExportedInterfacesMap () const =0
 Get access to information structure of exported interfaces. More...
 
virtual const ExportedElementsMapGetExportedElementsMap () const =0
 Get access to map used to convert exported sub-elements to internal sub-element ID's. More...
 
virtual void SetElementInterfaceExported (const QByteArray &elementId, const QByteArray &interfaceName, bool state=true)=0
 Enable or disable exporting single or all interfaces of element. More...
 
virtual void SetElementExported (const QByteArray &exportId, const QByteArray &elementId)=0
 Set element to be exported. More...
 
virtual const QString & GetDescription () const =0
 Get human readable description of this registry. More...
 
virtual void SetDescription (const QString &description)=0
 set human readable description of this registry. More...
 
virtual const QString & GetKeywords () const =0
 Get keywords for this registry used for search. More...
 
virtual void SetKeywords (const QString &keywords)=0
 Set keywords for this registry used for search. More...
 
- Public Member Functions inherited from iser::ISerializable
virtual bool Serialize (IArchive &archive)=0
 Load or store state of this object as a archive stream. More...
 
virtual quint32 GetMinimalVersion (int versionId) const
 Get minimal needed version to correct storing of this data. More...
 
- Public Member Functions inherited from istd::IChangeable
virtual int GetSupportedOperations () const
 Get set of flags for supported operations. More...
 
virtual bool CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS)
 Copy this object from another one. 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 ()
 

Additional Inherited Members

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

Interface representing information stored in component registry.

Registry is a model representing smallest component topology unit. Registry can be imagined as a representation of an acc file.

Definition at line 30 of file IRegistry.h.

Member Typedef Documentation

Definition at line 34 of file IRegistry.h.

typedef QMap<QByteArray, QByteArray> icomp::IRegistry::ExportedElementsMap

Map assigning exported sub-component names to internal subcomponent ID's.

Definition at line 65 of file IRegistry.h.

typedef QMap<QByteArray, QByteArray> icomp::IRegistry::ExportedInterfacesMap

Map assigning interface ID (undecorated) to component ID exporting this interface.

Definition at line 60 of file IRegistry.h.

typedef QSet<QByteArray> icomp::IRegistry::Ids

Definition at line 33 of file IRegistry.h.

Member Enumeration Documentation

Change flags.

Enumerator
CF_ELEMENT_ADDED 
CF_ELEMENT_REMOVED 
CF_ELEMENT_EXPORTED 
CF_ELEMENT_RENAMED 
CF_EMBEDDED 

Definition at line 39 of file IRegistry.h.

Member Function Documentation

virtual const QString& icomp::IRegistry::GetDescription ( ) const
pure virtual

Get human readable description of this registry.

Implemented in icomp::CRegistry.

virtual Ids icomp::IRegistry::GetElementIds ( ) const
pure virtual

Get ID list of existing elements.

Implemented in icomp::CRegistry.

Referenced by icomp::TComponentCloneWrap< BaseClass >::CloneMe().

virtual const ElementInfo* icomp::IRegistry::GetElementInfo ( const QByteArray &  elementId) const
pure virtual

Get access to stored attribute info structure.

Implemented in icomp::CRegistry.

virtual IRegistry* icomp::IRegistry::GetEmbeddedRegistry ( const QByteArray &  registryId) const
pure virtual

Get access to embedded registry using its ID.

Embedded registries are used to manage local composite components.

Implemented in icomp::CRegistry.

virtual Ids icomp::IRegistry::GetEmbeddedRegistryIds ( ) const
pure virtual

Get list of IDs of embedded registries.

Embedded registries are used to manage local composite components.

Returns
set of IDs.

Implemented in icomp::CRegistry.

virtual const ExportedElementsMap& icomp::IRegistry::GetExportedElementsMap ( ) const
pure virtual

Get access to map used to convert exported sub-elements to internal sub-element ID's.

Implemented in icomp::CRegistry.

virtual const ExportedInterfacesMap& icomp::IRegistry::GetExportedInterfacesMap ( ) const
pure virtual

Get access to information structure of exported interfaces.

Implemented in icomp::CRegistry.

virtual const QString& icomp::IRegistry::GetKeywords ( ) const
pure virtual

Get keywords for this registry used for search.

Implemented in icomp::CRegistry.

virtual ElementInfo* icomp::IRegistry::InsertElementInfo ( const QByteArray &  elementId,
const icomp::CComponentAddress address,
bool  ensureElementCreated = true 
)
pure virtual

Insert new attribute info object to collection of attributes.

Parameters
elementIdunique ID of new element (component).
addressaddress describing element type.
ensureElementCreatedif true new element will be created.

Implemented in ipackage::CPackagesLoaderComp::LogingRegistry, and icomp::CRegistry.

virtual IRegistry* icomp::IRegistry::InsertEmbeddedRegistry ( const QByteArray &  registryId)
pure virtual

Insert embedded registry with specified ID.

Returns
instance of new created embedded registry.

Implemented in icomp::CRegistry.

virtual bool icomp::IRegistry::RemoveElementInfo ( const QByteArray &  elementId)
pure virtual

Removes attribute info structure from this collection.

Implemented in icomp::CRegistry.

virtual bool icomp::IRegistry::RemoveEmbeddedRegistry ( const QByteArray &  registryId)
pure virtual

Remove embedded registry with specified ID.

Returns
true, if registry could be removed.

Implemented in icomp::CRegistry.

virtual bool icomp::IRegistry::RenameElement ( const QByteArray &  oldElementId,
const QByteArray &  newElementId 
)
pure virtual

Rename an registry element.

Parameters
oldElementIdID of element to be renamed.
newElementIdthe new ID of element.

Implemented in icomp::CRegistry.

virtual bool icomp::IRegistry::RenameEmbeddedRegistry ( const QByteArray &  oldRegistryId,
const QByteArray &  newRegistryId 
)
pure virtual

Rename a embedded registry.

Parameters
oldElementIdID of element to be renamed.
newElementIdthe new ID of element.

Implemented in icomp::CRegistry.

virtual void icomp::IRegistry::SetDescription ( const QString &  description)
pure virtual

set human readable description of this registry.

Implemented in icomp::CRegistry.

virtual void icomp::IRegistry::SetElementExported ( const QByteArray &  exportId,
const QByteArray &  elementId 
)
pure virtual

Set element to be exported.

Parameters
exportIdID of exported name, or NULL if this export should be removed.
elementIdID of element or its subelement (separated with slash) or empty string, if this export should be removed.

Implemented in icomp::CRegistry.

virtual void icomp::IRegistry::SetElementInterfaceExported ( const QByteArray &  elementId,
const QByteArray &  interfaceName,
bool  state = true 
)
pure virtual

Enable or disable exporting single or all interfaces of element.

Parameters
elementIdID of element in registry.
exportInterfaceInfospecify interface. If must be invalid.
statethe export state. If false, the existing export will be removed.

Implemented in icomp::CRegistry.

virtual void icomp::IRegistry::SetKeywords ( const QString &  keywords)
pure virtual

Set keywords for this registry used for search.

Implemented in icomp::CRegistry.


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

© 2007-2017 Witold Gantzke and Kirill Lepskiy