Standard implementation of registry. More...

#include <CRegistry.h>

Inheritance diagram for icomp::CRegistry:

Public Member Functions
	CRegistry ()

virtual Ids	GetElementIds () const override
	Get ID list of existing elements.

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

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

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

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

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

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

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

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

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

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

virtual const ExportedElementsMap &	GetExportedElementsMap () const override
	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) override
	Enable or disable exporting single or all interfaces of element.

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

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

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

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

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

virtual bool	Serialize (iser::IArchive &archive) override
	Load or store state of this object as a archive stream.

virtual quint32	GetMinimalVersion (int versionId) const override
	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 ()

Protected Types
typedef imod::TModelWrap< istd::TChangeDelegator< CRegistryElement > >	Element

typedef istd::TDelPtr< IRegistry >	RegistryPtr

typedef QMap< QByteArray, RegistryPtr >	EmbeddedRegistriesMap

Protected Member Functions
virtual icomp::IRegistryElement *	CreateRegistryElement (const QByteArray &elementId, const icomp::CComponentAddress &address) const
	Called to create instance of registry element.

virtual bool	SerializeComponents (iser::IArchive &archive)

virtual bool	SerializeEmbeddedRegistries (iser::IArchive &archive)

virtual bool	SerializeExportedInterfaces (iser::IArchive &archive)

virtual bool	SerializeExportedComponents (iser::IArchive &archive)

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.

Protected Attributes
EmbeddedRegistriesMap	m_embeddedRegistriesMap

Additional Inherited Members
Public Types inherited from icomp::IRegistry
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

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.

Detailed Description

Standard implementation of registry.

Thread-Safety Notes:: This class 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 41 of file CRegistry.h.

Member Typedef Documentation

◆ Element

typedef imod::TModelWrap<istd::TChangeDelegator<CRegistryElement> > icomp::CRegistry::Element

protected

Definition at line 79 of file CRegistry.h.

◆ EmbeddedRegistriesMap

typedef QMap<QByteArray, RegistryPtr> icomp::CRegistry::EmbeddedRegistriesMap

protected

Definition at line 93 of file CRegistry.h.

◆ RegistryPtr

typedef istd::TDelPtr<IRegistry> icomp::CRegistry::RegistryPtr

protected

Definition at line 92 of file CRegistry.h.

Constructor & Destructor Documentation

◆ CRegistry()

icomp::CRegistry::CRegistry ( )

Member Function Documentation

◆ CreateRegistryElement()

virtual icomp::IRegistryElement * icomp::CRegistry::CreateRegistryElement	(	const QByteArray &	elementId,
		const icomp::CComponentAddress &	address
	)		const

protectedvirtual

Called to create instance of registry element.

◆ GetDescription()

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

overridevirtual

Get human readable description of this registry.

Implements icomp::IRegistry.

◆ GetElementIds()

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

overridevirtual

Get ID list of existing elements.

Implements icomp::IRegistry.

◆ GetElementInfo()

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

overridevirtual

Get access to stored attribute info structure.

Implements icomp::IRegistry.

◆ GetEmbeddedRegistry()

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

overridevirtual

Get access to embedded registry using its ID.

Embedded registries are used to manage local composite components.

Implements icomp::IRegistry.

◆ GetEmbeddedRegistryIds()

virtual Ids icomp::CRegistry::GetEmbeddedRegistryIds ( ) const

overridevirtual

Get list of IDs of embedded registries.

Embedded registries are used to manage local composite components.

Returns: set of IDs.

Implements icomp::IRegistry.

◆ GetExportedElementsMap()

virtual const ExportedElementsMap & icomp::CRegistry::GetExportedElementsMap ( ) const

overridevirtual

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

Implements icomp::IRegistry.

◆ GetExportedInterfacesMap()

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

overridevirtual

Get access to information structure of exported interfaces.

Implements icomp::IRegistry.

◆ GetKeywords()

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

overridevirtual

Get keywords for this registry used for search.

Implements icomp::IRegistry.

◆ GetMinimalVersion()

