ModeReferenceInterface.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
// File: ModeReferenceInterface.h
//-----------------------------------------------------------------------------
// Project: Kactus 2
// Author: Anton Hagqvist
// Date: 26.10.2023
//
// Description:
// Interface for accessing mode references.
//-----------------------------------------------------------------------------
 
#ifndef MODEREFERENCEINTERFACE_H
#define MODEREFERENCEINTERFACE_H
 
#include <KactusAPI/KactusAPIGlobal.h>
 
#include <QList>
#include <QSharedPointer>
 
class ModeReference;
class Mode;
 
class KACTUS2_API ModeReferenceInterface
{
 
public:
 
    ModeReferenceInterface() = default;
 
    virtual ~ModeReferenceInterface() = default;

    void setModeReferences(std::vector<std::pair<unsigned int, std::string> > const& modeReferences);

    int getModeReferenceCount() const;

    std::string getModeReferenceValue(int modeReferenceIndex) const;

    int getModeReferencePriority(int modeReferenceIndex) const;

    bool setModeReferenceValue(int modeReferenceIndex, std::string const& newValue);

    bool setModeReferencePriority(int modeReferenceIndex, unsigned int newPriority);

    bool addModeReference(int row);

    bool removeModeReference(int modeReferenceIndex);

    bool modeReferenceValueIsValid(int modeReferenceIndex) const;
    
    bool modeReferencePriorityIsValid(int modeReferenceIndex) const;
    
    std::vector<std::string> getModeReferencesString() const;

    void setContainingElementIsRemap(bool isRemap);

    void setContainingElementModeReferences(std::vector<std::pair<unsigned int, std::string> > const& modeReferences);

    std::vector<std::string> getComponentModes() const;

    void setComponentModes(QSharedPointer<QList<QSharedPointer<Mode> > > newModes);

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

    bool areAllModeReferencesValid();
 
private:
    
    std::vector<std::pair<unsigned int, std::string> > getModeReferencesInUse(int modeReferenceIndex) const;

    std::vector<std::pair<unsigned int, std::string> > containingElementModeReferences_;

    std::vector<std::pair<unsigned int, std::string> > modeReferences_;

    QSharedPointer<QList<QSharedPointer<Mode> > > componentModes_;

    bool containingElementIsRemap_ = false;
 
};
 
#endif // MODEREFERENCEINTERFACE_H