IReportPlugin.hpp File Reference

Interface for report-writing plugins. More...

#include <string>
#include <vector>
#include "PluginState.hpp"
#include "SimulationSnapshot.hpp"

Include dependency graph for IReportPlugin.hpp:

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

Go to the source code of this file.

Classes
class	openswmm::IReportPlugin
	Interface for report-writing plugins. More...

Namespaces
namespace	openswmm

Detailed Description

Interface for report-writing plugins.

Implement this interface to write SWMM summary reports to custom formats (CSV, Excel, database, etc.).

Report plugins are similar to output plugins but are also called at the end of the simulation to write summary statistics. The update() method receives time-series data as output steps progress, and write_summary() is called once after finalize().

Threading model: Same as IOutputPlugin — update() is called from the IO thread with a read-only SimulationSnapshot.