SWMMVis  6.0.0-alpha.4
Qt6/C++ GIS-based graphical user interface for the SWMMVis engine (6.0.0-alpha.4)
Loading...
Searching...
No Matches
SWMMSubcatchPropertyAdapter Class Reference

#include <swmmsubcatchpropertyadapter.h>

Inheritance diagram for SWMMSubcatchPropertyAdapter:
Collaboration diagram for SWMMSubcatchPropertyAdapter:

Public Types

enum  InfilModel {
  Horton = 0 ,
  ModHorton = 1 ,
  GreenAmpt = 2 ,
  ModGreenAmpt = 3 ,
  CurveNumber = 4
}
 

Public Slots

void setName (const QString &newName)
 
void setTag (const QString &t)
 
void setArea (double v)
 
void setWidth (double v)
 
void setSlope (double v)
 
void setImpervPct (double v)
 
void setPctZeroImperv (double v)
 
void setNImperv (double v)
 
void setNPerv (double v)
 
void setDsImperv (double v)
 
void setDsPerv (double v)
 
void setRainScaleFactor (double v)
 
void setSnowScaleFactor (double v)
 
void setRainGageRef (const DataObjectRef &r)
 
void setOutletRef (const DataObjectRef &r)
 
void setInfilModel (InfilModel m)
 
void setHortonF0 (double v)
 
void setHortonFmin (double v)
 
void setHortonDecay (double v)
 
void setHortonDryTime (double v)
 
void setGaSuction (double v)
 
void setGaConductivity (double v)
 
void setGaInitDeficit (double v)
 
void setCnNumber (double v)
 
void setCnDryTime (double v)
 
void setAquiferRef (const DataObjectRef &r)
 
void setLandUseRef (const SubcatchCompoundEditRef &)
 
void setGroundwaterRef (const SubcatchCompoundEditRef &)
 
void setLidUsageRef (const SubcatchCompoundEditRef &)
 
void setLoadingsRef (const SubcatchCompoundEditRef &)
 
void setUserFlagsRef (const UserFlagsEditRef &)
 
void refresh ()
 
void updateStoredName (const QString &newName)
 

Signals

void changed ()
 
void renameRequested (const QString &oldName, const QString &newName)
 
void displayLabelsChanged ()
 

Public Member Functions

 SWMMSubcatchPropertyAdapter (SWMM_Engine engine, QString name, QObject *parent=nullptr)
 
void setModelLayer (SWMMModelLayer *layer)
 
SWMMModelLayermodelLayer () const
 
UserFlagsEditRef userFlagsRef () const
 
QString name () const
 
QString tag () const
 
double area () const
 
double width () const
 
double slope () const
 
double impervPct () const
 
double pctZeroImperv () const
 
double nImperv () const
 
double nPerv () const
 
double dsImperv () const
 
double dsPerv () const
 
double rainScaleFactor () const
 
double snowScaleFactor () const
 
DataObjectRef rainGageRef () const
 
DataObjectRef outletRef () const
 
InfilModel infilModel () const
 
double hortonF0 () const
 
double hortonFmin () const
 
double hortonDecay () const
 
double hortonDryTime () const
 
double gaSuction () const
 
double gaConductivity () const
 
double gaInitDeficit () const
 
double cnNumber () const
 
double cnDryTime () const
 
SubcatchCompoundEditRef landUseRef () const
 
DataObjectRef aquiferRef () const
 
SubcatchCompoundEditRef groundwaterRef () const
 
SubcatchCompoundEditRef lidUsageRef () const
 
SubcatchCompoundEditRef loadingsRef () const
 
double statPrecip () const
 
double statRunoffVol () const
 
double statMaxRunoff () const
 
void setStatsRegistry (openswmmvis::OutputStatsRegistry *registry)
 
void setStatsSource (const QUuid &id)
 
QUuid statsSourceId () const
 
Q_INVOKABLE QString displayLabelFor (const QString &property) const
 

Properties

QString name
 
QString tag
 
double area
 
double width
 
double slope
 
double impervPct
 
double pctZeroImperv
 
double nImperv
 
double nPerv
 
double dsImperv
 
