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
IActivityEvents.hpp File Reference

Versioned process attempts and scoped UI lifecycle observations. More...

#include <QDateTime>
#include <QList>
#include <QMetaObject>
#include <QMetaType>
#include <QObject>
#include <QStringList>
#include <QUuid>
#include <functional>
Include dependency graph for IActivityEvents.hpp:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  OpenSWMM::Sdk::ProcessState
 Owning metadata for one unique accepted attempt, independent of row IDs/titles. More...
 
struct  OpenSWMM::Sdk::DocumentState
 Copied global MDI metadata, with actual focus separate from cached model context. More...
 
struct  OpenSWMM::Sdk::DockState
 Copied metadata for one calling extension's registered dock. More...
 
struct  OpenSWMM::Sdk::CommandState
 Calling extension's command or an approved existing built-in dialog command. More...
 
struct  OpenSWMM::Sdk::UiActivityState
 Copied UI metadata scoped to one main window and the calling extension's contributions. More...
 
struct  OpenSWMM::Sdk::ActivitySnapshot
 Pure copied retained process/UI metadata at the shared session/view/activity watermark. More...
 
struct  OpenSWMM::Sdk::ActivityEvent
 Owning deferred process transition or scoped UI invalidation. More...
 
struct  OpenSWMM::Sdk::ActivityEventFilter
 Registration-time event reason and optional process/session selection. More...
 
class  OpenSWMM::Sdk::IActivityEvents
 Frozen optional GUI-thread process and UI snapshot/observation capability. More...
 

Namespaces

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

Macros

#define OPENSWMM_ACTIVITY_EVENTS_IID   "io.opensimulator.openswmm.IEventSource/4.0"
 Frozen Qt discovery identity for process/UI observations.
 

Enumerations

enum class  OpenSWMM::Sdk::ProcessKind : quint32 {
  OpenSWMM::Sdk::Run = 1 ,
  OpenSWMM::Sdk::Job = 2
}
 Native shared simulation attempt or one calling extension's private worker. More...
 
enum class  OpenSWMM::Sdk::ProcessPhase : quint32 {
  OpenSWMM::Sdk::Queued = 1 ,
  OpenSWMM::Sdk::Running = 2 ,
  OpenSWMM::Sdk::Succeeded = 3 ,
  OpenSWMM::Sdk::Failed = 4 ,
  OpenSWMM::Sdk::Cancelled = 5
}
 Accepted scheduling/preparation, worker availability and distinct terminal outcomes. More...
 
enum class  OpenSWMM::Sdk::DocumentKind : quint32 {
  OpenSWMM::Sdk::Model = 1 ,
  OpenSWMM::Sdk::Extension = 2 ,
  OpenSWMM::Sdk::Utility = 3
}
 Runtime classification of a mounted MDI document. More...
 
enum class  OpenSWMM::Sdk::ActivityEventKind : quint32 {
  OpenSWMM::Sdk::OperationAccepted = 1 ,
  OpenSWMM::Sdk::OperationStarted = 2 ,
  OpenSWMM::Sdk::OperationProgress = 3 ,
  OpenSWMM::Sdk::CancellationRequested = 4 ,
  OpenSWMM::Sdk::OperationFinished = 5 ,
  OpenSWMM::Sdk::OperationRemoved = 6 ,
  OpenSWMM::Sdk::ActiveDocumentChanged ,
  OpenSWMM::Sdk::DocumentChanged = 8 ,
  OpenSWMM::Sdk::DocumentRemoved = 9 ,
  OpenSWMM::Sdk::DockChanged = 10 ,
  OpenSWMM::Sdk::DockRemoved = 11 ,
  OpenSWMM::Sdk::CommandChanged = 12 ,
  OpenSWMM::Sdk::CommandRemoved = 13
}
 Stable process transitions and UI invalidation reasons. More...
 

Detailed Description

Versioned process attempts and scoped UI lifecycle observations.

Optional SDK 1.5 capability discovered on ExtensionHost::lifetime(). Calls and managed callbacks use the GUI thread. Metadata owns values, never runners, jobs, widgets or engine handles. Earlier event contracts remain frozen.

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_ACTIVITY_EVENTS_IID

#define OPENSWMM_ACTIVITY_EVENTS_IID   "io.opensimulator.openswmm.IEventSource/4.0"

Frozen Qt discovery identity for process/UI observations.