BusInterfaceInterface.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
// File: BusInterfaceInterface.h
//-----------------------------------------------------------------------------
// Project: Kactus2
// Author: Mikko Teuho
// Date: 17.02.2021
//
// Description:
// Interface for accessing bus interfaces.
//-----------------------------------------------------------------------------
 
#ifndef BUSINTERFACEINTERFACE_H
#define BUSINTERFACEINTERFACE_H
 
#include <NameGroupInterface.h>
#include <ParameterizableInterface.h>
 
#include <IPXACTmodels/generaldeclarations.h>
#include <IPXACTmodels/common/ConfigurableVLNVReference.h>
#include <IPXACTmodels/common/Document.h>
#include <IPXACTmodels/Component/BusInterface.h>
 
#include <QSharedPointer>
 
class Component;
class InitiatorInterface;
class TargetInterface;
class MirroredTargetInterface;
class TransparentBridge;
class BusInterfaceValidator;
class TransparentBridgeInterface;
class FileSetInterface;
class MemoryMapInterface;
class AbstractionTypeInterface;
class ParametersInterface;
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
class KACTUS2_API BusInterfaceInterface : public ParameterizableInterface, public NameGroupInterface
{
public:

    BusInterfaceInterface(QSharedPointer<BusInterfaceValidator> busValidator,
        QSharedPointer<ExpressionParser> expressionParser,
        QSharedPointer<ExpressionFormatter> expressionFormatter);

    virtual ~BusInterfaceInterface() = default;

    void setFileSetInterface(FileSetInterface* newFileSetInterface);
    
    void setMemoryMapInterface(MemoryMapInterface* newMapInterface);
    
    void setAbstractionTypeInterface(AbstractionTypeInterface* newAbstractionTypeInterface);
    
    void setTransparentBridgeInterface(TransparentBridgeInterface* newBridgeInterface);
    
    void setParameterInterface(ParametersInterface* newParameterInterface);

    void setBusInterfaces(QSharedPointer<Component> newComponent);

    void setupSubInterfaces(std::string const& busName);

    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 bool validateItems() const override final;

    bool validateBusInterface(std::string const& busName) const;

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

    bool hasValidBusType(std::string const& busName) const;

    bool hasValidAbstractionTypes(std::string const& busName) const;

    General::InterfaceMode getMode(std::string const& busName) const;

    General::InterfaceMode getActiveMode(std::string const& busName) const;
 

    std::string getModeString(std::string const& busName) const;

    bool setMode(std::string const& busName, std::string const& newMode);

    std::string getSystemGroup(std::string const& busName) const;

    QString getActiveSystemGroup(std::string const& busName) const;

    bool setSystemGroup(std::string const& busName, std::string const& newSystem);

    std::string connectionIsRequired(std::string const& busName) const;

    bool setConnectionIsRequired(std::string const& busName, bool newValue);

    std::string getBitsInLau(std::string const& busName) const;

    bool setBitsInLau(std::string const& busName, std::string const& newBits);

    BusInterface::Endianness getEndianness(std::string const& busName) const;

    bool setEndianness(std::string const& busName, std::string const& newEndianness);

    std::string getBitSteering(std::string const& busName) const;

    bool setBitSteering(std::string const& busName, std::string const& newBitSteering);

    std::string getAddressSpaceReference(std::string const& busName) const;
    
    bool setAddressSpaceReference(std::string const& busName, std::string const& newSpace);

    std::string getBaseAddressValue(std::string const& busName, int const& baseNumber = 0) const;

    std::string getBaseAddressFormattedExpression(std::string const& busName) const;

    std::string getBaseAddressExpression(std::string const& busName) const;

    bool setBaseAddress(std::string const& busName, std::string const& newBaseAddress);

    std::string getMemoryMapReference(std::string const& busName) const;

    bool setMemoryMapReference(std::string const& busName, std::string const& newMapReference);

    std::vector<std::string> getFileSetReferences(std::string const& busName) const;

    bool setFileSetReferences(std::string const& busName, std::vector<std::string>  const& newFileSetReferences);

    ConfigurableVLNVReference getBusType(std::string const& busName) const;

    std::string getBusTypeString(std::string const& busName) const;

    bool setBustype(std::string const& busName, ConfigurableVLNVReference const& newVLNV);