double dsPerv
 
double rainScaleFactor
 
double snowScaleFactor
 
DataObjectRef rainGage
 
DataObjectRef outlet
 
InfilModel infilModel
 
double hortonF0
 
double hortonFmin
 
double hortonDecay
 
double hortonDryTime
 
double gaSuction
 
double gaConductivity
 
double gaInitDeficit
 
double cnNumber
 
double cnDryTime
 
SubcatchCompoundEditRef landUse
 
DataObjectRef aquifer
 
SubcatchCompoundEditRef groundwater
 
SubcatchCompoundEditRef lidUsage
 
SubcatchCompoundEditRef loadings
 
UserFlagsEditRef userFlags
 
double statPrecip
 
double statRunoffVol
 
double statMaxRunoff
 

Member Enumeration Documentation

◆ InfilModel

Infiltration model codes (engine [INFILTRATION] order).

Enumerator
Horton 
ModHorton 
GreenAmpt 
ModGreenAmpt 
CurveNumber 

Constructor & Destructor Documentation

◆ SWMMSubcatchPropertyAdapter()

SWMMSubcatchPropertyAdapter::SWMMSubcatchPropertyAdapter ( SWMM_Engine  engine,
QString  name,
QObject *  parent = nullptr 
)
Here is the call graph for this function:

Member Function Documentation

◆ aquiferRef()

DataObjectRef SWMMSubcatchPropertyAdapter::aquiferRef ( ) const

◆ area()

double SWMMSubcatchPropertyAdapter::area ( ) const

◆ changed

void SWMMSubcatchPropertyAdapter::changed ( )
signal
Here is the caller graph for this function:

◆ cnDryTime()

double SWMMSubcatchPropertyAdapter::cnDryTime ( ) const

◆ cnNumber()

double SWMMSubcatchPropertyAdapter::cnNumber ( ) const

◆ displayLabelFor()

QString SWMMSubcatchPropertyAdapter::displayLabelFor ( const QString &  property) const

See SWMMNodePropertyAdapter::displayLabelFor.

Here is the call graph for this function:

◆ displayLabelsChanged

void SWMMSubcatchPropertyAdapter::displayLabelsChanged ( )
signal

See SWMMNodePropertyAdapter::displayLabelsChanged.

Here is the caller graph for this function:

◆ dsImperv()

double SWMMSubcatchPropertyAdapter::dsImperv ( ) const

◆ dsPerv()

double SWMMSubcatchPropertyAdapter::dsPerv ( ) const

◆ gaConductivity()

double SWMMSubcatchPropertyAdapter::gaConductivity ( ) const

◆ gaInitDeficit()

double SWMMSubcatchPropertyAdapter::gaInitDeficit ( ) const

◆ gaSuction()

double SWMMSubcatchPropertyAdapter::gaSuction ( ) const

◆ groundwaterRef()

SubcatchCompoundEditRef SWMMSubcatchPropertyAdapter::groundwaterRef ( ) const
Here is the call graph for this function:

◆ hortonDecay()

double SWMMSubcatchPropertyAdapter::hortonDecay ( ) const

◆ hortonDryTime()

double SWMMSubcatchPropertyAdapter::hortonDryTime ( ) const

◆ hortonF0()

double SWMMSubcatchPropertyAdapter::hortonF0 ( ) const

◆ hortonFmin()

double SWMMSubcatchPropertyAdapter::hortonFmin ( ) const

◆ impervPct()

double SWMMSubcatchPropertyAdapter::impervPct ( ) const

◆ infilModel()

SWMMSubcatchPropertyAdapter::InfilModel SWMMSubcatchPropertyAdapter::infilModel ( ) const

◆ landUseRef()

SubcatchCompoundEditRef SWMMSubcatchPropertyAdapter::landUseRef ( ) const

◆ lidUsageRef()

SubcatchCompoundEditRef SWMMSubcatchPropertyAdapter::lidUsageRef ( ) const

◆ loadingsRef()

SubcatchCompoundEditRef SWMMSubcatchPropertyAdapter::loadingsRef ( ) const

◆ modelLayer()

SWMMModelLayer * SWMMSubcatchPropertyAdapter::modelLayer ( ) const
inline

