LifecycleExampleExtension Class Reference

Small session-state monitor and namespaced project-state collection example. More...

Inheritance diagram for LifecycleExampleExtension:

Collaboration diagram for LifecycleExampleExtension:

Public Member Functions
ExtensionInfo	info () const override
	Describe the independently configured plugin identity.
bool	initialize (ExtensionHost *host, QString *error) override
	Discover lifecycle services, subscribe before snapshotting and mount a monitor.
void	shutdown () override
	Disconnect both observation paths before host-owned UI cleanup.
QStringList	contributions () const override
	Advertise this example's UI contribution families.
QString	id () const override
	Identify the extension-local monitor dock.
QString	title () const override
	Name the monitor dock for the View menu.
QWidget *	create (ExtensionHost *host) override
	Create a summary, copied session metadata and an explicit refresh button.
Public Member Functions inherited from OpenSWMM::Sdk::IGuiExtension
virtual	~IGuiExtension ()=default
	Destroy the interface; the Qt loader owns the implementing QObject.
virtual QList< ExtensionInfo >	children () const
	Enumerate extensions hosted by this plugin, such as Python-authored packages.
Public Member Functions inherited from OpenSWMM::Sdk::IDockPanelFactory
virtual	~IDockPanelFactory ()=default
	Destroy an unregistered factory; registered factories remain borrowed by the host.
virtual Qt::DockWidgetArea	defaultArea () const
	Choose initial placement before saved layout restore.
virtual QString	tabifyWith () const
	Request tabification beside an existing dock.

Detailed Description

Small session-state monitor and namespaced project-state collection example.

Model UUIDs identify persistent content; session UUIDs identify an open lifetime. The plugin keeps copied snapshots and event counters rather than raw model handles. Dynamic properties on this object and its summary label support independent consumer conformance checks using ordinary Qt APIs.

Member Function Documentation

contributions()

QStringList LifecycleExampleExtension::contributions ( ) const

inlineoverridevirtual

Advertise this example's UI contribution families.

Returns

Names of the registered command and dock contribution families.

Reimplemented from OpenSWMM::Sdk::IGuiExtension.

create()

QWidget * LifecycleExampleExtension::create ( ExtensionHost *  host )

inlineoverridevirtual

Create a summary, copied session metadata and an explicit refresh button.

Parameters

[in]

host

Borrowed registration host; lifecycle queries use the discovered capability.

Returns

New widget transferred to host ownership.

Note

The button performs a read-only snapshot query; queued observers issue no mutations.

Implements OpenSWMM::Sdk::IDockPanelFactory.

Here is the call graph for this function:

id()

QString LifecycleExampleExtension::id ( ) const

inlineoverridevirtual

Identify the extension-local monitor dock.

Returns

Identity qualified by the host with the configured plugin ID.

Implements OpenSWMM::Sdk::IDockPanelFactory.

info()

ExtensionInfo LifecycleExampleExtension::info ( ) const

inlineoverridevirtual

Describe the independently configured plugin identity.

Returns

Owning metadata matching this module's embedded plugin.json.

Implements OpenSWMM::Sdk::IGuiExtension.

Here is the caller graph for this function:

initialize()

bool LifecycleExampleExtension::initialize ( ExtensionHost *  host, QString *  error  )

inlineoverridevirtual

Discover lifecycle services, subscribe before snapshotting and mount a monitor.

Parameters

[in]	host	Borrowed per-plugin host, valid through shutdown().
[out]	error	Optional missing-capability, subscription or UI-registration diagnostic.

Returns

True after the snapshot handshake and UI contribution succeed.

Note

All registration, queries, callbacks and widget operations use the GUI thread.

Implements OpenSWMM::Sdk::IGuiExtension.

Here is the call graph for this function:

shutdown()

void LifecycleExampleExtension::shutdown ( )

inlineoverridevirtual

Disconnect both observation paths before host-owned UI cleanup.

Note

Idempotent; snapshots/counters are values and no model handle is retained.

Implements OpenSWMM::Sdk::IGuiExtension.

Here is the caller graph for this function:

title()

QString LifecycleExampleExtension::title ( ) const

inlineoverridevirtual

Name the monitor dock for the View menu.

Returns

Translated user-facing panel title.

Implements OpenSWMM::Sdk::IDockPanelFactory.

---

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

• /home/runner/work/openswmm.gui/openswmm.gui/examples/extensions/lifecycle/extension.cpp