virtual quint32 icomp::CRegistry::GetMinimalVersion ( int versionId ) const

overridevirtual

Get minimal needed version to correct storing of this data.

In implementation shold be calculated maximum version of this and composed component.

Reimplemented from iser::ISerializable.

◆ InsertElementInfo()

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

overridevirtual

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.

Implements icomp::IRegistry.

Reimplemented in ipackage::CPackagesLoaderComp::LogingRegistry.

◆ InsertEmbeddedRegistry()

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

overridevirtual

Insert embedded registry with specified ID.

Returns: instance of new created embedded registry.

Implements icomp::IRegistry.

◆ RemoveElementInfo()

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

overridevirtual

Removes attribute info structure from this collection.

Implements icomp::IRegistry.

◆ RemoveEmbeddedRegistry()

virtual bool icomp::CRegistry::RemoveEmbeddedRegistry ( const QByteArray & registryId )

overridevirtual

Remove embedded registry with specified ID.

Returns: true, if registry could be removed.

Implements icomp::IRegistry.

◆ RenameElement()

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

overridevirtual

Rename an registry element.

Parameters

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

Implements icomp::IRegistry.

◆ RenameEmbeddedRegistry()

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

overridevirtual

Rename a embedded registry.

Parameters

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

Implements icomp::IRegistry.

◆ Serialize()

virtual bool icomp::CRegistry::Serialize ( iser::IArchive & archive )

overridevirtual

Load or store state of this object as a archive stream.

Type of operation is depending on archive type.

See also: iser::IArchive

Implements iser::ISerializable.

◆ SerializeComponents()

virtual bool icomp::CRegistry::SerializeComponents ( iser::IArchive & archive )

protectedvirtual

◆ SerializeEmbeddedRegistries()

virtual bool icomp::CRegistry::SerializeEmbeddedRegistries ( iser::IArchive & archive )

protectedvirtual

◆ SerializeExportedComponents()

virtual bool icomp::CRegistry::SerializeExportedComponents ( iser::IArchive & archive )

protectedvirtual

◆ SerializeExportedInterfaces()

virtual bool icomp::CRegistry::SerializeExportedInterfaces ( iser::IArchive & archive )

protectedvirtual

◆ SetDescription()

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

overridevirtual

set human readable description of this registry.

Implements icomp::IRegistry.

◆ SetElementExported()

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

overridevirtual

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.

Implements icomp::IRegistry.

◆ SetElementInterfaceExported()

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

overridevirtual

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.

Implements icomp::IRegistry.

◆ SetKeywords()

virtual void icomp::CRegistry::SetKeywords ( const QString & keywords )

overridevirtual

Set keywords for this registry used for search.

Implements icomp::IRegistry.

Member Data Documentation

◆ m_embeddedRegistriesMap

EmbeddedRegistriesMap icomp::CRegistry::m_embeddedRegistriesMap

protected

Definition at line 94 of file CRegistry.h.

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

Acf/Include/icomp/CRegistry.h

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Element

◆ EmbeddedRegistriesMap

◆ RegistryPtr

Constructor & Destructor Documentation

◆ CRegistry()

Member Function Documentation

◆ CreateRegistryElement()

◆ GetDescription()

◆ GetElementIds()

◆ GetElementInfo()

◆ GetEmbeddedRegistry()

◆ GetEmbeddedRegistryIds()

◆ GetExportedElementsMap()

◆ GetExportedInterfacesMap()

◆ GetKeywords()

◆ GetMinimalVersion()

◆ InsertElementInfo()

◆ InsertEmbeddedRegistry()

◆ RemoveElementInfo()

◆ RemoveEmbeddedRegistry()

◆ RenameElement()

◆ RenameEmbeddedRegistry()

◆ Serialize()

◆ SerializeComponents()

◆ SerializeEmbeddedRegistries()

◆ SerializeExportedComponents()

◆ SerializeExportedInterfaces()

◆ SetDescription()

◆ SetElementExported()

◆ SetElementInterfaceExported()

◆ SetKeywords()

Member Data Documentation

◆ m_embeddedRegistriesMap