imodellist.h

#pragma once

#include "base/src/variant.h"

namespace itasca {

    class IModelList {
    public:
        // Information to describe a property in a model.
        struct PropInfo {
            QString       name_;
            Variant::Type type_ = Variant::DoubleType;
            bool          advanced_ = false;
            bool          readOnly_ = false;
        };
        // the string signifying no model assignment
        static const char *noModelAssigned() { return "unassigned"; }
        // Information to describe a model.
        struct ModelInfo {
            QString               keyword_;
            QString               fullName_;
            bool                  advanced_ = false;
            bool                  creep_ = false;
            bool                  liquefaction_ = false;
            std::vector<PropInfo> properties_;
            QStringList           states_;
        };
        // Used to return info about model/prop info and values in a region of the model.
        struct ModelQueryInfo {
            QString keyword_;   // QString() if more than one model found.
            std::vector<PropInfo> properties_; // empty if more than one model found.
            std::vector<Variant>  values_;     // void type of value null if more than one value of the given property found.
            void clear() { keyword_ = QString(); properties_.clear(); values_.clear(); }
        };
        virtual QStringList getAllModelKeywords() const=0;
        virtual ModelInfo   getModelInfo(const QString &keyword) const=0;
    };

} // namespace itasca
// EoF