IModelInstance.hpp

Go to the documentation of this file.

 
#pragma once
#include <QObject>
#include <QUuid>
#include <QVariantMap>
#include "IEngineLease.hpp"
#include "IEditScope.hpp"
#include "IAttributeProvider.hpp"
#include "IComputedAttributeProvider.hpp"
#include <memory>
 
namespace OpenSWMM::Sdk
{
class IProject;
class IModelInstance
{
public:
    virtual ~IModelInstance() = default;
    virtual QUuid id() const = 0;
    virtual QString title() const = 0;
    virtual QString inpPath() const = 0;
    virtual QString engineVersion() const = 0;
    virtual QObject *lifetime() const = 0;
    virtual IProject *project() const = 0;
    virtual bool isOpen() const = 0;
    virtual QList<QVariantMap> selection() const = 0;
    virtual void select(const QList<QVariantMap> &objects) = 0;
    virtual QString snapshot(QString *error = nullptr) const = 0;
    virtual QVariantMap attributes(const QString &category, const QString &name) const = 0;
    virtual IAttributeProvider *attributeProvider() const = 0;
    virtual QList<QVariantMap> results() const = 0;
    virtual std::unique_ptr<IEngineLease> acquireLease(LeaseKind kind,
                                                       QString *error = nullptr) = 0;
    virtual std::unique_ptr<INativeEditScope> nativeEdit(const QString &label,
                                                         QString *error = nullptr) = 0;
    virtual std::unique_ptr<IEditScope> edit(const QString &label, QString *error = nullptr) = 0;
    virtual bool registerAttributeProvider(const QString &id, IComputedAttributeProvider *provider,
                                           QObject *context, QString *error = nullptr) = 0;
    virtual void unregisterAttributeProvider(const QString &id) = 0;
    virtual void refreshAttributeProvider(const QString &id) = 0;
};
}