ModuleParameterInterface.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
// File: ModuleParameterInterface.h
//-----------------------------------------------------------------------------
// Project: Kactus2
// Author: Mikko Teuho
// Date: 22.09.2020
//
// Description:
// Interface for editing module parameters.
//-----------------------------------------------------------------------------
 
#ifndef MODULEPARAMETERINTERFACE_H
#define MODULEPARAMETERINTERFACE_H
 
#include <KactusAPI/KactusAPIGlobal.h>
 
#include <AbstractParameterInterface.h>
 
class ComponentInstantiationParameterFinder;
class ComponentInstantiation;
class ModuleParameter;
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
class KACTUS2_API ModuleParameterInterface : public AbstractParameterInterface
{
public:

    ModuleParameterInterface(QSharedPointer<ParameterValidator> validator,
        QSharedPointer<ExpressionParser> expressionParser,
        QSharedPointer<ExpressionFormatter> expressionFormatter,
        QSharedPointer<ComponentInstantiationParameterFinder> parameterFinder);

    virtual ~ModuleParameterInterface() = default;

    void setModuleParameters(QSharedPointer<ComponentInstantiation> instantiation);

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

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

    virtual int itemCount() const override;

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

    std::string getDataType(std::string const& parameterName) const;
    
    bool setDataType(std::string const& parameterName, std::string const& newDataType);

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

    bool setUsageType(std::string const& parameterName, std::string const& newUsageType);

    void addModuleParameter(int const& row, std::string const& newParameterName = std::string(""));

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

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

    virtual QSharedPointer<Parameter> getParameter(std::string const& parameterName) const override final;

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

    QSharedPointer<ModuleParameter> getModuleParameter(std::string const& parameterName) const;
    
    //-----------------------------------------------------------------------------
    // Data.
    //-----------------------------------------------------------------------------

    QSharedPointer<QList<QSharedPointer<ModuleParameter> > > moduleParameters_;

    QSharedPointer<ComponentInstantiationParameterFinder> parameterFinder_;
};
 
#endif // MODULEPARAMETERINTERFACE_H