#include <CVisualRegistry.h>

Inheritance diagram for icmpstr::CVisualRegistry:

Collaboration diagram for icmpstr::CVisualRegistry:

Public Types
enum	MessageId { MI_CANNOT_CREATE_ELEMENT = 650 }

typedef icomp::CRegistry	BaseClass

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 std::unique_ptr< IRegistryElement >	ElementPtr

typedef std::map< QByteArray, QByteArray >	ExportedInterfacesMap
	Map assigning interface ID (undecorated) to component ID exporting this interface.

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

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 Types inherited from icmpstr::IComponentNoteController
enum	ChangeFlags { CF_NOTE_CHANGED = 0xb6f0c34 }
	Data model change notification flags. More...

Public Member Functions
	CVisualRegistry ()

virtual bool	SerializeComponentsLayout (iser::IArchive &archive)

virtual bool	SerializeRegistry (iser::IArchive &archive)

virtual bool	SerializeUserData (iser::IArchive &archive)

virtual QString	GetComponentNote (const QByteArray &componentName)
	Get the note text to the component with the given name `componentName`.

virtual void	SetComponentNote (const QByteArray &componentName, const QString &componentNote)
	Add a note `componentNote` to the component with the given name `componentName`.

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

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

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

Public Member Functions inherited from icomp::CRegistry
Ids	GetElementIds () const override
	Get ID list of existing elements.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Public Member Functions inherited from icomp::IRegistry
Public Member Functions inherited from iser::ISerializable
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 std::unique_ptr< 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 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 icmpstr::IComponentNoteController

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

typedef std::unique_ptr< QIcon >	IconPtr

typedef QMap< icomp::CComponentAddress, IconPtr >	IconMap

Protected Types inherited from icomp::CRegistry
typedef imod::TModelWrap< istd::TChangeDelegator< CRegistryElement > >	Element

typedef std::unique_ptr< IRegistry >	RegistryPtr

typedef std::map< QByteArray, RegistryPtr >	EmbeddedRegistriesMap

Protected Member Functions
bool	SerializeComponentInfo (iser::IArchive &archive, QByteArray &componentName, i2d::CVector2d &position, QString &note)

virtual std::unique_ptr< icomp::IRegistryElement >	CreateRegistryElement (const QByteArray &elementId, const icomp::CComponentAddress &address) const
	Called to create instance of registry element.

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

Protected Member Functions inherited from icomp::CRegistry
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.

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 Attributes inherited from icomp::CRegistry
EmbeddedRegistriesMap	m_embeddedRegistriesMap

Detailed Description

Definition at line 24 of file CVisualRegistry.h.

Member Typedef Documentation

◆ BaseClass

icomp::CRegistry icmpstr::CVisualRegistry::BaseClass

Definition at line 30 of file CVisualRegistry.h.

◆ Element

imod::TModelWrap<istd::TChangeDelegator<CVisualRegistryElement> > icmpstr::CVisualRegistry::Element

protected

Definition at line 58 of file CVisualRegistry.h.

◆ IconMap

QMap<icomp::CComponentAddress, IconPtr> icmpstr::CVisualRegistry::IconMap

protected

Definition at line 60 of file CVisualRegistry.h.

◆ IconPtr

std::unique_ptr<QIcon> icmpstr::CVisualRegistry::IconPtr

protected

Definition at line 59 of file CVisualRegistry.h.

Member Enumeration Documentation

◆ MessageId

enum icmpstr::CVisualRegistry::MessageId

Enumerator
MI_CANNOT_CREATE_ELEMENT

Definition at line 32 of file CVisualRegistry.h.

Constructor & Destructor Documentation

◆ CVisualRegistry()

icmpstr::CVisualRegistry::CVisualRegistry ( )

Member Function Documentation

◆ CreateRegistryElement()

virtual std::unique_ptr< icomp::IRegistryElement > icmpstr::CVisualRegistry::CreateRegistryElement	(	const QByteArray &	elementId,
		const icomp::CComponentAddress &	address ) const

protectedvirtual

Called to create instance of registry element.

Reimplemented from icomp::CRegistry.

◆ GetComponentNote()

virtual QString icmpstr::CVisualRegistry::GetComponentNote ( const QByteArray & componentName )

virtual

Get the note text to the component with the given name componentName.

Implements icmpstr::IComponentNoteController.

◆ InsertElementInfo()

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

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.

Reimplemented from icomp::CRegistry.

◆ InsertEmbeddedRegistry()

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

protectedvirtual

Insert embedded registry with specified ID.

Returns: instance of new created embedded registry.

Reimplemented from icomp::CRegistry.

◆ RenameElement()

virtual bool icmpstr::CVisualRegistry::RenameElement	(	const QByteArray &	oldElementId,
		const QByteArray &	newElementId )

virtual

Rename an registry element.

Parameters

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

Reimplemented from icomp::CRegistry.

◆ Serialize()

virtual bool icmpstr::CVisualRegistry::Serialize ( iser::IArchive & archive )

virtual

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

Type of operation is depending on archive type.

See also: iser::IArchive

Reimplemented from icomp::CRegistry.

◆ SerializeComponentInfo()

bool icmpstr::CVisualRegistry::SerializeComponentInfo	(	iser::IArchive &	archive,
		QByteArray &	componentName,
		i2d::CVector2d &	position,
		QString &	note )

protected

◆ SerializeComponentsLayout()

virtual bool icmpstr::CVisualRegistry::SerializeComponentsLayout ( iser::IArchive & archive )

virtual

◆ SerializeRegistry()

virtual bool icmpstr::CVisualRegistry::SerializeRegistry ( iser::IArchive & archive )

virtual

◆ SerializeUserData()

virtual bool icmpstr::CVisualRegistry::SerializeUserData ( iser::IArchive & archive )

virtual

◆ SetComponentNote()

virtual void icmpstr::CVisualRegistry::SetComponentNote	(	const QByteArray &	componentName,
		const QString &	componentNote )

virtual

Add a note componentNote to the component with the given name componentName.

Implements icmpstr::IComponentNoteController.

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

icmpstr/CVisualRegistry.h

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BaseClass

◆ Element

◆ IconMap

◆ IconPtr

Member Enumeration Documentation

◆ MessageId

Constructor & Destructor Documentation

◆ CVisualRegistry()

Member Function Documentation

◆ CreateRegistryElement()

◆ GetComponentNote()

◆ InsertElementInfo()

◆ InsertEmbeddedRegistry()

◆ RenameElement()

◆ Serialize()

◆ SerializeComponentInfo()

◆ SerializeComponentsLayout()

◆ SerializeRegistry()

◆ SerializeUserData()

◆ SetComponentNote()