ResetInterface.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
// File: ResetInterface.h
//-----------------------------------------------------------------------------
// Project: Kactus2
// Author: Mikko Teuho
// Date: 20.04.2020
//
// Description:
// Interface for editing resets.
//-----------------------------------------------------------------------------
 
#ifndef RESETINTERFACE_H
#define RESETINTERFACE_H
 
#include <KactusAPI/KactusAPIGlobal.h>
 
#include <ParameterizableInterface.h>
#include <CommonInterface.h>
 
class Field;
class FieldReset;
class FieldValidator;
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
class KACTUS2_API ResetInterface : public ParameterizableInterface, public CommonInterface
{
 
public:

    ResetInterface(QSharedPointer<FieldValidator> validator,
        QSharedPointer<ExpressionParser> expressionParser,
        QSharedPointer<ExpressionFormatter> expressionFormatter);

    virtual ~ResetInterface() = default;

    void setResets(QSharedPointer<Field> containingField);

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

    virtual int itemCount() const override final;
    
    std::string getResetTypeReference(int const& itemIndex) const;

    bool setResetTypeReference(int const& resetIndex, std::string const& newResetType);

    std::string getResetValue(int const& resetIndex, int const& baseNumber = 0) const;

    std::string getResetValueFormattedExpression(int const& resetIndex) const;

    std::string getResetValueExpression(int const& resetIndex) const;

    bool setResetValue(int const& resetIndex, std::string const& newResetValue);

    std::string getResetMaskValue(int const& resetIndex, int const& baseNumber = 0) const;

    std::string getResetMaskFormattedExpression(int const& resetIndex) const;

    std::string getResetMaskExpression(int const& resetIndex) const;

    bool setResetMask(int const& resetIndex, std::string const& newResetMask);

    virtual bool validateItems() const override final;

    bool hasValidResetType(int const& resetIndex) const;

    bool hasValidResetValue(int const& resetIndex) const;

    bool hasValidResetMask(int const& resetIndex) const;

    void addReset(int const& row);

    bool removeReset(int const& resetIndex);

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

    int getAllReferencesToIdInIndex(int const& itemIndex, std::string const& valueID) const;
 
private:

    QSharedPointer<FieldReset> getReset(int const& resetIndex) const;
 
    //-----------------------------------------------------------------------------
    // Data.
    //-----------------------------------------------------------------------------

    QSharedPointer<Field> containingField_;

    QSharedPointer<QList<QSharedPointer<FieldReset> > > resets_;

    QSharedPointer<FieldValidator> validator_;
};
 
#endif // RESETINTERFACE_H