openswmm::BuiltinDefaultInputPluginInfo Class Reference

#include <BuiltinPluginInfos.hpp>

Inheritance diagram for openswmm::BuiltinDefaultInputPluginInfo:

Collaboration diagram for openswmm::BuiltinDefaultInputPluginInfo:

Public Member Functions
std::string	id () const override
	Unique plugin identifier in reverse-DNS notation.
std::string	caption () const override
	Human-readable display name of the plugin.
std::string	description () const override
	Detailed description of what this plugin does.
std::string	version () const override
	Plugin version string (Semantic Versioning recommended).
std::string	vendor () const override
	Vendor / author name.
std::string	url () const override
	URL to the plugin's home page or documentation.
std::string	license_type () const override
	SPDX license identifier for this plugin.
std::string	license_text () const override
	Full license text for this plugin.
bool	has_input () const noexcept override
	True if this plugin can create an IInputPlugin.
std::vector< FileFilter >	file_filters () const override
	File-format filters this plugin handles.
Public Member Functions inherited from openswmm::IPluginComponentInfo
virtual	~IPluginComponentInfo ()=default
virtual std::vector< std::string >	tags () const
	Additional tags or keywords for discovery.
virtual bool	has_output () const noexcept
	True if this plugin can create an IOutputPlugin.
virtual bool	has_report () const noexcept
	True if this plugin can create an IReportPlugin.
virtual bool	has_state_io () const noexcept
	True if this plugin can create an IStateIOPlugin.
virtual bool	register_plugin (const RegistrationInfo &info)
	Register the plugin with the provided registration information.
virtual bool	registered () const noexcept
	Check whether the plugin is currently registered.
virtual RegistrationInfo	registration_info () const
	Get the current registration information.
virtual IInputPlugin *	create_input_plugin () const
	Create a new IInputPlugin instance.
virtual IOutputPlugin *	create_output_plugin () const
	Create a new IOutputPlugin instance.
virtual IReportPlugin *	create_report_plugin () const
	Create a new IReportPlugin instance.
virtual IStateIOPlugin *	create_state_io_plugin () const
	Create a new IStateIOPlugin instance.

Static Public Member Functions
static BuiltinDefaultInputPluginInfo &	instance () noexcept

Member Function Documentation

caption()

std::string openswmm::BuiltinDefaultInputPluginInfo::caption ( ) const

inlineoverridevirtual

Human-readable display name of the plugin.

Returns

e.g. "HDF5 Output Plugin"

Implements openswmm::IPluginComponentInfo.

description()

std::string openswmm::BuiltinDefaultInputPluginInfo::description ( ) const

inlineoverridevirtual

Detailed description of what this plugin does.

Implements openswmm::IPluginComponentInfo.

file_filters()

std::vector< FileFilter > openswmm::BuiltinDefaultInputPluginInfo::file_filters ( ) const

overridevirtual

File-format filters this plugin handles.

Every plugin SHOULD override this and return one FileFilter per (role, format) pair it supports. The default empty return preserves binary compatibility for plugins built against older SDK headers, but PluginFactory logs a warning when a plugin advertises a capability (e.g., has_input() == true) yet returns no filter for the matching role.

Hosts (Qt GUIs, CLI, Python bindings) compose user-visible file dialogs from the union of filters across all loaded plugins, grouped by role.

Returns

Vector of filter entries; empty by default.

Reimplemented from openswmm::IPluginComponentInfo.

has_input()

bool openswmm::BuiltinDefaultInputPluginInfo::has_input ( ) const

inlineoverridevirtualnoexcept

True if this plugin can create an IInputPlugin.

The PluginFactory checks this before calling create_input_plugin().

Reimplemented from openswmm::IPluginComponentInfo.

id()

std::string openswmm::BuiltinDefaultInputPluginInfo::id ( ) const

inlineoverridevirtual

Unique plugin identifier in reverse-DNS notation.

Returns

e.g. "org.hydrocouple.openswmm.plugins.hdf5output"

Implements openswmm::IPluginComponentInfo.

instance()

BuiltinDefaultInputPluginInfo & openswmm::BuiltinDefaultInputPluginInfo::instance ( )

staticnoexcept

license_text()

std::string openswmm::BuiltinDefaultInputPluginInfo::license_text ( ) const

inlineoverridevirtual

Full license text for this plugin.

Return the complete license text (or a URL to it).

Returns

License text string.

Implements openswmm::IPluginComponentInfo.

license_type()

std::string openswmm::BuiltinDefaultInputPluginInfo::license_type ( ) const

inlineoverridevirtual

SPDX license identifier for this plugin.

Returns

e.g. "MIT", "GPL-3.0-only", "LicenseRef-Commercial"

See also

https://spdx.org/licenses/

Implements openswmm::IPluginComponentInfo.

url()

std::string openswmm::BuiltinDefaultInputPluginInfo::url ( ) const

inlineoverridevirtual

URL to the plugin's home page or documentation.

Returns

e.g. "https://hydrocouple.org/plugins/hdf5"

Implements openswmm::IPluginComponentInfo.

vendor()

std::string openswmm::BuiltinDefaultInputPluginInfo::vendor ( ) const

inlineoverridevirtual

Vendor / author name.

Returns

e.g. "HydroCouple Consortium"

Implements openswmm::IPluginComponentInfo.

version()

std::string openswmm::BuiltinDefaultInputPluginInfo::version ( ) const

inlineoverridevirtual

Plugin version string (Semantic Versioning recommended).

Returns

e.g. "1.0.0"

Implements openswmm::IPluginComponentInfo.

---

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

• /home/runner/work/openswmm.engine/openswmm.engine/src/engine/plugins/BuiltinPluginInfos.hpp
• /home/runner/work/openswmm.engine/openswmm.engine/src/engine/plugins/BuiltinPluginInfos.cpp