FieldInterface.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
// File: FieldInterface.h
//-----------------------------------------------------------------------------
// Project: Kactus2
// Author: Mikko Teuho
// Date: 07.04.2020
//
// Description:
// Interface for editing fields.
//-----------------------------------------------------------------------------
 
#ifndef FIELDINTERFACE_H
#define FIELDINTERFACE_H
 
#include <KactusAPI/KactusAPIGlobal.h>
 
#include <ParameterizableInterface.h>
#include <NameGroupInterface.h>
#include <ArrayableMemoryInterface.h>
 
#include <IPXACTmodels/generaldeclarations.h>
#include <IPXACTmodels/common/AccessTypes.h>
 
#include <IPXACTmodels/Component/validators/FieldAccessPolicyValidator.h>
 
#include <QVector>
#include <QMap>
 
class Field;
class FieldValidator;
class ResetInterface;
class WriteValueConstraint;
class ModeReference;
class ModeReferenceInterface;
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
class KACTUS2_API FieldInterface : public ArrayableMemoryInterface
{
 
public:

    FieldInterface(QSharedPointer<FieldValidator> validator,
        QSharedPointer<ExpressionParser> expressionParser,
        QSharedPointer<ExpressionFormatter> expressionFormatter,
        ResetInterface* subInterface);
    
    virtual ~FieldInterface() = default;

    void setFields(QSharedPointer<QList<QSharedPointer<Field> > > newFields);

    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;

    std::string getOffsetValue(std::string const& fieldName, int const& baseNumber = 0) const;

    std::string getOffsetFormattedExpression(std::string const& fieldName) const;

    std::string getOffsetExpression(std::string const& fieldName) const;

    bool setOffset(std::string const& fieldName, std::string const& newOffset);

    std::string getWidthValue(std::string const& fieldName, int const& baseNumber = 0) const;
    
    std::string getWidthFormattedExpression(std::string const& fieldName) const;

    std::string getWidthExpression(std::string const& fieldName) const;

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

    std::string getResets(std::string const& fieldName) const;

    std::string getResetsToolTip(std::string const& fieldName) const;

    std::string getVolatile(std::string const& fieldName) const;

    bool setVolatile(std::string const& fieldName, std::string const& newVolatile);

    std::string getAccessString(std::string const& fieldName, int accessPolicyIndex = -1) const;

    AccessTypes::Access getAccessType(std::string const& fieldName, int accessPolicyIndex = -1) const;

    bool setAccess(std::string const& fieldName, std::string const& accessType, int accessPolicyIndex = -1) const;

    std::string getModifiedWriteString(std::string const& fieldName, int accessPolicyIndex = -1) const;

    General::ModifiedWrite getModifiedWriteValue(std::string const& fieldName) const;

    bool setModifiedWrite(std::string const& fieldName, std::string const& newModifiedWrite, 
        int accessPolicyIndex = -1);

    std::string getReadActionString(std::string const& fieldName, int accessPolicyIndex = -1) const;

    General::ReadAction getReadAction(std::string const& fieldName, int accessPolicyIndex = -1) const;

    bool setReadAction(std::string const& fieldName, std::string const& newReadAction, int accessPolicyIndex = -1);

    std::string getTestableValue(std::string const& fieldName, int accessPolicyIndex = -1) const;

    bool getTestableBool(std::string const& fieldName, int accessPolicyIndex = -1) const;

    bool setTestable(std::string const& fieldName, std::string const& newTestable, int accessPolicyIndex = -1) const;

    std::string getTestConstraintString(std::string const& fieldName, int accessPolicyIndex = -1) const;

    General::TestConstraint getTestConstraint(std::string const& fieldName, int accessPolicyIndex = -1) const;

    bool setTestConstraint(std::string const& fieldName, std::string const& newTestConstraint, int accessPolicyIndex = -1) const;

    std::string getIsPresentValue(std::string const& fieldName, int const& baseNumber = 0) const;

    std::string getIsPresentFormattedExpression(std::string const& fieldName) const;

    std::string getIsPresentExpression(std::string const& fieldName) const;

    bool setIsPresent(std::string const& fieldName, std::string const& newIsPresent);

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

    virtual bool validateItems() const override final;

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

    bool hasValidOffset(std::string const& fieldName) const;

    bool hasValidWidth(std::string const& fieldName) const;

    bool hasValidResets(std::string const& fieldName) const;

    bool hasValidIsPresent(std::string const& fieldName) const;

    bool hasValidAccess(std::string const& fieldName, int accessPolicyIndex = -1) const;

    bool hasValidReadResponse(std::string const& fieldName, int accessPolicyIndex) const;

    bool hasValidReserved(std::string const& fieldName, int accessPolicyIndex) const;

    bool hasValidWriteValueConstraint(std::string const& fieldName, int accessPolicyIndex) const;

