AbstractParameterInterface.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
// File: AbstractParametersInterface.h
//-----------------------------------------------------------------------------
// Project: Kactus2
// Author: Mikko Teuho
// Date: 22.09.2020
//
// Description:
// Abstraction for parameter interfaces.
//-----------------------------------------------------------------------------
 
#ifndef ABSTRACTPARAMETERSINTERFACE_H
#define ABSTRACTPARAMETERSINTERFACE_H
 
#include <KactusAPI/KactusAPIGlobal.h>
 
#include "ParameterizableInterface.h"
#include "NameGroupInterface.h"
 
class Choice;
class Component;
class Parameter;
class ParameterValidator;
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
class KACTUS2_API AbstractParameterInterface: public ParameterizableInterface, public NameGroupInterface
{
public:

    AbstractParameterInterface(QSharedPointer<ParameterValidator> validator,
        QSharedPointer<ExpressionParser> expressionParser,
        QSharedPointer<ExpressionFormatter> expressionFormatter);
    
    virtual ~AbstractParameterInterface() = default;

    void setChoices(QSharedPointer<QList<QSharedPointer<Choice> > > newChoices);
    
    virtual bool setName(std::string const& currentName, std::string const& newName) override final;

    virtual int getAllReferencesToIdInItem(const std::string& itemName, std::string const&  valueID) const override final;
    
    std::vector<std::string> getExpressionsInSelectedItems(std::vector<std::string> parameterNames) const;

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

    bool setDisplayName(std::string const& parameterName, std::string const& newDisplayName);

    std::string getType(std::string const& parameterName) const;

    bool setType(std::string const& parameterName, std::string const& newType);

    std::string getSign(std::string const& parameterName) const;

    bool setSign(std::string const& parameterName, std::string const& newSign);

    std::string getBitWidthLeftValue(std::string const& parameterName, int const& baseNumber = 0) const;

    std::string getBitWidthLeftFormattedExpression(std::string const& parameterName) const;

    std::string getBitWidthLeftExpression(std::string const& parameterName) const;

    bool setBitWidthLeft(std::string const& parameterName, std::string const& newBitWidthLeft);

    std::string getBitWidthRightValue(std::string const& parameterName, int const& baseNumber = 0) const;

    std::string getBitWidthRightFormattedExpression(std::string const& parameterName) const;

    std::string getBitWidthRightExpression(std::string const& parameterName) const;

    bool setBitWidthRight(std::string const& parameterName, std::string const& newBitWidthRight);

    std::string getMinimum(std::string const& parameterName) const;

    bool setMinimum(std::string const& parameterName, std::string const& newMinimum);

    std::string getMaximum(std::string const& parameterName) const;

    bool setMaximum(std::string const& parameterName, std::string const& newMaximum);

    std::string getChoice(std::string const& parameterName) const;

    bool setChoice(std::string const& parameterName, std::string const& newChoice);

    std::string getValue(std::string const& parameterName, int const& baseNumber = 0) const;

    std::string getValueFormattedExpression(std::string const& parameterName) const;

    std::string getValueExpression(std::string const& parameterName) const;

    bool setValue(std::string const& parameterName, std::string const& newValue);

    std::string getResolve(std::string const& parameterName) const;

    bool setResolve(std::string const& parameterName, std::string const& newResolve);

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

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

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

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

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

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

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

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

    std::string getID(std::string const& parameterName) const;

    bool setID(std::string const& parameterName, std::string const& newID);

    int getUsageCount(std::string const& parameterName) const;

    bool setUsageCount(std::string const& parameterName, int const& newUsageCount);

    bool increaseUsageCount(std::string const& parameterName);

    bool reduceUsageCount(std::string const& parameterName);

    bool hasValidType(std::string const& parameterName) const;

    bool hasValidBitWidth(std::string const& parameterName) const;

    bool hasValidMinimum(std::string const& parameterName) const;

    bool hasValidMaximum(std::string const& parameterName) const;

    bool hasValidChoice(std::string const& parameterName) const;

    bool hasValidValue(std::string const& parameterName) const;

    bool hasValidResolve(std::string const& parameterName) const;

    bool hasValidArrayValues(std::string const& parameterName) const;

    AbstractParameterInterface(const AbstractParameterInterface& other) = delete;
    AbstractParameterInterface& operator=(const AbstractParameterInterface& other) = delete;
 
private:
    
    virtual QSharedPointer<Parameter> getParameter(std::string const& parameterName) const = 0;

    QString evaluateValue(QSharedPointer<Parameter> parameter) const;

    QSharedPointer<Choice> findChoice(QString const& choiceName) const;

    QString matchArrayValuesToSelectedChoice(QSharedPointer<Choice> choice, QString const& arrayValue) const;

    QString findDisplayValueForEnumeration(QSharedPointer<Choice> choice, QString const& enumerationValue) const;
 
    //-----------------------------------------------------------------------------
    // Data.
    //-----------------------------------------------------------------------------

    QSharedPointer<QList<QSharedPointer<Choice> > > choices_ = nullptr;

    QSharedPointer<ParameterValidator> parameterValidator_ = nullptr;
};
 
#endif // ABSTRACTPARAMETERSINTERFACE_H