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
openswmmvis::ExtensionViewAccess Class Referencefinal

Canonical native coordinator publishing into the application-owned registry. More...

#include <extensionviewaccess.h>

Inheritance diagram for openswmmvis::ExtensionViewAccess:
Collaboration diagram for openswmmvis::ExtensionViewAccess:

Public Member Functions

 ExtensionViewAccess (SWMMVisProjectWindow *window)
 Construct once after native session registration; owned by the window.
 
 ~ExtensionViewAccess () override
 Destroy native bridges before the window's QObject children.
 
void refresh ()
 Refresh final restored metadata before native readiness is committed.
 
bool execute (const OpenSWMM::Sdk::ViewCommand &command, QString *error)
 Validate session generation/readiness then execute a typed view command.
 
QList< qint64 > selectedFeatures (const QUuid &id, int offset, int limit) const
 Read one bounded page of current layer selection.
 
QUuid identity (OpenSWMMVisLayer *layer) const
 Resolve a tracked native layer to its current runtime attachment.
 

Static Public Member Functions

static ExtensionViewAccess * find (SWMMVisProjectWindow *window)
 Find an already installed coordinator without creating state.
 

Detailed Description

Canonical native coordinator publishing into the application-owned registry.

Constructor & Destructor Documentation

◆ ExtensionViewAccess()

openswmmvis::ExtensionViewAccess::ExtensionViewAccess ( SWMMVisProjectWindow *  window)
explicit

Construct once after native session registration; owned by the window.

Parameters
[in]windowRequired registered native owner.
Here is the call graph for this function:

◆ ~ExtensionViewAccess()

openswmmvis::ExtensionViewAccess::~ExtensionViewAccess ( )
override

Destroy native bridges before the window's QObject children.

Member Function Documentation

◆ execute()

bool openswmmvis::ExtensionViewAccess::execute ( const OpenSWMM::Sdk::ViewCommand &  command,
QString *  error 
)

Validate session generation/readiness then execute a typed view command.

Parameters
[in]commandCopied command using runtime attachment identity.
[out]errorOptional refusal detail.
Returns
True for accepted/no-op, false for unavailable or invalid input.

◆ find()

ExtensionViewAccess * openswmmvis::ExtensionViewAccess::find ( SWMMVisProjectWindow *  window)
static

Find an already installed coordinator without creating state.

Parameters
[in]windowBorrowed native window.
Returns
Borrowed coordinator or null during teardown.
Here is the caller graph for this function:

◆ identity()

QUuid openswmmvis::ExtensionViewAccess::identity ( OpenSWMMVisLayer *  layer) const

Resolve a tracked native layer to its current runtime attachment.

Parameters
[in]layerBorrowed native pointer; never adopted.
Returns
Attachment UUID, or null when detached or during teardown.

◆ refresh()

void openswmmvis::ExtensionViewAccess::refresh ( )

Refresh final restored metadata before native readiness is committed.

Here is the caller graph for this function:

◆ selectedFeatures()

QList< qint64 > openswmmvis::ExtensionViewAccess::selectedFeatures ( const QUuid &  id,
int  offset,
int  limit 
) const

Read one bounded page of current layer selection.

Parameters
[in]idRuntime attachment identity.
[in]offsetSorted selection offset.
[in]limitRequested page count.
Returns
Copied sorted FIDs.

The documentation for this class was generated from the following files: