ISessionEvents.hpp

Go to the documentation of this file.

 
#pragma once
#include <QFlags>
#include <QList>
#include <QMetaObject>
#include <QMetaType>
#include <QObject>
#include <QString>
#include <QUuid>
#include <functional>
 
#define OPENSWMM_SESSION_EVENTS_IID "io.opensimulator.openswmm.IEventSource/2.0"
 
namespace OpenSWMM::Sdk
{
class IModelInstance;
inline constexpr auto SESSION_EVENTS_IID =
    OPENSWMM_SESSION_EVENTS_IID; 
 
enum class SessionStatus : quint32 {
    Created = 1, 
    Loading = 2, 
    Ready = 3,   
    Failed = 4,  
    Closing = 5  
};
 
enum class StateChange : quint32 {
    None = 0,         
    Metadata = 1,     
    Model = 2,        
    Selection = 4,    
    Viewport = 8,     
    Layers = 16,      
    Results = 32,     
    ProjectState = 64 
};
Q_DECLARE_FLAGS(StateChanges, StateChange)
Q_DECLARE_OPERATORS_FOR_FLAGS(StateChanges)
 
 
struct ModelSessionState {
    QUuid sessionId;            
    QUuid instanceId;           
    quint64 loadGeneration = 0; 
    quint64 stateRevision = 0;  
    quint64 modelRevision = 0;  
    SessionStatus status = SessionStatus::Created; 
    QString title;                                 
    QString inputPath;   
    QString projectPath; 
    QString error;       
    bool dirty = false;  
    bool saving = false; 
};
 
struct StateSnapshot {
    quint64 sequence =
        0; 
    QList<ModelSessionState> sessions; 
};
 
enum class StateEventKind : quint32 {
    SessionOpened = 1,  
    LoadStarted = 2,    
    ModelReady = 3,     
    LoadFailed = 4,     
    StateChanged = 5,   
    SaveStarted = 6,    
    SaveFinished = 7,   
    SessionClosing = 8, 
    SessionClosed = 9   
};
 
enum class SaveKind : quint32 {
    Project = 1, 
    Sidecar = 2, 
    Recovery = 3 
};
enum class SaveOutcome : quint32 {
    None = 0,      
    Started = 1,   
    Succeeded = 2, 
    Failed = 3     
};
 
struct SaveState {
    QUuid operationId; 
    SaveKind kind = SaveKind::Project;       
    SaveOutcome outcome = SaveOutcome::None; 
    QString targetPath; 
    QString error;      
};
 
struct StateEvent {
    StateEventKind kind = StateEventKind::SessionOpened; 
    quint64 sequence = 0;      
    ModelSessionState session; 
    StateChanges changes; 
    SaveState save;       
};
 
struct StateEventFilter {
    QList<StateEventKind> kinds; 
    QUuid
        sessionId; 
    bool accepts(const StateEvent &event) const
    {
        return (kinds.isEmpty() || kinds.contains(event.kind)) &&
               (sessionId.isNull() || sessionId == event.session.sessionId);
    }
};
 
struct SaveRequest {
    QUuid operationId;                 
    QUuid sessionId;                   
    QUuid instanceId;                  
    quint64 loadGeneration = 0;        
    SaveKind kind = SaveKind::Project; 
    QString
        targetPath; 
};
 
class ISessionEvents
{
public:
    virtual ~ISessionEvents() = default;
    virtual StateSnapshot stateSnapshot() const = 0;
    virtual IModelInstance *resolveSession(const QUuid &sessionId) const = 0;
    virtual QMetaObject::Connection
    observeState(QObject *context, const StateEventFilter &filter,
                 std::function<void(const StateEvent &)> callback) = 0;
    virtual QMetaObject::Connection
    observeBeforeSave(QObject *context, std::function<void(const SaveRequest &)> callback) = 0;
};
}
Q_DECLARE_INTERFACE(OpenSWMM::Sdk::ISessionEvents, OPENSWMM_SESSION_EVENTS_IID)
Q_DECLARE_METATYPE(OpenSWMM::Sdk::ModelSessionState)
Q_DECLARE_METATYPE(OpenSWMM::Sdk::StateSnapshot)
Q_DECLARE_METATYPE(OpenSWMM::Sdk::StateEvent)
Q_DECLARE_METATYPE(OpenSWMM::Sdk::StateEventKind)
Q_DECLARE_METATYPE(OpenSWMM::Sdk::StateChanges)
Q_DECLARE_METATYPE(OpenSWMM::Sdk::SaveRequest)