PluginDiscovery.hpp File Reference

Public, framework-free facade for enumerating plugin file filters. More...

#include <string>
#include <vector>
#include "IPluginComponentInfo.hpp"

Include dependency graph for PluginDiscovery.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	openswmm::DiscoveredFilter
	A FileFilter paired with the plugin id and version that emitted it. More...
struct	openswmm::DiscoveredPlugin
	A plugin grouped by id with all the roles and filters it advertises. More...

Namespaces
namespace	openswmm

Macros
#define	SWMM_ENGINE_API   __attribute__((visibility("default")))

Functions
std::vector< DiscoveredFilter >	openswmm::discover_all_filters ()
	Copy file-filter metadata from a transient builtin/dynamic plugin discovery.
std::vector< DiscoveredPlugin >	openswmm::discover_plugins_by_id ()
	Group a fresh file-filter discovery snapshot by exact plugin ID.

Detailed Description

Public, framework-free facade for enumerating plugin file filters.

Hosts (Qt GUIs, CLI tools, Python bindings) typically only need to know what file formats the engine and its plugins handle, not the full lifecycle. This header exposes a one-shot discovery facade that walks every built-in default plugin plus every on-disk plugin shared library, and returns the flat list of FileFilter entries each plugin advertises.

Internally this constructs a transient PluginFactory, so calling discover_all_filters() triggers a directory scan. Callers should cache the result.

Author

Caleb Buahin caleb.nosp@m..bua.nosp@m.hin@g.nosp@m.mail.nosp@m..com

Copyright

Copyright (c) 2026 Caleb Buahin. All rights reserved.

License

Apache-2.0

Macro Definition Documentation

SWMM_ENGINE_API

#define SWMM_ENGINE_API   __attribute__((visibility("default")))