OpenSWMM Engine  6.0.0-alpha.1
Data-oriented, plugin-extensible SWMM Engine (6.0.0-alpha.1)
Loading...
Searching...
No Matches
openswmm::DiscoveredFilter Struct Reference

A FileFilter paired with the plugin id and version that emitted it. More...

#include <PluginDiscovery.hpp>

Collaboration diagram for openswmm::DiscoveredFilter:

Public Attributes

std::string plugin_id
 IPluginComponentInfo::id() of the source plugin.
 
std::string plugin_version
 IPluginComponentInfo::version() of the source plugin.
 
std::string plugin_caption
 IPluginComponentInfo::caption() — human-readable.
 
FileFilter filter
 The advertised filter.
 
bool is_builtin = false
 

Detailed Description

A FileFilter paired with the plugin id and version that emitted it.

The id/version are useful for hosts that want to label or sort filters by their providing plugin (e.g., grouping all GeoPackage filters together regardless of role).

Member Data Documentation

◆ filter

FileFilter openswmm::DiscoveredFilter::filter

The advertised filter.

◆ is_builtin

bool openswmm::DiscoveredFilter::is_builtin = false

Slice RC.3 — true when the source plugin is an engine built-in (statically linked into the engine, registered via PluginFactory::register_builtin_infos). False for plugins discovered through the on-disk shared-library scan. Propagated up to DiscoveredPlugin's matching field by discover_plugins_by_id.

◆ plugin_caption

std::string openswmm::DiscoveredFilter::plugin_caption

IPluginComponentInfo::caption() — human-readable.

◆ plugin_id

std::string openswmm::DiscoveredFilter::plugin_id

IPluginComponentInfo::id() of the source plugin.

◆ plugin_version

std::string openswmm::DiscoveredFilter::plugin_version

IPluginComponentInfo::version() of the source plugin.


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