SWMMVis  6.0.0-alpha.4
Qt6/C++ GIS-based graphical user interface for the SWMMVis engine (6.0.0-alpha.4)
Loading...
Searching...
No Matches
IViewEvents.hpp File Reference

Versioned model, layer and attached-results observations and copied view metadata. More...

#include "ISessionEvents.hpp"
#include <QDateTime>
#include <QStringList>
Include dependency graph for IViewEvents.hpp:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  OpenSWMM::Sdk::LayerViewState
 Copied metadata for one unambiguous current canvas attachment. More...
 
struct  OpenSWMM::Sdk::ResultVariableState
 One current rendering channel's selected variable and native unit metadata. More...
 
struct  OpenSWMM::Sdk::ResultsViewState
 Copied state of an attached results layer, separate from run-attempt telemetry. More...
 
struct  OpenSWMM::Sdk::ViewSnapshot
 Pure copied current metadata at the shared registry watermark. More...
 
struct  OpenSWMM::Sdk::ViewEvent
 Owning deferred observation identifying state to query again. More...
 
struct  OpenSWMM::Sdk::ViewEventFilter
 Registration-time reason, session and runtime-attachment selection. More...
 
class  OpenSWMM::Sdk::IViewEvents
 Frozen optional GUI-thread view metadata and deferred domain observation service. More...
 

Namespaces

namespace  OpenSWMM
 
namespace  OpenSWMM::Sdk
 Public header-only ABI for independently compiled native GUI extensions.
 

Macros

#define OPENSWMM_VIEW_EVENTS_IID   "io.opensimulator.openswmm.IEventSource/3.0"
 Frozen discovery identity for SDK 1.4 model/layer/results observations.
 

Enumerations

enum class  OpenSWMM::Sdk::ViewEventKind : quint32 {
  OpenSWMM::Sdk::ModelGeometryChanged = 1 ,
  OpenSWMM::Sdk::ModelOptionsChanged = 2 ,
  OpenSWMM::Sdk::ObjectRenamed = 3 ,
  OpenSWMM::Sdk::AttributeValuesChanged = 4 ,
  OpenSWMM::Sdk::AttributeSchemaChanged = 5 ,
  OpenSWMM::Sdk::ModelSelectionChanged = 6 ,
  OpenSWMM::Sdk::LayerAdded = 7 ,
  OpenSWMM::Sdk::LayerRemoved = 8 ,
  OpenSWMM::Sdk::LayerMetadataChanged = 9 ,
  OpenSWMM::Sdk::LayerOrderChanged = 10 ,
  OpenSWMM::Sdk::LayerStyleChanged = 11 ,
  OpenSWMM::Sdk::LayerSchemaChanged = 12 ,
  OpenSWMM::Sdk::LayerFeaturesChanged = 13 ,
  OpenSWMM::Sdk::LayerSelectionChanged = 14 ,
  OpenSWMM::Sdk::LayerFilterChanged = 15 ,
  OpenSWMM::Sdk::LayerCrsChanged = 16 ,
  OpenSWMM::Sdk::LayerSourceChanged = 17 ,
  OpenSWMM::Sdk::ResultsSourceChanged = 18 ,
  OpenSWMM::Sdk::ResultsActiveChanged = 19 ,
  OpenSWMM::Sdk::ResultsVariableChanged = 20 ,
  OpenSWMM::Sdk::ResultsTimeChanged = 21 ,
  OpenSWMM::Sdk::ProjectUnitsChanged = 22
}
 Stable invalidation reasons, without geometry, selection or result arrays. More...
 
enum class  OpenSWMM::Sdk::ResultAvailability : quint32 {
  OpenSWMM::Sdk::Empty = 0 ,
  OpenSWMM::Sdk::Loading = 1 ,
  OpenSWMM::Sdk::Ready = 2 ,
  OpenSWMM::Sdk::Failed = 3
}
 Metadata availability of the currently attached results source. More...
 

Detailed Description

Versioned model, layer and attached-results observations and copied view metadata.

Optional SDK 1.4 capability discovered on ExtensionHost::lifetime(). All calls use the GUI thread. Values own metadata, never native objects or data arrays. The model and session event interfaces and layouts are unchanged; this contract has its own IID.

Author
Caleb Buahin caleb.nosp@m..bua.nosp@m.hin@g.nosp@m.mail.nosp@m..com
License
GPL-3.0-or-later

Macro Definition Documentation

◆ OPENSWMM_VIEW_EVENTS_IID

#define OPENSWMM_VIEW_EVENTS_IID   "io.opensimulator.openswmm.IEventSource/3.0"

Frozen discovery identity for SDK 1.4 model/layer/results observations.