IActivityEvents.hpp

Go to the documentation of this file.

 
#pragma once
#include <QDateTime>
#include <QList>
#include <QMetaObject>
#include <QMetaType>
#include <QObject>
#include <QStringList>
#include <QUuid>
#include <functional>
 
#define OPENSWMM_ACTIVITY_EVENTS_IID "io.opensimulator.openswmm.IEventSource/4.0"
 
namespace OpenSWMM::Sdk
{
enum class ProcessKind : quint32 {
    Run = 1, 
    Job = 2  
};
enum class ProcessPhase : quint32 {
    Queued = 1,    
    Running = 2,   
    Succeeded = 3, 
    Failed = 4,    
    Cancelled = 5  
};
 
struct ProcessState {
    QUuid operationId; 
    ProcessKind kind = ProcessKind::Run;       
    ProcessPhase phase = ProcessPhase::Queued; 
    QUuid windowId;                            
    QUuid ownerId;         
    QString ownerPluginId; 
    QUuid sessionId;       
    QUuid instanceId; 
    quint64 loadGeneration = 0; 
    int rowId = -1;    
    QString title;     
    QString inputPath; 
    QString engineVersion; 
    double progress = 0.;  
    QString stage;         
    bool cancelRequested = false; 
    int errorCode = 0;    
    QString error;        
    QDateTime acceptedAt; 
    QDateTime startedAt;  
    QDateTime finishedAt; 
    quint64 revision = 0; 
    bool isTerminal() const
    {
        return phase == ProcessPhase::Succeeded || phase == ProcessPhase::Failed ||
               phase == ProcessPhase::Cancelled;
    }
};
 
enum class DocumentKind : quint32 {
    Model = 1,     
    Extension = 2, 
    Utility = 3    
};
struct DocumentState {
    QUuid documentId;                          
    DocumentKind kind = DocumentKind::Utility; 
    QUuid sessionId;       
    QString ownerPluginId; 
    QString title;         
    bool active = false;   
};
struct DockState {
    QUuid dockId;          
    QString id;            
    QString title;         
    bool open = false;     
    bool exposed = false;  
    bool floating = false; 
    int area = 0;          
};
struct CommandState {
    QUuid commandId;        
    QString id;             
    bool builtin = false;   
    QString title;          
    bool enabled = false;   
    bool visible = false;   
    bool checkable = false; 
    bool checked = false;   
    QStringList shortcuts;  
};
struct UiActivityState {
    QUuid windowId;                 
    QUuid activeDocumentId;         
    QList<DocumentState> documents; 
    QList<DockState> docks;         
    QList<CommandState> commands;   
};
struct ActivitySnapshot {
    quint64 sequence = 0; 
    QList<ProcessState>
        processes;      
    UiActivityState ui; 
};
enum class ActivityEventKind : quint32 {
    OperationAccepted = 1,     
    OperationStarted = 2,      
    OperationProgress = 3,     
    CancellationRequested = 4, 
    OperationFinished = 5,     
    OperationRemoved = 6,      
    ActiveDocumentChanged =
        7,               
    DocumentChanged = 8, 
    DocumentRemoved = 9, 
    DockChanged = 10,    
    DockRemoved = 11,    
    CommandChanged = 12, 
    CommandRemoved = 13  
};
struct ActivityEvent {
    ActivityEventKind kind =
        ActivityEventKind::OperationAccepted; 
    quint64 sequence = 0;                     
    ProcessState process; 
    QUuid windowId;       
    QUuid ownerId;  
    QUuid entityId; 
    QUuid origin;   
};
struct ActivityEventFilter {
    QList<ActivityEventKind> kinds; 
    QUuid operationId;              
    QUuid
        sessionId; 
    bool accepts(const ActivityEvent &event) const
    {
        return (kinds.isEmpty() || kinds.contains(event.kind)) &&
               (operationId.isNull() || operationId == event.process.operationId) &&
               (sessionId.isNull() || sessionId == event.process.sessionId);
    }
};
class IActivityEvents
{
public:
    virtual ~IActivityEvents() = default;
    virtual ActivitySnapshot activitySnapshot() const = 0;
    virtual QMetaObject::Connection
    observeActivity(QObject *context, const ActivityEventFilter &filter,
                    std::function<void(const ActivityEvent &)> callback) = 0;
};
}
Q_DECLARE_INTERFACE(OpenSWMM::Sdk::IActivityEvents, OPENSWMM_ACTIVITY_EVENTS_IID)
Q_DECLARE_METATYPE(OpenSWMM::Sdk::ProcessState)
Q_DECLARE_METATYPE(OpenSWMM::Sdk::ActivityEvent)
Q_DECLARE_METATYPE(OpenSWMM::Sdk::ActivitySnapshot)