ComponentInstanceInterface.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
// File: ComponentInstanceInterface.h
//-----------------------------------------------------------------------------
// Project: Kactus2
// Author: Mikko Teuho
// Date: 09.09.2021
//
// Description:
// Interface for accessing component instances.
//-----------------------------------------------------------------------------
 
#ifndef COMPONENTINSTANCEINTERFACE_H
#define COMPONENTINSTANCEINTERFACE_H
 
#include <NameGroupInterface.h>
 
#include <QSharedPointer>
 
class Design;
class ComponentInstance;
class ConfigurableVLNVReference;
 
class InterconnectionInterface;
class AdHocConnectionInterface;
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
class KACTUS2_API ComponentInstanceInterface : public NameGroupInterface
{
public:

    ComponentInstanceInterface(InterconnectionInterface* connectionInterface,
        AdHocConnectionInterface* adHocInterface);

    virtual ~ComponentInstanceInterface() = default;

    void setComponentInstances(QSharedPointer<Design> newDesign);

    virtual int getItemIndex(std::string const& itemName) const override final;

    std::string getIndexedItemName(int itemIndex) const final;

    virtual int itemCount() const override final;

    virtual std::vector<std::string> getItemNames() const override final;

    virtual bool setName(std::string const& currentName, std::string const& newName) override final;

    virtual std::string getDescription(std::string const& itemName) const override final;

    virtual bool setDescription(std::string const& itemName, std::string const& newDescription) override final;

    virtual bool validateItems() const override final;

    virtual bool itemHasValidName(std::string const& itemName) const override final;

    QSharedPointer<ConfigurableVLNVReference> getComponentReference(std::string const& instanceName) const;

    bool setComponentReference(std::string const& instanceName, std::string const& newVendor,
        std::string const& newLibrary, std::string const& newName, std::string const& newVersion);

    void addComponentInstance(std::string const& instanceName = "");

    bool removeComponentInstance(std::string const& instanceName);

    bool instanceExists(std::string const& instanceName) const;

    ComponentInstanceInterface(const ComponentInstanceInterface& other) = delete;
    ComponentInstanceInterface& operator=(const ComponentInstanceInterface& other) = delete;
 
private:

    QSharedPointer<ComponentInstance> getComponentInstance(std::string const& instanceName) const;

    QSharedPointer<NameGroup> getItem(std::string const& instanceName) const;
 
    //-----------------------------------------------------------------------------
    // Data.
    //-----------------------------------------------------------------------------

    QSharedPointer<QList<QSharedPointer<ComponentInstance> > > componentInstances_;

    InterconnectionInterface* connectionInterface_;

    AdHocConnectionInterface* adHocConnectionInterface_;
};
 
#endif // COMPONENTINSTANCEINTERFACE_H