OpenSWMMVisService Class Reference

Abstract base class for all OpenSWMMVis plug-in services. More...

#include <openswmmvisservice.h>

Collaboration diagram for OpenSWMMVisService:

Public Member Functions
	OpenSWMMVisService ()=default
	Default constructor.
virtual	~OpenSWMMVisService ()=default
	Virtual destructor — required for polymorphic deletion.
virtual QString	name () const =0
	Returns the unique string identifier of this service.
virtual QString	version () const =0
	Returns the version string of this service implementation.
virtual void	executeRequest (const OpenSWMMVisServiceRequest &request, OpenSWMMVisServiceResponse &response)=0
	Execute a service request and populate a response.

Detailed Description

Abstract base class for all OpenSWMMVis plug-in services.

Concrete services must override name(), version(), and executeRequest(). They are registered with the host application at runtime so that UI panels, scripts, and automation clients can invoke them by name without a compile-time dependency on the concrete implementation.

Constructor & Destructor Documentation

OpenSWMMVisService()

OpenSWMMVisService::OpenSWMMVisService ( )

default

Default constructor.

~OpenSWMMVisService()

virtual OpenSWMMVisService::~OpenSWMMVisService ( )

virtualdefault

Virtual destructor — required for polymorphic deletion.

Member Function Documentation

executeRequest()

virtual void OpenSWMMVisService::executeRequest ( const OpenSWMMVisServiceRequest &  request, OpenSWMMVisServiceResponse &  response  )

pure virtual

Execute a service request and populate a response.

Implementations must be re-entrant: the host may call this method from multiple threads concurrently. Implementations are responsible for any internal locking.

Parameters

[in]	request	Typed request object carrying the input parameters.
[out]	response	Response object that will be populated by this call.

name()

virtual QString OpenSWMMVisService::name ( ) const

pure virtual

Returns the unique string identifier of this service.

The name is used as the registry key; it must be unique across all registered services and must not change between versions.

Returns

Service name string (e.g. "SWMM.Simulation.Run").

version()

virtual QString OpenSWMMVisService::version ( ) const

pure virtual

Returns the version string of this service implementation.

Uses semantic versioning (MAJOR.MINOR.PATCH). Callers can compare against a minimum required version to guard against incompatible service implementations.

Returns

Version string (e.g. "1.0.0").

---

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

• /home/runner/work/openswmm.gui/openswmm.gui/include/core/openswmmvisservice.h