◆ name()

QString SWMMSubcatchPropertyAdapter::name ( ) const
inline

◆ nImperv()

double SWMMSubcatchPropertyAdapter::nImperv ( ) const

◆ nPerv()

double SWMMSubcatchPropertyAdapter::nPerv ( ) const

◆ outletRef()

DataObjectRef SWMMSubcatchPropertyAdapter::outletRef ( ) const

◆ pctZeroImperv()

double SWMMSubcatchPropertyAdapter::pctZeroImperv ( ) const

◆ rainGageRef()

DataObjectRef SWMMSubcatchPropertyAdapter::rainGageRef ( ) const

◆ rainScaleFactor()

double SWMMSubcatchPropertyAdapter::rainScaleFactor ( ) const

◆ refresh

void SWMMSubcatchPropertyAdapter::refresh ( )
inlineslot

Round-4 follow-up 2026-05-12 — see SWMMNodePropertyAdapter::refresh.

Here is the call graph for this function:

◆ renameRequested

void SWMMSubcatchPropertyAdapter::renameRequested ( const QString &  oldName,
const QString &  newName 
)
signal
Here is the caller graph for this function:

◆ setAquiferRef

void SWMMSubcatchPropertyAdapter::setAquiferRef ( const DataObjectRef r)
slot
Here is the call graph for this function:

◆ setArea

void SWMMSubcatchPropertyAdapter::setArea ( double  v)
slot

◆ setCnDryTime

void SWMMSubcatchPropertyAdapter::setCnDryTime ( double  v)
slot

◆ setCnNumber

void SWMMSubcatchPropertyAdapter::setCnNumber ( double  v)
slot

◆ setDsImperv

void SWMMSubcatchPropertyAdapter::setDsImperv ( double  v)
slot

◆ setDsPerv

void SWMMSubcatchPropertyAdapter::setDsPerv ( double  v)
slot

◆ setGaConductivity

void SWMMSubcatchPropertyAdapter::setGaConductivity ( double  v)
slot
Here is the call graph for this function:

◆ setGaInitDeficit

void SWMMSubcatchPropertyAdapter::setGaInitDeficit ( double  v)
slot
Here is the call graph for this function:

◆ setGaSuction

void SWMMSubcatchPropertyAdapter::setGaSuction ( double  v)
slot
Here is the call graph for this function:

◆ setGroundwaterRef

void SWMMSubcatchPropertyAdapter::setGroundwaterRef ( const SubcatchCompoundEditRef )
inlineslot
Here is the call graph for this function:

◆ setHortonDecay

void SWMMSubcatchPropertyAdapter::setHortonDecay ( double  v)
slot
Here is the call graph for this function:

◆ setHortonDryTime

void SWMMSubcatchPropertyAdapter::setHortonDryTime ( double  v)
slot
Here is the call graph for this function:

◆ setHortonF0

void SWMMSubcatchPropertyAdapter::setHortonF0 ( double  v)
slot
Here is the call graph for this function:

◆ setHortonFmin

void SWMMSubcatchPropertyAdapter::setHortonFmin ( double  v)
slot
Here is the call graph for this function:

◆ setImpervPct

void SWMMSubcatchPropertyAdapter::setImpervPct ( double  v)
slot

◆ setInfilModel

void SWMMSubcatchPropertyAdapter::setInfilModel ( InfilModel  m)
slot
Here is the call graph for this function:

◆ setLandUseRef

void SWMMSubcatchPropertyAdapter::setLandUseRef ( const SubcatchCompoundEditRef )
inlineslot
Here is the call graph for this function:

◆ setLidUsageRef

void SWMMSubcatchPropertyAdapter::setLidUsageRef ( const SubcatchCompoundEditRef )
inlineslot
Here is the call graph for this function:

◆ setLoadingsRef

void SWMMSubcatchPropertyAdapter::setLoadingsRef ( const SubcatchCompoundEditRef )
inlineslot
Here is the call graph for this function:

◆ setModelLayer()

void SWMMSubcatchPropertyAdapter::setModelLayer ( SWMMModelLayer layer)
inline

