InterconnectionInterface.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
// File: InterconnectionInterface.h
//-----------------------------------------------------------------------------
// Project: Kactus2
// Author: Mikko Teuho
// Date: 09.09.2021
//
// Description:
// Interface for accessing design interconnections.
//-----------------------------------------------------------------------------
 
#ifndef INTERCONNECTIONINTERFACE_H
#define INTERCONNECTIONINTERFACE_H
 
#include <NameGroupInterface.h>
 
#include <QSharedPointer>
 
class Design;
class Interconnection;
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
class KACTUS2_API InterconnectionInterface : public NameGroupInterface
{
public:

    InterconnectionInterface();

    virtual ~InterconnectionInterface() = default;

    void setInterconnections(QSharedPointer<Design> newDesign);

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

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

    std::string getConnectionName(std::string const& startInstanceName, std::string const& startBusName,
        std::string const& endInstanceName, std::string const& endBusName) const;

    std::string getHierarchicalConnectionName(std::string const& instanceName, std::string const& instanceBus,
        std::string const& topBus) const;

    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;

    void addInterconnection(std::string const& startComponentInstance, std::string const& startBus,
        std::string const& endComponentInstance, std::string const& endBus, std::string const& connectionName = "");

    void addHierarchicalInterconnection(std::string const& instanceName, std::string const& instanceBus,
        std::string const& topBus, std::string const& connectionName = "");

    bool removeInterconnection(std::string const& connectionName);

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

    bool interconnectionExists(std::string const& connectionName) const;

    void renameComponentReferences(std::string const& currentName, std::string const& newName);

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

    QSharedPointer<Interconnection> getInterconnection(std::string const& connectionName) const;

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

    QSharedPointer<QList<QSharedPointer<Interconnection> > > interconnections_;
};
 
#endif // INTERCONNECTIONINTERFACE_H