openswmm::DefaultReportPlugin Class Reference

Default report plugin: writes SWMM 5.x compatible .rpt report file. More...

#include <DefaultReportPlugin.hpp>

Inheritance diagram for openswmm::DefaultReportPlugin:

Collaboration diagram for openswmm::DefaultReportPlugin:

Public Member Functions
	DefaultReportPlugin (std::string rpt_path)
	~DefaultReportPlugin () override=default
PluginState	state () const noexcept override
	Query the current plugin state.
int	initialize (const std::vector< std::string > &init_args, const IPluginComponentInfo *info) override
int	validate (const SimulationContext &ctx) override
	Validate configuration against the loaded model.
int	prepare (const SimulationContext &ctx) override
	Open report file(s) and write any headers.
int	update (const SimulationSnapshot &snapshot) override
	Accumulate data from one output step. Called from IO thread.
int	finalize (const SimulationContext &ctx) override
	Flush and close report file(s).
int	write_summary (const SimulationContext &ctx) override
	Write the summary statistics table to the .rpt file.
const char *	last_error_message () const noexcept override
	Get the last error message.
Public Member Functions inherited from openswmm::IReportPlugin
virtual	~IReportPlugin ()=default
virtual int	initialize (const std::vector< std::string > &init_args, const class IPluginComponentInfo *info)=0
	Initialize from [PLUGINS] arguments.

Detailed Description

Default report plugin: writes SWMM 5.x compatible .rpt report file.

Constructor & Destructor Documentation

DefaultReportPlugin()

openswmm::DefaultReportPlugin::DefaultReportPlugin ( std::string  rpt_path )

explicit

~DefaultReportPlugin()

openswmm::DefaultReportPlugin::~DefaultReportPlugin ( )

overridedefault

Member Function Documentation

finalize()

int openswmm::DefaultReportPlugin::finalize ( const SimulationContext &  ctx )

overridevirtual

Flush and close report file(s).

Parameters

ctx	Final simulation context.

Returns

0 on success.

Postcondition

state() == PluginState::FINALIZED on success.

Implements openswmm::IReportPlugin.

initialize()

int openswmm::DefaultReportPlugin::initialize ( const std::vector< std::string > &  init_args, const IPluginComponentInfo *  info  )

override

last_error_message()

const char * openswmm::DefaultReportPlugin::last_error_message ( ) const

inlineoverridevirtualnoexcept

Get the last error message.

Reimplemented from openswmm::IReportPlugin.

prepare()

int openswmm::DefaultReportPlugin::prepare ( const SimulationContext &  ctx )

overridevirtual

Open report file(s) and write any headers.

Parameters

ctx	Simulation context.

Returns

0 on success.

Postcondition

state() == PluginState::PREPARED on success.

Implements openswmm::IReportPlugin.

state()

PluginState openswmm::DefaultReportPlugin::state ( ) const

inlineoverridevirtualnoexcept

Query the current plugin state.

Implements openswmm::IReportPlugin.

update()

int openswmm::DefaultReportPlugin::update ( const SimulationSnapshot &  snapshot )

overridevirtual

Accumulate data from one output step. Called from IO thread.

This is optional — some report plugins only use write_summary() and do nothing in update(). The default implementation is a no-op.

Parameters

snapshot

Read-only simulation state at this output time step.

Returns

0 on success.

Reimplemented from openswmm::IReportPlugin.

validate()

int openswmm::DefaultReportPlugin::validate ( const SimulationContext &  ctx )

overridevirtual

Validate configuration against the loaded model.

Parameters

ctx	Simulation context (after input parsing).

Returns

0 on success.

Postcondition

state() == PluginState::VALIDATED on success.

Implements openswmm::IReportPlugin.

write_summary()

int openswmm::DefaultReportPlugin::write_summary ( const SimulationContext &  ctx )

overridevirtual

Write the summary statistics table to the .rpt file.

Implements openswmm::IReportPlugin.

Here is the call graph for this function:

---

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

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