IRegistry.h

Go to the documentation of this file.

/********************************************************************************
**  This file is part of the ICF Framework. Copyright (C) Witold Gantzke & Kirill Lepskiy
**  ICF Framework may be used under the terms of the LGPL License v. 2.1 by the Free Software Foundation.
********************************************************************************/
 
#pragma once
 
 
// Qt includes
#include <QtCore/QByteArray>
#include <QtCore/QSet>
#include <QtCore/QMap>
 
// ICF includes
#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 std::unique_ptr<IRegistryElement> ElementPtr;
 
    enum ChangeFlags
    {
        CF_ELEMENT_ADDED = 0xf72390,
        CF_ELEMENT_REMOVED,
        CF_ELEMENT_EXPORTED,
        CF_ELEMENT_RENAMED,
        CF_EMBEDDED
    };
 
    struct ElementInfo
    {
        ElementPtr elementPtr;              
        CComponentAddress address;          
    };
 
    typedef std::map<QByteArray, QByteArray> ExportedInterfacesMap;
 
    typedef std::map<QByteArray, QByteArray> ExportedElementsMap;
 
    virtual Ids GetElementIds() const = 0;
 
    virtual const ElementInfo* GetElementInfo(const QByteArray& elementId) const = 0;
 
    virtual ElementInfo* InsertElementInfo(
            const QByteArray& elementId,
            const 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