groundwatersummary.h File Reference

One-line summary of a subcatchment's [GROUNDWATER] / [GWF] configuration, shared by the property browser's Groundwater row, the attribute table's Groundwater column and the GroundwaterExchangeDialog so every surface reads the same text. More...

#include <QString>
#include <openswmm/engine/openswmm_callbacks.h>

Include dependency graph for groundwatersummary.h:

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

Go to the source code of this file.

Functions
QString	groundwaterSummary (SWMM_Engine engine, int subIdx)

Detailed Description

One-line summary of a subcatchment's [GROUNDWATER] / [GWF] configuration, shared by the property browser's Groundwater row, the attribute table's Groundwater column and the GroundwaterExchangeDialog so every surface reads the same text.

Author

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

Date

2026

License\n GPL-3.0-or-later

Function Documentation

groundwaterSummary()

QString groundwaterSummary	(	SWMM_Engine	engine,
		int	subIdx
	)

"(none)" when no aquifer is assigned; otherwise "AQ1 → J12" (or "AQ1 → (no node)"), with " (custom)" appended when either [GWF] expression (LATERAL / DEEP) is non-empty. subIdx < 0 → "(none)".

Here is the caller graph for this function: