IRegistry.h

Go to the documentation of this file.

// SPDX-License-Identifier: LGPL-2.1-or-later OR GPL-2.0-or-later OR GPL-3.0-or-later OR LicenseRef-ACF-Commercial
#pragma once
 
 
// Qt includes
#include <QtCore/QByteArray>
#include <QtCore/QSet>
#include <QtCore/QMap>
 
// ACF includes
#include <istd/TDelPtr.h>
#include <iser/ISerializable.h>
#include <icomp/IRegistryElement.h>
#include <icomp/CComponentAddress.h>
 
 
namespace icomp
{
 
 
class IRegistry: virtual public iser::ISerializable
{
public:
       typedef QSet<QByteArray> Ids;
       typedef istd::TDelPtr<IRegistryElement> ElementPtr;
 
       enum ChangeFlags
       {
              CF_ELEMENT_ADDED = 0xf72390,
              CF_ELEMENT_REMOVED,
              CF_ELEMENT_EXPORTED,
              CF_ELEMENT_RENAMED,
              CF_EMBEDDED
       };
 
       struct ElementInfo
       {
              ElementPtr elementPtr;                           
              icomp::CComponentAddress address;  
       };
 
       typedef QMap<QByteArray, QByteArray> ExportedInterfacesMap;
 
       typedef QMap<QByteArray, QByteArray> ExportedElementsMap;
 
       virtual Ids GetElementIds() const = 0;
 
       virtual const ElementInfo* GetElementInfo(const QByteArray& elementId) const = 0;
 
       virtual ElementInfo* InsertElementInfo(
                            const QByteArray& elementId,
                            const icomp::CComponentAddress& address,
                            bool ensureElementCreated = true) = 0;
 
       virtual bool RemoveElementInfo(const QByteArray& elementId) = 0;
 
       virtual bool RenameElement(const QByteArray& oldElementId, const QByteArray& newElementId) = 0;
 
       virtual Ids GetEmbeddedRegistryIds() const = 0;
 
       virtual IRegistry* GetEmbeddedRegistry(const QByteArray& registryId) const = 0;
 
       virtual IRegistry* InsertEmbeddedRegistry(const QByteArray& registryId) = 0;
 
       virtual bool RemoveEmbeddedRegistry(const QByteArray& registryId) = 0;
 
       virtual bool RenameEmbeddedRegistry(const QByteArray& oldRegistryId, const QByteArray& newRegistryId) = 0;
 
       virtual const ExportedInterfacesMap& GetExportedInterfacesMap() const = 0;
 
       virtual const ExportedElementsMap& GetExportedElementsMap() const = 0;
 
       virtual void SetElementInterfaceExported(
                            const QByteArray& elementId,
                            const QByteArray& interfaceName,
                            bool state = true) = 0;
 
       virtual void SetElementExported(
                            const QByteArray& exportId,
                            const QByteArray& elementId) = 0;
 
       virtual const QString& GetDescription() const = 0;
 
       virtual void SetDescription(const QString& description) = 0;
 
       virtual const QString& GetKeywords() const = 0;
 
       virtual void SetKeywords(const QString& keywords) = 0;
};
 
 
} //namespace icomp