USER_FLAGS Phase 4 — bind the owning layer so userFlagsRef() can reach the shared UserFlagsModel (mirror of SWMMNodePropertyAdapter::setModelLayer; nullptr-safe).

◆ setName

void SWMMSubcatchPropertyAdapter::setName ( const QString &  newName)
slot
Here is the call graph for this function:

◆ setNImperv

void SWMMSubcatchPropertyAdapter::setNImperv ( double  v)
slot

◆ setNPerv

void SWMMSubcatchPropertyAdapter::setNPerv ( double  v)
slot

◆ setOutletRef

void SWMMSubcatchPropertyAdapter::setOutletRef ( const DataObjectRef r)
slot
Here is the call graph for this function:

◆ setPctZeroImperv

void SWMMSubcatchPropertyAdapter::setPctZeroImperv ( double  v)
slot

◆ setRainGageRef

void SWMMSubcatchPropertyAdapter::setRainGageRef ( const DataObjectRef r)
slot
Here is the call graph for this function:

◆ setRainScaleFactor

void SWMMSubcatchPropertyAdapter::setRainScaleFactor ( double  v)
slot

◆ setSlope

void SWMMSubcatchPropertyAdapter::setSlope ( double  v)
slot

◆ setSnowScaleFactor

void SWMMSubcatchPropertyAdapter::setSnowScaleFactor ( double  v)
slot
Here is the call graph for this function:

◆ setStatsRegistry()

void SWMMSubcatchPropertyAdapter::setStatsRegistry ( openswmmvis::OutputStatsRegistry registry)

Stats-source dispatch — see SWMMNodePropertyAdapter (Slice QA.2) for the full contract.

Here is the caller graph for this function:

◆ setStatsSource()

void SWMMSubcatchPropertyAdapter::setStatsSource ( const QUuid &  id)
Here is the call graph for this function:

◆ setTag

void SWMMSubcatchPropertyAdapter::setTag ( const QString &  t)
slot
Here is the call graph for this function:

◆ setUserFlagsRef

void SWMMSubcatchPropertyAdapter::setUserFlagsRef ( const UserFlagsEditRef )
inlineslot
Here is the call graph for this function:

◆ setWidth

void SWMMSubcatchPropertyAdapter::setWidth ( double  v)
slot

◆ slope()

double SWMMSubcatchPropertyAdapter::slope ( ) const

◆ snowScaleFactor()

double SWMMSubcatchPropertyAdapter::snowScaleFactor ( ) const

◆ statMaxRunoff()

double SWMMSubcatchPropertyAdapter::statMaxRunoff ( ) const

◆ statPrecip()

double SWMMSubcatchPropertyAdapter::statPrecip ( ) const

◆ statRunoffVol()

double SWMMSubcatchPropertyAdapter::statRunoffVol ( ) const

◆ statsSourceId()

QUuid SWMMSubcatchPropertyAdapter::statsSourceId ( ) const
inline

◆ tag()

QString SWMMSubcatchPropertyAdapter::tag ( ) const

◆ updateStoredName

void SWMMSubcatchPropertyAdapter::updateStoredName ( const QString &  newName)
inlineslot

◆ userFlagsRef()

UserFlagsEditRef SWMMSubcatchPropertyAdapter::userFlagsRef ( ) const
Here is the call graph for this function:

◆ width()

double SWMMSubcatchPropertyAdapter::width ( ) const

Property Documentation

◆ aquifer

DataObjectRef SWMMSubcatchPropertyAdapter::aquifer
readwrite

Receiving aquifer ([GROUNDWATER] aquifer column). Picker over [AQUIFERS] names; an empty pick clears the assignment (-1). The routing parameters live in the groundwater exchange editor.

◆ area

double SWMMSubcatchPropertyAdapter::area
readwrite

◆ cnDryTime

double SWMMSubcatchPropertyAdapter::cnDryTime
readwrite

◆ cnNumber

double SWMMSubcatchPropertyAdapter::cnNumber
readwrite

◆ dsImperv

double SWMMSubcatchPropertyAdapter::dsImperv
readwrite

◆ dsPerv

double SWMMSubcatchPropertyAdapter::dsPerv
readwrite

