extensionstateregistry.h

Go to the documentation of this file.

 
#pragma once
#include "sdk/IViewEvents.hpp"
#include "sdk/IActivityEvents.hpp"
#include <QPointer>
#include <memory>
 
namespace openswmmvis
{
struct SessionMetadata {
    QUuid instanceId;          
    QString title;             
    QString inputPath;         
    QString projectPath;       
    bool dirty = false;        
    quint64 modelRevision = 0; 
};
 
class ExtensionStateRegistry final : public QObject
{
    Q_OBJECT
public:
    explicit ExtensionStateRegistry(QObject *parent = nullptr);
    ~ExtensionStateRegistry() override;
    static ExtensionStateRegistry *instance();
    QUuid registerSession(QObject *owner, const SessionMetadata &metadata);
    QUuid sessionForOwner(QObject *owner) const;
    QObject *ownerForSession(const QUuid &sessionId) const;
    OpenSWMM::Sdk::StateSnapshot snapshot() const;
    OpenSWMM::Sdk::ModelSessionState session(const QUuid &sessionId) const;
    OpenSWMM::Sdk::ViewSnapshot viewSnapshot(const QUuid &sessionId) const;
    void refreshViews(const QUuid &sessionId, OpenSWMM::Sdk::ViewSnapshot snapshot);
    void publishView(const QUuid &sessionId, OpenSWMM::Sdk::ViewSnapshot snapshot,
                     OpenSWMM::Sdk::ViewEvent event);
    bool isDeliverable(const OpenSWMM::Sdk::ViewEvent &event) const;
    OpenSWMM::Sdk::ActivitySnapshot activitySnapshot(const QUuid &ownerId,
                                                     const QUuid &windowId) const;
    OpenSWMM::Sdk::ProcessState operation(const QUuid &operationId) const;
    QUuid beginOperation(OpenSWMM::Sdk::ProcessState state);
    void startOperation(const QUuid &operationId, const QDateTime &startedAt = {});
    void progressOperation(const QUuid &operationId, double fraction, const QString &stage = {});
    bool requestOperationCancel(const QUuid &operationId);
    void finishOperation(const QUuid &operationId, OpenSWMM::Sdk::ProcessPhase outcome,
                          const QString &error = {}, int errorCode = 0,
                          const QDateTime &finishedAt = {});
    void retireOperation(const QUuid &operationId);
    void refreshActivityUi(const QUuid &ownerId, OpenSWMM::Sdk::UiActivityState state);
    void publishActivityUi(const QUuid &ownerId, OpenSWMM::Sdk::UiActivityState state,
                            OpenSWMM::Sdk::ActivityEvent event);
    void forgetActivityOwner(const QUuid &ownerId);
    bool isDeliverable(const OpenSWMM::Sdk::ActivityEvent &event) const;
    void updateSession(const QUuid &sessionId, const SessionMetadata &metadata,
                       OpenSWMM::Sdk::StateChanges changes = OpenSWMM::Sdk::StateChange::Metadata);
    quint64 beginLoad(const QUuid &sessionId);
    void finishLoad(const QUuid &sessionId, quint64 generation, bool ok, const QString &error = {});
    void beginClosing(const QUuid &sessionId);
    void retireSession(const QUuid &sessionId);
    bool isDeliverable(const OpenSWMM::Sdk::StateEvent &event) const;
    bool isCurrent(const QUuid &sessionId, QObject *expectedOwner) const;
    bool isCurrent(const OpenSWMM::Sdk::SaveRequest &request) const;
    QUuid beginSave(const QList<QUuid> &sessionIds, OpenSWMM::Sdk::SaveKind kind,
                    const QString &targetPath, bool joinExisting, QString *error = nullptr);
    bool isSaving(const QUuid &sessionId) const;
    QUuid operationFor(const QUuid &sessionId) const;
    void updateSaveTarget(const QUuid &operationId, const QString &targetPath);
    void endSave(const QUuid &operationId, bool ok, const QString &error = {});
 
signals:
    void sessionRegistered(QObject *owner, const QUuid &sessionId);
    void stateEventReady(const OpenSWMM::Sdk::StateEvent &event);
    void viewEventReady(const OpenSWMM::Sdk::ViewEvent &event);
    void activityEventReady(const OpenSWMM::Sdk::ActivityEvent &event);
    void beforeSave(const OpenSWMM::Sdk::SaveRequest &request);
 
private:
    friend class ExtensionSaveOperation;
    struct Data; 
    std::unique_ptr<Data> mData; 
    void enqueueActivity(OpenSWMM::Sdk::ActivityEvent event);
    void enqueue(OpenSWMM::Sdk::StateEventKind kind, const OpenSWMM::Sdk::ModelSessionState &state,
                 OpenSWMM::Sdk::StateChanges changes = {},
                 const OpenSWMM::Sdk::SaveState &save = {});
    void scheduleDrain();
    void drain();
};
 
class ExtensionSaveOperation final
{
public:
    ExtensionSaveOperation(ExtensionStateRegistry *registry, const QList<QUuid> &sessions,
                           OpenSWMM::Sdk::SaveKind kind, const QString &targetPath,
                           QString *error = nullptr, bool joinExisting = false);
    ~ExtensionSaveOperation();
    ExtensionSaveOperation(const ExtensionSaveOperation &other) = delete;
    ExtensionSaveOperation &operator=(const ExtensionSaveOperation &other) = delete;
    bool valid() const;
    bool ownsOperation() const;
    QUuid operationId() const;
    void setTargetPath(const QString &targetPath);
    void succeed();
 
private:
    QPointer<ExtensionStateRegistry> mRegistry; 
    QUuid mOperation;          
    QString *mError = nullptr; 
    bool mOwner = false;       
    bool mSucceeded = false;   
};
}