    bool setBustype(std::string const& busName, std::string const& newVendor, std::string const& newLibrary,
        std::string const& newName, std::string const& newVersion) const;

    std::string getAbstractionReferenceString(std::string const& busName) const;

    std::vector<std::string> getAbstractionReferences(std::string const& busName) const;

    bool addAbstractionType(std::string const& busName, std::string const& newVendor,
        std::string const& newLibrary, std::string const& newName, std::string const& newVersion) const;

    bool removeAbstractionTypes(std::string const& busName);

    std::string getRangeValue(std::string const& busName, int const& baseNumber = 0) const;

    std::string getRangeFormattedExpression(std::string const& busName) const;

    std::string getRangeExpression(std::string const& busName) const;

    bool setRange(std::string const& busName, std::string const& newRange);

    std::string getRemapAddressValue(std::string const& busName, int const& baseNumber = 0) const;

    std::string getRemapAddressFormattedExpression(std::string const& busName) const;

    std::string getRemapAddressExpression(std::string const& busName) const;

    bool setRemapAddress(std::string const& busName, std::string const& newRemapAddress);

    General::InterfaceMode getMonitorMode(std::string const& busName) const;

    bool setMonitorMode(std::string const& busName, std::string const& newMode);

    std::string getMonitorGroup(std::string const& busName) const;

    bool setMonitorGroup(std::string const& busName, std::string const& newGroup);

    void addBusInterface(int const& newBusIndex, std::string const& busName = "");
    
    void addBusInterface(std::string const& busName = "");

    void swapBusInterfaces(int const& firstIndex, int const& secondIndex);

    bool removeBusInterface(std::string const& busName);

    bool busInterfaceExists(std::string const& busName) const;

    TransparentBridgeInterface* getBridgeInterface();

    FileSetInterface* getFileSetInterface() const;

    MemoryMapInterface* getMemoryMapInterface() const;

    AbstractionTypeInterface* getAbstractionTypeInterface() const;

    QSharedPointer<BusInterfaceValidator> getValidator() const;

    QSharedPointer<QList<QSharedPointer<TransparentBridge> > > getBridges(std::string const& busName) const;

    QSharedPointer<QList<QSharedPointer<TransparentBridge> > > createBridges(std::string const& busName);

    virtual int getAllReferencesToIdInItem(const std::string& itemName, std::string const&  valueID) const
        override;

    std::vector<std::string> getAllExpressions(std::string const& busName) const;

    void copyRows(std::vector<int> selectedRows);

    std::vector<std::string> pasteRows();

    int getPasteRowCount() const;

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

    QSharedPointer<BusInterface> getBusInterface(std::string const& busName) const;

    QSharedPointer<NameGroup> getItem(std::string const& busName) const override;

    QSharedPointer<InitiatorInterface> getInitiatorInterface(std::string const& busName) const;

    QSharedPointer<InitiatorInterface> createInitiatorForBusInterface(std::string const& busName);

    QSharedPointer<TargetInterface> getTargetInterface(std::string const& busName) const;

    QSharedPointer<TargetInterface> createTargetForBusInterface(std::string const& busName);

    QSharedPointer<MirroredTargetInterface> getMirroredSlaveInterface(std::string const& busName) const;

    QSharedPointer<MirroredTargetInterface> createMirrorSlaveForBusInterface(std::string const& busName);

    QSharedPointer<BusInterface::MonitorInterface> getMonitorInterface(std::string const& busName) const;

    QSharedPointer<BusInterface::MonitorInterface> createMonitorForBusInterface(std::string const& busName);
 
    //-----------------------------------------------------------------------------
    // Data.
    //-----------------------------------------------------------------------------

    QSharedPointer<QList<QSharedPointer<BusInterface> > > busInterfaces_;

    QSharedPointer<BusInterfaceValidator> busValidator_;

    TransparentBridgeInterface* bridgeInterface_;

    FileSetInterface* fileSetInterface_;

    MemoryMapInterface* mapInterface_;

    AbstractionTypeInterface* abstractionTypeInterface_;

    ParametersInterface* parameterInterface_;

    Document::Revision docRevision_ = Document::Revision::Unknown;
};
 
#endif // BUSINTERFACEINTERFACE_H