PortsInterface.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
// File: PortsInterface.h
//-----------------------------------------------------------------------------
// Project: Kactus2
// Author: Mikko Teuho
// Date: 25.02.2020
//
// Description:
// Interface for editing component ports.
//-----------------------------------------------------------------------------
 
#ifndef PORTSINTERFACE_H
#define PORTSINTERFACE_H
 
#include <KactusAPI/KactusAPIGlobal.h>
 
#include <ParameterizableInterface.h>
#include <MasterPortInterface.h>
 
#include <IPXACTmodels/common/DirectionTypes.h>
#include <IPXACTmodels/Component/Port.h>
 
 
class PortValidator;
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
class KACTUS2_API PortsInterface : public ParameterizableInterface, public MasterPortInterface
{
public:

    PortsInterface(QSharedPointer<PortValidator> validator,
        QSharedPointer<ExpressionParser> expressionParser,
        QSharedPointer<ExpressionFormatter> expressionFormatter);

    virtual ~PortsInterface() = default;

    void setPorts(Port::List ports);

    bool hasPorts() const;

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

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

    int itemCount() const final;

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

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

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

    bool portExists(std::string const& portName) const;

    bool validateItems() const final;

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

    std::string getTypeName(std::string const& portName) const;

    std::vector<std::pair<std::string, std::vector<std::string> > > getTypeNameViews(std::string const& portName) const;

    std::vector<std::pair<std::string, std::vector<std::string> > > getTypeDefinitions(std::string const& portName) const;

    bool setTypeDefViewRefs(std::string const& portName, std::vector<std::pair<std::string, std::vector<std::string> > > const& typeNameViews);

    bool setTypeDefDefinitions(std::string const& portName, std::vector<std::pair<std::string, std::vector<std::string> > > const& typeDefinitions);

    bool clearTypeDefinitions(std::string const& portName);

    bool setTypeName(std::string const& portName, std::string const& newType) const;

    std::string getArrayLeftValue(std::string const& portName, unsigned int baseNumber = 0) const;

    std::string getArrayLeftFormattedExpression(std::string const& portName) const;

    std::string getArrayLeftExpression(std::string const& portName) const;

    bool setArrayLeft(std::string const& portName, std::string const& newArrayLeft) const;

    std::string getArrayRightValue(std::string const& portName, unsigned int baseNumber = 0) const;

    std::string getArrayRightFormattedExpression(std::string const& portName) const;

    std::string getArrayRightExpression(std::string const& portName) const;

    bool setArrayRight(std::string const& portName, std::string const& newArrayRight) const;

    std::string getTags(std::string const& portName) const;

    bool setTags(std::string const& portName, std::string const& tagList) const;

    bool isAdHoc(std::string const& portName) const;

    bool setAdHoc(std::string const& portName, bool newAdHocVisibility) const;

    std::string getDirection(std::string const& portName) const;

    DirectionTypes::Direction getDirectionType(std::string const& portName) const;

    bool setDirection(std::string const& portName, std::string const& newDirection) const;

    std::string getLeftBoundValue(std::string const& portName, unsigned int baseNumber = 0) const;

    std::string getLeftBoundFormattedExpression(std::string const& portName) const;

    std::string getLeftBoundExpression(std::string const& portName) const;

    bool setLeftBound(std::string const& portName, std::string const& newLeftBound) const;

    std::string getRightBoundValue(std::string const& portName, unsigned int baseNumber = 0) const;

    std::string getRightBoundFormattedExpression(std::string const& portName) const;

    std::string getRightBoundExpression(std::string const& portName) const;
    
    bool setRightBound(std::string const& portName, std::string const& newRightBound) const;

    bool hasExpressionInLeftOrRightBound(std::string const& portName) const;

    std::string getWidth(std::string const& portName) const;

    bool setWidth(std::string const& portName, std::string const& newWidth) const;

    std::string getDefaultValue(std::string const& portName, unsigned int baseNumber = 0) const;

    std::string getDefaultValueFormattedExpression(std::string const& portName) const;

    std::string getDefaultValueExpression(std::string const& portName) const;
    
    bool setDefaultValue(std::string const& portName, std::string const& newDefaultValue) const;

    std::string getBusWidthValue(std::string const& portName, unsigned int baseNumber = 0) const;

    std::string getBusWidthFormattedExpression(std::string const& portName) const;

    std::string getBusWidthExpression(std::string const& portName) const;

    bool setBusWidth(std::string const& portName, std::string const& newBusWidth) const;

    std::string getInitiative(std::string const& portName) const;

    bool setInitiative(std::string const& portName, std::string const& newInitiative) const;

    std::string getKind(std::string const& portName) const;

    bool setKind(std::string const& portName, std::string const& newKind) const;

    std::string getProtocolType(std::string const& portName) const;

    bool setProtocolType(std::string const& portName, std::string const& newProtocolType) const;

    std::string getMaxConnectionsValue(std::string const& portName, unsigned int baseNumber = 0) const;

    std::string getMaxConnectionsFormattedExpression(std::string const& portName) const;

    std::string getMaxConnectionsExpression(std::string const& portName) const;

    bool setMaxConnections(std::string const& portName, std::string const& newMaxConnections) const;

    std::string getMinConnectionsValue(std::string const& portName, unsigned int baseNumber = 0) const;

    std::string getMinConnectionsFormattedExpression(std::string const& portName) const;

    std::string getMinConnectionsExpression(std::string const& portName) const;

    bool setMinConnections(std::string const& portName, std::string const& newMinConnections) const;

    void addWirePort(std::string const& newPortName = std::string()) final;

    void addTransactionalPort(std::string const& newPortName = std::string()) final;

    bool removePort(std::string const& portName) const;

    bool portLeftArrayValueIsValid(std::string const& portName) const;

    bool portRightArrayValueIsValid(std::string const& portName) const;

    bool portHasValidTypes(std::string const& portName) const;

    bool portIsWire(std::string const& portName) const final;

    bool portIsWire(QSharedPointer<Port> port) const;

    bool portHasValidLeftBound(std::string const& portName) const;

    bool portHasValidRightBound(std::string const& portName) const;

    bool portHasValidDefaultValue(std::string const& portName) const;

    bool portIsTransactional(std::string const& portName) const final;

    bool portIsTransactional(QSharedPointer<Port> port) const;

    bool portHasValidBusWidth(std::string const& portName) const;

    bool portHasValidInitiative(std::string const& portName) const;

    bool portHasValidKind(std::string const& portName) const;

    bool portHasValidProtocol(std::string const& portName) const;

    bool portHasValidMaxConnections(std::string const& portName) const;

    bool portHasValidMinConnections(std::string const& portName) const;

    std::string getIconPathForPort(std::string const& portName) const;

    QSharedPointer<Port> getPort(std::string const& portName) const;
 
    QSharedPointer<NameGroup> getItem(std::string const& portName) const final;

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

    void setTypeNameAndDefinition(QSharedPointer<Port> port) const;
 
    //-----------------------------------------------------------------------------
    // Data.
    //-----------------------------------------------------------------------------

    Port::List ports_ = nullptr;

    QSharedPointer<PortValidator> portValidator_;
};
 
#endif // PORTSMODEL_H