userflagsmodel.h

Go to the documentation of this file.

 
#ifndef OPENSWMMVIS_UI_MODELS_USERFLAGSMODEL_H
#define OPENSWMMVIS_UI_MODELS_USERFLAGSMODEL_H
 
#include <QObject>
#include <QString>
#include <QVector>
 
#include <openswmm/engine/openswmm_engine.h>  // SWMM_Engine
 
namespace openswmmvis::ui {
 
class UserFlagsModel : public QObject
{
    Q_OBJECT
public:
    enum class FlagType : int {
        Boolean = 0,
        Integer = 1,
        Real    = 2,
        String  = 3
    };
    Q_ENUM(FlagType)
 
    
    struct Def {
        QString  name;
        FlagType type = FlagType::String;
        QString  description;
    };
 
    explicit UserFlagsModel(SWMM_Engine engine, QObject *parent = nullptr);
 
    [[nodiscard]] SWMM_Engine engine() const noexcept { return m_engine; }
 
    // ----- Schema definitions ([USER_FLAGS]) ------------------------------
 
    [[nodiscard]] const QVector<Def> &defs() const;
 
    [[nodiscard]] bool isDefined(const QString &name) const;
 
    bool define(const QString &name, FlagType type,
                const QString &description, QString *outError = nullptr);
 
    bool undefine(const QString &name, QString *outError = nullptr);
 
    // ----- Per-object values ([USER_FLAG_VALUES]) -------------------------
 
    [[nodiscard]] QString value(const QString &objType, const QString &objName,
                                const QString &flagName,
                                bool *found = nullptr) const;
 
    bool setValue(const QString &objType, const QString &objName,
                  const QString &flagName, const QString &value,
                  QString *outError = nullptr);
 
    bool clearValue(const QString &objType, const QString &objName,
                    const QString &flagName);
 
    static QString typeLabel(FlagType type);
 
signals:
    void defsChanged();
 
    void valueChanged(const QString &objType, const QString &objName,
                      const QString &flagName);
 
private:
    SWMM_Engine           m_engine = nullptr;
    mutable QVector<Def>  m_defsCache;
    mutable bool          m_defsCacheValid = false;
};
 
} // namespace openswmmvis::ui
 
#endif // OPENSWMMVIS_UI_MODELS_USERFLAGSMODEL_H