◆ gaConductivity

double SWMMSubcatchPropertyAdapter::gaConductivity
readwrite

◆ gaInitDeficit

double SWMMSubcatchPropertyAdapter::gaInitDeficit
readwrite

◆ gaSuction

double SWMMSubcatchPropertyAdapter::gaSuction
readwrite

◆ groundwater

SubcatchCompoundEditRef SWMMSubcatchPropertyAdapter::groundwater
readwrite

◆ hortonDecay

double SWMMSubcatchPropertyAdapter::hortonDecay
readwrite

◆ hortonDryTime

double SWMMSubcatchPropertyAdapter::hortonDryTime
readwrite

◆ hortonF0

double SWMMSubcatchPropertyAdapter::hortonF0
readwrite

◆ hortonFmin

double SWMMSubcatchPropertyAdapter::hortonFmin
readwrite

◆ impervPct

double SWMMSubcatchPropertyAdapter::impervPct
readwrite

◆ infilModel

InfilModel SWMMSubcatchPropertyAdapter::infilModel
readwrite

Infiltration model (Horton / Mod-Horton / Green-Ampt / Mod-GA / CN).

◆ landUse

SubcatchCompoundEditRef SWMMSubcatchPropertyAdapter::landUse
readwrite

◆ lidUsage

SubcatchCompoundEditRef SWMMSubcatchPropertyAdapter::lidUsage
readwrite

◆ loadings

SubcatchCompoundEditRef SWMMSubcatchPropertyAdapter::loadings
readwrite

◆ name

QString SWMMSubcatchPropertyAdapter::name
readwrite

◆ nImperv

double SWMMSubcatchPropertyAdapter::nImperv
readwrite

◆ nPerv

double SWMMSubcatchPropertyAdapter::nPerv
readwrite

◆ outlet

DataObjectRef SWMMSubcatchPropertyAdapter::outlet
readwrite

Outlet target — a node OR another subcatchment (cascade). Combined picker; the WRITE slot resolves the name to the right engine call.

◆ pctZeroImperv

double SWMMSubcatchPropertyAdapter::pctZeroImperv
readwrite

◆ rainGage

DataObjectRef SWMMSubcatchPropertyAdapter::rainGage
readwrite

Rain gage assignment (R3 picker over gage names).

◆ rainScaleFactor

double SWMMSubcatchPropertyAdapter::rainScaleFactor
readwrite

Subcatchment rainfall scale factor — optional token 9 of [SUBCATCHMENTS]. Multiplies gage-derived rainfall for this subcatchment only, composing multiplicatively with the gage's own scale factor. Must be > 0; default 1.0 (no scaling).

◆ slope

double SWMMSubcatchPropertyAdapter::slope
readwrite

◆ snowScaleFactor

double SWMMSubcatchPropertyAdapter::snowScaleFactor
readwrite

Subcatchment snowfall scale factor — optional token 10 of [SUBCATCHMENTS]. Composes with the gage snow catch factor (SCF): SCF corrects the physical gage's snow-catch deficiency, this represents spatial variation across the catchment. Must be > 0; default 1.0.

◆ statMaxRunoff

double SWMMSubcatchPropertyAdapter::statMaxRunoff
read

◆ statPrecip

double SWMMSubcatchPropertyAdapter::statPrecip
read

◆ statRunoffVol

double SWMMSubcatchPropertyAdapter::statRunoffVol
read

◆ tag

QString SWMMSubcatchPropertyAdapter::tag
readwrite

Slice TA — free-form [TAGS] label. Direct engine read/write (mirror of node/link tag wiring); the existing changed() signal + PropertiesPanel.objectEdited fan-out is sufficient for two-way sync with the Attribute Table since tag changes don't affect map symbology or attribute-table layout.

◆ userFlags

UserFlagsEditRef SWMMSubcatchPropertyAdapter::userFlags
readwrite

Phase 4 of docs/USER_FLAGS_UI_PLAN_2026-06-03.md — per-object user-flag assignments row (see SWMMNodePropertyAdapter).

◆ width

double SWMMSubcatchPropertyAdapter::width
readwrite

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