ActivityExample Class Reference

Scoped activity monitor with explicit private work and document commands. More...

Inheritance diagram for ActivityExample:

Collaboration diagram for ActivityExample:

Public Member Functions
ExtensionInfo	info () const override
	Describe this independently configured example module.
bool	initialize (ExtensionHost *host, QString *error) override
	Discover activity services and subscribe before the initial snapshot.
void	shutdown () override
	End observation and discard borrowed host services before unload.
QString	id () const override
	Identify the own monitor dock.
QString	title () const override
	Name the monitor panel.
QWidget *	create (ExtensionHost *host) override
	Create a copied-state summary and explicit worker/document actions.
QString	kind () const override
	Identify this model-independent document factory.
bool	accepts (IModelInstance *instance) const override
	Accept independent utility views without borrowing a model.
QWidget *	create (IModelInstance *instance, ExtensionHost *host) override
	Create a utility document to demonstrate actual MDI focus.
QJsonObject	saveState (QWidget *view) const override
	Save an independent view without private state.
void	restoreState (QWidget *view, const QJsonObject &state) override
	Restore this stateless utility document.
Public Member Functions inherited from OpenSWMM::Sdk::IGuiExtension
virtual	~IGuiExtension ()=default
	Destroy the interface; the Qt loader owns the implementing QObject.
virtual QStringList	contributions () const
	Advertise supported contribution families for diagnostics.
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.
Public Member Functions inherited from OpenSWMM::Sdk::IDocumentViewFactory
virtual	~IDocumentViewFactory ()=default
	Destroy an unregistered view factory; unregister first to close its views.

Detailed Description

Scoped activity monitor with explicit private work and document commands.

Member Function Documentation

accepts()

bool ActivityExample::accepts ( IModelInstance *  instance ) const

inlineoverridevirtual

Accept independent utility views without borrowing a model.

Parameters

[in]

instance

Optional model, ignored.

Returns

True; document state contains no model data.

Implements OpenSWMM::Sdk::IDocumentViewFactory.

create() [1/2]

QWidget * ActivityExample::create ( ExtensionHost *  host )

inlineoverridevirtual

Create a copied-state summary and explicit worker/document actions.

Parameters

[in]

host

Borrowed host whose services have already been discovered.

Returns

New widget transferred to host ownership.

Implements OpenSWMM::Sdk::IDockPanelFactory.

Here is the call graph for this function:

create() [2/2]

QWidget * ActivityExample::create ( IModelInstance *  instance, ExtensionHost *  host  )

inlineoverridevirtual

Create a utility document to demonstrate actual MDI focus.

Parameters

[in]	instance	Optional model, ignored.
[in]	host	Borrowed host, ignored.

Returns

New widget transferred to MDI ownership.

Implements OpenSWMM::Sdk::IDocumentViewFactory.

id()

QString ActivityExample::id ( ) const

inlineoverridevirtual

Identify the own monitor dock.

Returns

Stable local dock key.

Implements OpenSWMM::Sdk::IDockPanelFactory.

info()

ExtensionInfo ActivityExample::info ( ) const

inlineoverridevirtual

Describe this independently configured example module.

Returns

Owning metadata matching plugin.json.

Implements OpenSWMM::Sdk::IGuiExtension.

Here is the caller graph for this function:

initialize()

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

inlineoverridevirtual

Discover activity services and subscribe before the initial snapshot.

Parameters

[in]	host	Borrowed host, valid until shutdown.
[out]	error	Optional required-capability/registration diagnostic.

Returns

True after managed observation and UI registration succeed.

Implements OpenSWMM::Sdk::IGuiExtension.

Here is the call graph for this function:

kind()

QString ActivityExample::kind ( ) const

inlineoverridevirtual

Identify this model-independent document factory.

Returns

Stable extension-local kind.

Implements OpenSWMM::Sdk::IDocumentViewFactory.

Here is the caller graph for this function:

restoreState()

void ActivityExample::restoreState ( QWidget *  view, const QJsonObject &  state  )

inlineoverridevirtual

Restore this stateless utility document.

Parameters

[in]	view	Borrowed factory widget, ignored.
[in]	state	Owning state, ignored.

Implements OpenSWMM::Sdk::IDocumentViewFactory.

saveState()

QJsonObject ActivityExample::saveState ( QWidget *  view ) const

inlineoverridevirtual

Save an independent view without private state.

Parameters

[in]

view

Borrowed factory widget, ignored.

Returns

Empty state, suitable for forward-compatible restoration.

Implements OpenSWMM::Sdk::IDocumentViewFactory.

shutdown()

void ActivityExample::shutdown ( )

inlineoverridevirtual

End observation and discard borrowed host services before unload.

Implements OpenSWMM::Sdk::IGuiExtension.

title()

QString ActivityExample::title ( ) const

inlineoverridevirtual

Name the monitor panel.

Returns

User-facing dock caption.

Implements OpenSWMM::Sdk::IDockPanelFactory.

---

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

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