IViewEvents.hpp

Go to the documentation of this file.

 
#pragma once
#include "ISessionEvents.hpp"
#include <QDateTime>
#include <QStringList>
 
#define OPENSWMM_VIEW_EVENTS_IID "io.opensimulator.openswmm.IEventSource/3.0"
 
namespace OpenSWMM::Sdk
{
enum class ViewEventKind : quint32 {
    ModelGeometryChanged = 1,    
    ModelOptionsChanged = 2,     
    ObjectRenamed = 3,           
    AttributeValuesChanged = 4,  
    AttributeSchemaChanged = 5,  
    ModelSelectionChanged = 6,   
    LayerAdded = 7,              
    LayerRemoved = 8,            
    LayerMetadataChanged = 9,    
    LayerOrderChanged = 10,      
    LayerStyleChanged = 11,      
    LayerSchemaChanged = 12,     
    LayerFeaturesChanged = 13,   
    LayerSelectionChanged = 14,  
    LayerFilterChanged = 15,     
    LayerCrsChanged = 16,        
    LayerSourceChanged = 17,     
    ResultsSourceChanged = 18,   
    ResultsActiveChanged = 19,   
    ResultsVariableChanged = 20, 
    ResultsTimeChanged = 21, 
    ProjectUnitsChanged = 22 
};
 
struct LayerViewState {
    QUuid layerSessionId; 
    QString layerId; 
    QString title;   
    QString type;    
    QString crsWkt;  
    bool visible = false;      
    double opacity = 1.;       
    bool vector = false;       
    QString filter;            
    qint64 featureCount = -1;  
    qint64 selectionCount = 0; 
};
 
enum class ResultAvailability : quint32 {
    Empty = 0,   
    Loading = 1, 
    Ready = 2,   
    Failed = 3   
};
 
struct ResultVariableState {
    QString channelId;   
    QString variableKey; 
    QString units; 
};
 
struct ResultsViewState {
    QUuid layerSessionId;         
    QString layerId;              
    quint64 sourceGeneration = 0; 
    QString dimension;            
    QString path;                 
    ResultAvailability availability = ResultAvailability::Empty; 
    QString error;       
    bool active = false; 
    bool live = false;   
    qint64 periodCount = 0;               
    qint64 currentIndex = -1;             
    QDateTime currentDateTime;            
    QList<ResultVariableState> variables; 
};
 
struct ViewSnapshot {
    quint64 sequence = 0;            
    ModelSessionState session;       
    QList<LayerViewState> layers;    
    QList<ResultsViewState> results; 
    QString projectUnits;       
    qint64 selectedObjects = 0; 
};
 
struct ViewEvent {
    ViewEventKind kind = ViewEventKind::ModelGeometryChanged; 
    quint64 sequence = 0;      
    ModelSessionState session; 
    QUuid layerSessionId;      
    QString layerId; 
    quint64 sourceGeneration = 0; 
    QString objectNamespace;      
    QString previousName;         
    QString objectName; 
    QStringList keys;   
    QUuid
        origin; 
};
 
struct ViewEventFilter {
    QList<ViewEventKind> kinds; 
    QUuid sessionId;            
    QUuid layerSessionId;       
    bool accepts(const ViewEvent &event) const
    {
        return (kinds.isEmpty() || kinds.contains(event.kind)) &&
               (sessionId.isNull() || sessionId == event.session.sessionId) &&
               (layerSessionId.isNull() || layerSessionId == event.layerSessionId);
    }
};
 
class IViewEvents
{
public:
    virtual ~IViewEvents() = default;
    virtual ViewSnapshot viewSnapshot(const QUuid &sessionId) const = 0;
    virtual QMetaObject::Connection
    observeViews(QObject *context, const ViewEventFilter &filter,
                 std::function<void(const ViewEvent &)> callback) = 0;
};
}
Q_DECLARE_INTERFACE(OpenSWMM::Sdk::IViewEvents, OPENSWMM_VIEW_EVENTS_IID)
Q_DECLARE_METATYPE(OpenSWMM::Sdk::ViewEvent)
Q_DECLARE_METATYPE(OpenSWMM::Sdk::ViewSnapshot)
Q_DECLARE_METATYPE(OpenSWMM::Sdk::ViewEventKind)