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

#include <IRegistry.h>

Inheritance diagram for icomp::IRegistry:

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.

typedef QMap< QByteArray, QByteArray >	ExportedElementsMap
	Map assigning exported sub-component names to internal subcomponent ID's.

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 Ids	GetElementIds () const =0
	Get ID list of existing elements.

virtual const ElementInfo *	GetElementInfo (const QByteArray &elementId) const =0
	Get access to stored attribute info structure.

virtual ElementInfo *	InsertElementInfo (const QByteArray &elementId, const icomp::CComponentAddress &address, bool ensureElementCreated=true)=0
	Insert new attribute info object to collection of attributes.

virtual bool	RemoveElementInfo (const QByteArray &elementId)=0
	Removes attribute info structure from this collection.

virtual bool	RenameElement (const QByteArray &oldElementId, const QByteArray &newElementId)=0
	Rename an registry element.

virtual Ids	GetEmbeddedRegistryIds () const =0
	Get list of IDs of embedded registries.

virtual IRegistry *	GetEmbeddedRegistry (const QByteArray &registryId) const =0
	Get access to embedded registry using its ID.

virtual IRegistry *	InsertEmbeddedRegistry (const QByteArray &registryId)=0
	Insert embedded registry with specified ID.

virtual bool	RemoveEmbeddedRegistry (const QByteArray &registryId)=0
	Remove embedded registry with specified ID.

virtual bool	RenameEmbeddedRegistry (const QByteArray &oldRegistryId, const QByteArray &newRegistryId)=0
	Rename a embedded registry.

virtual const ExportedInterfacesMap &	GetExportedInterfacesMap () const =0
	Get access to information structure of exported interfaces.

virtual const ExportedElementsMap &	GetExportedElementsMap () const =0
	Get access to map used to convert exported sub-elements to internal sub-element ID's.

virtual void	SetElementInterfaceExported (const QByteArray &elementId, const QByteArray &interfaceName, bool state=true)=0
	Enable or disable exporting single or all interfaces of element.

virtual void	SetElementExported (const QByteArray &exportId, const QByteArray &elementId)=0
	Set element to be exported.

virtual const QString &	GetDescription () const =0
	Get human readable description of this registry.

virtual void	SetDescription (const QString &description)=0
	set human readable description of this registry.

virtual const QString &	GetKeywords () const =0
	Get keywords for this registry used for search.

virtual void	SetKeywords (const QString &keywords)=0
	Set keywords for this registry used for search.

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.

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

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.

Thread-Safety Notes:: The CRegistry implementation uses internal locking (QMutex/QRecursiveMutex) to protect internal data structures. However, callers must be aware of the following:

GetExportedInterfacesMap() and GetExportedElementsMap() return const references to internal maps. While the reference is returned under lock protection, the lock is released when the function returns. Callers should make a copy if they need to iterate or store the map to avoid race conditions:
// Thread-safe pattern - make a copy

auto mapCopy = registry.GetExportedInterfacesMap();

for (auto iter = mapCopy.begin(); iter != mapCopy.end(); ++iter) { ... }
InsertElementInfo() returns a pointer to an element in the internal map. This pointer is only safe to use if the caller ensures no concurrent modifications occur. When called from within other registry methods (like Serialize), the pointer is safe because the calling method holds the lock.

Definition at line 47 of file IRegistry.h.

Member Typedef Documentation

◆ ElementPtr

typedef istd::TDelPtr<IRegistryElement> icomp::IRegistry::ElementPtr

Definition at line 51 of file IRegistry.h.

◆ ExportedElementsMap

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

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

Definition at line 82 of file IRegistry.h.

◆ ExportedInterfacesMap

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

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

Definition at line 77 of file IRegistry.h.

◆ Ids

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

Definition at line 50 of file IRegistry.h.

Member Enumeration Documentation

◆ ChangeFlags

enum icomp::IRegistry::ChangeFlags

Change flags.

Enumerator
CF_ELEMENT_ADDED
CF_ELEMENT_REMOVED
CF_ELEMENT_EXPORTED
CF_ELEMENT_RENAMED
CF_EMBEDDED

Definition at line 56 of file IRegistry.h.

Member Function Documentation

◆ GetDescription()

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

pure virtual

Get human readable description of this registry.

Implemented in icomp::CRegistry.

◆ GetElementIds()

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

pure virtual

Get ID list of existing elements.

Implemented in icomp::CRegistry.

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

◆ GetElementInfo()

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

pure virtual

Get access to stored attribute info structure.

Implemented in icomp::CRegistry.

◆ GetEmbeddedRegistry()

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.

◆ GetEmbeddedRegistryIds()

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.

◆ GetExportedElementsMap()

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.

◆ GetExportedInterfacesMap()

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

pure virtual

Get access to information structure of exported interfaces.

Implemented in icomp::CRegistry.

◆ GetKeywords()

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

pure virtual

Get keywords for this registry used for search.

Implemented in icomp::CRegistry.

◆ InsertElementInfo()

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

elementId	unique ID of new element (component).
address	address describing element type.
ensureElementCreated	if true new element will be created.

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

◆ InsertEmbeddedRegistry()

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.

◆ RemoveElementInfo()

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

pure virtual

Removes attribute info structure from this collection.

Implemented in icomp::CRegistry.

◆ RemoveEmbeddedRegistry()

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.

◆ RenameElement()

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

pure virtual

Rename an registry element.

Parameters

oldElementId	ID of element to be renamed.
newElementId	the new ID of element.

Implemented in icomp::CRegistry.

◆ RenameEmbeddedRegistry()

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

pure virtual

Rename a embedded registry.

Parameters

oldElementId	ID of element to be renamed.
newElementId	the new ID of element.

Implemented in icomp::CRegistry.

◆ SetDescription()

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

pure virtual

set human readable description of this registry.

Implemented in icomp::CRegistry.

◆ SetElementExported()

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

pure virtual

Set element to be exported.

Parameters

exportId	ID of exported name, or NULL if this export should be removed.
elementId	ID of element or its subelement (separated with slash) or empty string, if this export should be removed.

Implemented in icomp::CRegistry.

◆ SetElementInterfaceExported()

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

elementId	ID of element in registry.
exportInterfaceInfo	specify interface. If must be invalid.
state	the export state. If `false`, the existing export will be removed.

Implemented in icomp::CRegistry.

◆ SetKeywords()

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:

Acf/Include/icomp/IRegistry.h

Classes

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ElementPtr

◆ ExportedElementsMap

◆ ExportedInterfacesMap

◆ Ids

Member Enumeration Documentation

◆ ChangeFlags

Member Function Documentation

◆ GetDescription()

◆ GetElementIds()

◆ GetElementInfo()

◆ GetEmbeddedRegistry()

◆ GetEmbeddedRegistryIds()

◆ GetExportedElementsMap()

◆ GetExportedInterfacesMap()

◆ GetKeywords()

◆ InsertElementInfo()

◆ InsertEmbeddedRegistry()

◆ RemoveElementInfo()

◆ RemoveEmbeddedRegistry()

◆ RenameElement()

◆ RenameEmbeddedRegistry()

◆ SetDescription()

◆ SetElementExported()

◆ SetElementInterfaceExported()

◆ SetKeywords()