ValueExampleExtension Class Reference

Consumer-owned adapter and host-owned monitor, containing no native model handles. More...

Inheritance diagram for ValueExampleExtension:

Collaboration diagram for ValueExampleExtension:

Public Member Functions
ExtensionInfo	info () const override
	Describe this independently configured diagnostic module.
bool	initialize (ExtensionHost *host, QString *error) override
	Subscribe before the initial snapshot and register a read-only monitor.
void	shutdown () override
	End observation/capture and discard borrowed host references before UI removal.
QStringList	contributions () const override
	Advertise the monitor's registered UI contribution families.
QString	id () const override
	Identify the extension-local diagnostic panel.
QString	title () const override
	Name the diagnostic dock.
QWidget *	create (ExtensionHost *host) override
	Mount copied counters and an explicit read-only snapshot refresh.
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

Consumer-owned adapter and host-owned monitor, containing no native model handles.

Member Function Documentation

contributions()

QStringList ValueExampleExtension::contributions ( ) const

inlineoverridevirtual

Advertise the monitor's registered UI contribution families.

Returns

Command and dock contribution names.

Reimplemented from OpenSWMM::Sdk::IGuiExtension.

create()

QWidget * ValueExampleExtension::create ( ExtensionHost *  host )

inlineoverridevirtual

Mount copied counters and an explicit read-only snapshot refresh.

Parameters

[in]

host

Borrowed host; service discovery already occurred during initialization.

Returns

New widget transferred to host ownership.

Implements OpenSWMM::Sdk::IDockPanelFactory.

Here is the call graph for this function:

id()

QString ValueExampleExtension::id ( ) const

inlineoverridevirtual

Identify the extension-local diagnostic panel.

Returns

Stable local dock key.

Implements OpenSWMM::Sdk::IDockPanelFactory.

info()

ExtensionInfo ValueExampleExtension::info ( ) const

inlineoverridevirtual

Describe this independently configured diagnostic module.

Returns

Owning plugin metadata matching plugin.json.

Implements OpenSWMM::Sdk::IGuiExtension.

Here is the caller graph for this function:

initialize()

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

inlineoverridevirtual

Subscribe before the initial snapshot and register a read-only monitor.

Parameters

[in]	host	Borrowed calling host, valid through shutdown.
[out]	error	Optional required-capability, explicit capture or UI failure detail.

Returns

True after all source subscriptions and contribution registrations succeed.

Implements OpenSWMM::Sdk::IGuiExtension.

Here is the call graph for this function:

shutdown()

void ValueExampleExtension::shutdown ( )

inlineoverridevirtual

End observation/capture and discard borrowed host references before UI removal.

Implements OpenSWMM::Sdk::IGuiExtension.

Here is the caller graph for this function:

title()

QString ValueExampleExtension::title ( ) const

inlineoverridevirtual

Name the diagnostic dock.

Returns

Translated user-facing 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/values/extension.cpp