openswmm::BuiltinDefaultOutputPluginInfo Class Reference

#include <BuiltinPluginInfos.hpp>

Inheritance diagram for openswmm::BuiltinDefaultOutputPluginInfo:

Collaboration diagram for openswmm::BuiltinDefaultOutputPluginInfo:

Public Member Functions
std::string	id () const override
	Copy the stable builtin ID.
std::string	caption () const override
	Copy the UI caption.
std::string	description () const override
	Copy the capability description.
std::string	version () const override
	Copy the metadata version.
std::string	vendor () const override
	Copy the vendor name.
std::string	url () const override
	Copy the project URL.
std::string	license_type () const override
	Copy the SPDX license token.
std::string	license_text () const override
	Copy the license display name.
bool	has_output () const noexcept override
	Advertise this builtin metadata's matching capability.
std::vector< FileFilter >	file_filters () const override
	Copy the builtin format/role advertisement.
Public Member Functions inherited from openswmm::IPluginComponentInfo
virtual	~IPluginComponentInfo ()=default
	Destroy component metadata only through its owning library/host lifetime. PluginFactory borrows singleton metadata and does not delete it as an instance. Keep library loaded until all created plugin instances/callbacks are destroyed; base destructor performs no instance cleanup, registration or library unloading.
virtual std::vector< std::string >	tags () const
	Copy optional discovery keywords.
virtual bool	has_input () const noexcept
	Query whether this component advertises the input capability.
virtual bool	has_report () const noexcept
	Query whether this component advertises the report capability.
virtual bool	has_state_io () const noexcept
	Query whether this component advertises the state_io capability.
virtual bool	register_plugin (const RegistrationInfo &info)
	Apply implementation-defined registration data before protected factories.
virtual bool	registered () const noexcept
	Query implementation-defined registration readiness.
virtual RegistrationInfo	registration_info () const
	Copy implementation-reported current registration metadata.
virtual IInputPlugin *	create_input_plugin () const
	Allocate a distinct input plugin instance when supported and permitted.
virtual IOutputPlugin *	create_output_plugin () const
	Allocate a distinct output plugin instance when supported and permitted.
virtual IReportPlugin *	create_report_plugin () const
	Allocate a distinct report plugin instance when supported and permitted.
virtual IStateIOPlugin *	create_state_io_plugin () const
	Allocate a distinct state_io plugin instance when supported and permitted.

Static Public Member Functions
static BuiltinDefaultOutputPluginInfo &	instance () noexcept
	Access process-lifetime builtin metadata without constructing plugin instances.

Member Function Documentation

caption()

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

inlineoverridevirtual

Copy the UI caption.

Returns

Literal Default SWMM Output Plugin; no IO or discovery occurs.

Implements openswmm::IPluginComponentInfo.

description()

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

inlineoverridevirtual

Copy the capability description.

Returns

Literal Writes the SWMM 5.x binary time-series results file (.out).; no IO or discovery occurs.

Implements openswmm::IPluginComponentInfo.

file_filters()

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

overridevirtual

Copy the builtin format/role advertisement.

Returns

One *.out OUTPUT_WRITE application/octet-stream filter.

Reimplemented from openswmm::IPluginComponentInfo.

has_output()

bool openswmm::BuiltinDefaultOutputPluginInfo::has_output ( ) const

inlineoverridevirtualnoexcept

Advertise this builtin metadata's matching capability.

Returns

True; does not imply its metadata factory will instantiate the builtin. Actual default instances are injected separately by the engine.

Reimplemented from openswmm::IPluginComponentInfo.

id()

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

inlineoverridevirtual

Copy the stable builtin ID.

Returns

Literal org.hydrocouple.openswmm.builtin.output; no IO or discovery occurs.

Implements openswmm::IPluginComponentInfo.

instance()

BuiltinDefaultOutputPluginInfo & openswmm::BuiltinDefaultOutputPluginInfo::instance ( )

staticnoexcept

Access process-lifetime builtin metadata without constructing plugin instances.

Returns

Borrowed singleton; never delete. First construction is thread-safe.

license_text()

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

inlineoverridevirtual

Copy the license display name.

Returns

Literal Apache License, Version 2.0; no IO or discovery occurs.

Implements openswmm::IPluginComponentInfo.

license_type()

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

inlineoverridevirtual

Copy the SPDX license token.

Returns

Literal Apache-2.0; no IO or discovery occurs.

Implements openswmm::IPluginComponentInfo.

url()

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

inlineoverridevirtual

Copy the project URL.

Returns

Literal https://hydrocouple.org; no IO or discovery occurs.

Implements openswmm::IPluginComponentInfo.

vendor()

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

inlineoverridevirtual

Copy the vendor name.

Returns

Literal HydroCouple; no IO or discovery occurs.

Implements openswmm::IPluginComponentInfo.

version()

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

inlineoverridevirtual

Copy the metadata version.

Returns

Literal 1.0.0; no IO or discovery occurs.

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