    void addField(int const& row, std::string const& newFieldName = std::string(""));

    void addField(std::string const& newFieldName = std::string(""));

    bool removeField(std::string const& fieldName);

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

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

    int getPasteRowCount() const;

    std::vector<std::string> getExpressionsInSelectedFields(std::vector<std::string> const& fieldNames) const;

    ResetInterface* getSubInterface() const;

    bool hasWriteConstraint(std::string const& fieldName) const;

    std::string getWriteConstraint(std::string const& fieldName, int accessPolicyIndex = -1) const;

    bool setWriteConstraint(std::string const& fieldName, std::string const& newConstraintText,
        int accessPolicyIndex = -1);

    std::string getWriteConstraintMinimumValue(std::string const& fieldName, int accessPolicyIndex = -1,
        int const& baseNumber = 0) const;

    std::string getWriteConstraintMinimumFormattedExpression(std::string const& fieldName,
        int accessPolicyIndex = -1) const;

    std::string getWriteConstraintMinimumExpression(std::string const& fieldName, int accessPolicyIndex = -1) const;

    bool setWriteConstraintMinimum(std::string const& fieldName, std::string const& newWriteConstraintMinimum,
        int accessPolicyIndex = -1);

    std::string getWriteConstraintMaximumValue(std::string const& fieldName, int accessPolicyIndex = -1,
        int const& baseNumber = 0) const;

    std::string getWriteConstraintMaximumFormattedExpression(std::string const& fieldName,
        int accessPolicyIndex = -1) const;

    std::string getWriteConstraintMaximumExpression(std::string const& fieldName, int accessPolicyIndex = -1) const;

    bool setWriteConstraintMaximum(std::string const& fieldName, std::string const& newWriteConstraintMaximum,
        int accessPolicyIndex = -1);

    std::string getReservedValue(std::string const& fieldName, int accessPolicyIndex = -1,
        int const& baseNumber = 0) const;

    std::string getReservedFormattedExpression(std::string const& fieldName, int accessPolicyIndex = -1) const;

    std::string getReservedExpression(std::string const& fieldName, int accessPolicyIndex = -1) const;

    bool setReserved(std::string const& fieldName, std::string const& newReserved, int accessPolicyIndex = -1);

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

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

    bool addFieldAccessPolicy(std::string const& fieldName);

    bool removeFieldAccessPolicy(std::string const& fieldName, int accessPolicyIndex);

    std::vector<std::pair<std::string, unsigned int> > getModeRefs(std::string const& fieldName, int accessPolicyIndex) const;

    std::vector<std::pair<unsigned int, std::string> > getModeReferencesInUse(std::string const& fieldName, int accessPolicyIndex) const;

    std::vector<std::pair<unsigned int, std::string> > getModeReferences(std::string const& fieldName, int accessPolicyIndex) const;

    bool setModeReferences(std::string const& fieldName, int accessPolicyIndex, std::vector<std::pair<unsigned int, std::string> > const& newModeRefs);

    int getAccessPolicyCount(std::string const& fieldName) const;

    std::string getReadResponseExpression(std::string const& fieldName, int accessPolicyIndex) const;

    std::string getReadResponseFormattedExpression(std::string const& fieldName, int accessPolicyIndex) const;

    std::string getReadResponseValue(std::string const& fieldName, int accessPolicyIndex, int baseNumber = 0) const;

    bool setReadResponse(std::string const& fieldName, int accessPolicyIndex, std::string const& newReadResponse) const;

    int getAllReferencesToIdInFieldAccessPolicy(std::string const& fieldName, int accessPolicyIndex, std::string const& valueID) const;

    bool hasValidAccessPolicyModeRefs(std::string const& fieldName, int accessPolicyIndex) const;

    void copyFieldAccessPolicies(std::string const& fieldName, std::vector<int> const& selectedAccessPolicies);
    
    int pasteFieldaccessPolicies(std::string const& fieldName);

    void setModeReferenceInterface(ModeReferenceInterface* modeRefInterface);

    ModeReferenceInterface* getModeReferenceInterface() const;
 
private:

    QSharedPointer<Field> getField(std::string const& fieldName) const;
    
    QSharedPointer<NameGroup> getItem(std::string const& fieldName) const override;

    QSharedPointer<WriteValueConstraint> getWriteValueConstraint(std::string const& fieldName, int accessPolicyIndex = -1) const;
 
    //-----------------------------------------------------------------------------
    // Data.
    //-----------------------------------------------------------------------------

    QSharedPointer<QList<QSharedPointer<Field> > > fields_;

    QSharedPointer<FieldValidator> validator_;

    FieldAccessPolicyValidator accessPolicyValidator_;

    ResetInterface* subInterface_;

    ModeReferenceInterface* modeReferenceInterface_;
    
};
 
#endif // REGISTERTABLEMODEL_H