SWMMLinkPropertyAdapter Class Reference

#include <swmmlinkpropertyadapter.h>

Inheritance diagram for SWMMLinkPropertyAdapter:

Collaboration diagram for SWMMLinkPropertyAdapter:

Public Types
enum	LinkKind {   Conduit = 0 ,   Pump = 1 ,   Orifice = 2 ,   Weir = 3 ,   Outlet = 4 }
enum	FlapGate {   NO = 0 ,   YES = 1 }
enum	PumpInitState {   OFF = 0 ,   ON = 1 }
enum	OrificeType {   SIDE = 0 ,   BOTTOM = 1 }
enum	WeirType {   TRANSVERSE = 0 ,   SIDEFLOW = 1 ,   VNOTCH = 2 ,   TRAPEZOIDAL = 3 ,   ROADWAY = 4 }
enum	OutletRatingType {   FUNCTIONAL_HEAD = 0 ,   FUNCTIONAL_DEPTH = 1 ,   TABULAR_HEAD = 2 ,   TABULAR_DEPTH = 3 }

Public Slots
void	setName (const QString &newName)
void	setTag (const QString &t)
	Slice SA.
void	setLength (double v)
void	setRoughness (double v)
void	setOffsetUp (double v)
void	setOffsetDn (double v)
void	setCrestHeight (double v)
void	setDischargeCoeff (double v)
void	setEndContractions (double v)
void	setFlapGate (FlapGate v)
void	setPumpInitState (PumpInitState v)
void	setOrificeType (OrificeType v)
	Slice SD partial.
void	setWeirType (WeirType v)
	Slice SD partial.
void	setOutletRatingType (OutletRatingType v)
	Slice SD partial.
void	setOutletExpon (double v)
	Slice SD partial.
void	setPumpStartupDepth (double v)
	BN-LINK-05.
void	setPumpShutoffDepth (double v)
	BN-LINK-05.
void	setOrificeOpenCloseRate (double v)
	BN-LINK-06.
void	setInitialFlow (double v)
void	setMaxFlow (double v)
void	setLossInlet (double v)
void	setLossOutlet (double v)
void	setLossAvg (double v)
void	setSeepRate (double v)
void	setBarrels (int v)
void	setXsectGeom1 (double v)
void	setXsectGeom2 (double v)
void	setXsectGeom3 (double v)
void	setXsectGeom4 (double v)
void	setPumpCurveRef (const DataObjectRef &ref)
void	setXsectionRef (const LinkCompoundEditRef &)
void	setUserFlagsRef (const UserFlagsEditRef &)
void	setInitialQualityRef (const InitialQualityEditRef &)
void	setCulvertCodeRef (const CulvertCodeRef &)
void	setInletUsageRef (const LinkCompoundEditRef &)
void	refresh ()
void	updateStoredName (const QString &newName)
void	setStatsRegistry (openswmmvis::OutputStatsRegistry *registry)
void	setStatsSource (const QUuid &id)
QUuid	statsSourceId () const

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

Public Member Functions
	SWMMLinkPropertyAdapter (SWMM_Engine engine, QString name, QObject *parent=nullptr)
void	setModelLayer (SWMMModelLayer *layer)
SWMMModelLayer *	modelLayer () const
QString	name () const
LinkKind	linkKind () const
QString	fromNode () const
QString	toNode () const
QString	tag () const
	Slice SA — [TAGS] value.
double	length () const
double	roughness () const
double	offsetUp () const
double	offsetDn () const
double	crestHeight () const
double	dischargeCoeff () const
double	endContractions () const
FlapGate	flapGate () const
PumpInitState	pumpInitState () const
QString	pumpCurveName () const
OrificeType	orificeType () const
	Slice SD partial.
WeirType	weirType () const
	Slice SD partial.
OutletRatingType	outletRatingType () const
	Slice SD partial.
double	outletExpon () const
	Slice SD partial.
double	pumpStartupDepth () const
	BN-LINK-05.
double	pumpShutoffDepth () const
	BN-LINK-05.
double	orificeOpenCloseRate () const
	BN-LINK-06.
double	initialFlow () const
	BN-LINK-01a getter.
double	maxFlow () const
	BN-LINK-01b getter.
double	lossInlet () const
	swmm_link_get_loss_coeff[inlet]
double	lossOutlet () const
	swmm_link_get_loss_coeff[outlet]
double	lossAvg () const
	swmm_link_get_loss_coeff[avg]
double	seepRate () const
	swmm_link_get_seep_rate
int	barrels () const
	swmm_link_get_barrels
int	xsectShapeId () const
	current SWMM_XSECT_* id
double	xsectGeom1 () const
double	xsectGeom2 () const
double	xsectGeom3 () const
double	xsectGeom4 () const
double	statMaxFlow () const
double	statMaxVelocity () const
double	statMaxFilling () const
double	statVolFlow () const
double	statSurchargeTime () const
double	statPumpCycles () const
double	statPumpOnTime () const
double	statPumpVolume () const
DataObjectRef	pumpCurveRef () const
LinkCompoundEditRef	xsectionRef () const
LinkCompoundEditRef	inletUsageRef () const
CulvertCodeRef	culvertCodeRef () const
UserFlagsEditRef	userFlagsRef () const
InitialQualityEditRef	initialQualityRef () const
Q_INVOKABLE QString	displayLabelFor (const QString &property) const

Protected Member Functions
int	linkIdx () const
void	writeXsectGeom (int ordinal, double v)

Protected Attributes
SWMM_Engine	m_engine
QString	m_name
SWMMModelLayer *	m_layer = nullptr
	Bound via setModelLayer.
QUuid	m_statsSourceId
	Stats-source dispatch state — see SWMMNodePropertyAdapter.
openswmmvis::OutputStatsRegistry *	m_statsRegistry = nullptr

Properties
QString	name
LinkKind	linkKind
QString	fromNode
QString	toNode
QString	tag

Detailed Description

Base link adapter — exposes the attributes that ALL link types share (name, kind, endpoints). Per-type Q_PROPERTYs live on subclasses below so the Property Browser only shows attributes applicable to the identified link's kind.

Member Enumeration Documentation

FlapGate

enum SWMMLinkPropertyAdapter::FlapGate

Enumerator
NO
YES

LinkKind

enum SWMMLinkPropertyAdapter::LinkKind

Type-safe enums declared with Q_ENUM so QPropertyModel renders the key name ("CONDUIT", "ON", "TRANSVERSE") instead of the raw integer. Subclasses inherit these via metaObject() — no need to redeclare.

Enumerator
Conduit
Pump
Orifice
Weir
Outlet

OrificeType

enum SWMMLinkPropertyAdapter::OrificeType

Enumerator
SIDE
BOTTOM

OutletRatingType

enum SWMMLinkPropertyAdapter::OutletRatingType

Enumerator
FUNCTIONAL_HEAD
FUNCTIONAL_DEPTH
TABULAR_HEAD
TABULAR_DEPTH

PumpInitState

enum SWMMLinkPropertyAdapter::PumpInitState

Enumerator
OFF
ON

WeirType

enum SWMMLinkPropertyAdapter::WeirType

Enumerator
TRANSVERSE
SIDEFLOW
VNOTCH
TRAPEZOIDAL
ROADWAY

Constructor & Destructor Documentation

SWMMLinkPropertyAdapter()

SWMMLinkPropertyAdapter::SWMMLinkPropertyAdapter	(	SWMM_Engine	engine,
		QString	name,
		QObject *	parent = nullptr
	)

Here is the call graph for this function:

Member Function Documentation

barrels()

int SWMMLinkPropertyAdapter::barrels

(

)

const

swmm_link_get_barrels

Here is the call graph for this function:

changed

void SWMMLinkPropertyAdapter::changed ( )

signal

Here is the caller graph for this function:

crestHeight()

double SWMMLinkPropertyAdapter::crestHeight

(

)

const

culvertCodeRef()

CulvertCodeRef SWMMLinkPropertyAdapter::culvertCodeRef

(

)

const

ATTRIBUTE_EDITOR_WIRING Phase 0 — culvert code is a single HDS-5 enum value, edited inline via CulvertCodeComboBox (no separate dialog).

Here is the call graph for this function:

dischargeCoeff()

double SWMMLinkPropertyAdapter::dischargeCoeff

(

)

const

displayLabelFor()

QString SWMMLinkPropertyAdapter::displayLabelFor

(

const QString &

property

)

const

See SWMMNodePropertyAdapter::displayLabelFor — same contract, returns "" for unknown property names.

Here is the call graph for this function:

displayLabelsChanged

void SWMMLinkPropertyAdapter::displayLabelsChanged ( )

signal

See SWMMNodePropertyAdapter::displayLabelsChanged.

Here is the caller graph for this function:

endContractions()

double SWMMLinkPropertyAdapter::endContractions

(

)

const

flapGate()

SWMMLinkPropertyAdapter::FlapGate SWMMLinkPropertyAdapter::flapGate

(

)

const

Here is the call graph for this function:

fromNode()

QString SWMMLinkPropertyAdapter::fromNode

(

)

const

Here is the call graph for this function:

initialFlow()

double SWMMLinkPropertyAdapter::initialFlow

(

)

const

BN-LINK-01a getter.

initialQualityRef()

InitialQualityEditRef SWMMLinkPropertyAdapter::initialQualityRef

(

)

const

Initial-quality UI round — per-element [INITIAL_QUALITY] overrides row (see SWMMNodePropertyAdapter).

Here is the call graph for this function:

inletUsageRef()

LinkCompoundEditRef SWMMLinkPropertyAdapter::inletUsageRef

(

)

const

Here is the call graph for this function:

length()

double SWMMLinkPropertyAdapter::length

(

)

const

linkIdx()

int SWMMLinkPropertyAdapter::linkIdx ( ) const

protected

Here is the caller graph for this function:

linkKind()

SWMMLinkPropertyAdapter::LinkKind SWMMLinkPropertyAdapter::linkKind

(

)

const

Here is the call graph for this function:

lossAvg()

double SWMMLinkPropertyAdapter::lossAvg

(

)

const

swmm_link_get_loss_coeff[avg]

Here is the call graph for this function:

lossInlet()

double SWMMLinkPropertyAdapter::lossInlet

(

)

const

swmm_link_get_loss_coeff[inlet]

Here is the call graph for this function:

lossOutlet()

double SWMMLinkPropertyAdapter::lossOutlet

(

)

const

swmm_link_get_loss_coeff[outlet]

Here is the call graph for this function:

maxFlow()

double SWMMLinkPropertyAdapter::maxFlow

(

)

const

BN-LINK-01b getter.

modelLayer()

SWMMModelLayer * SWMMLinkPropertyAdapter::modelLayer ( ) const

inline

name()

QString SWMMLinkPropertyAdapter::name ( ) const

inline

offsetDn()

double SWMMLinkPropertyAdapter::offsetDn

(

)

const

offsetUp()

double SWMMLinkPropertyAdapter::offsetUp

(

)

const

orificeOpenCloseRate()

double SWMMLinkPropertyAdapter::orificeOpenCloseRate

(

)

const

BN-LINK-06.

Here is the call graph for this function:

orificeType()

SWMMLinkPropertyAdapter::OrificeType SWMMLinkPropertyAdapter::orificeType

(

)

const

Slice SD partial.

Here is the call graph for this function:

outletExpon()

double SWMMLinkPropertyAdapter::outletExpon

(

)

const

Slice SD partial.

Here is the call graph for this function:

outletRatingType()

SWMMLinkPropertyAdapter::OutletRatingType SWMMLinkPropertyAdapter::outletRatingType

(

)

const

Slice SD partial.

Here is the call graph for this function:

pumpCurveName()

QString SWMMLinkPropertyAdapter::pumpCurveName

(

)

const

Here is the call graph for this function:

Here is the caller graph for this function:

pumpCurveRef()

DataObjectRef SWMMLinkPropertyAdapter::pumpCurveRef

(

)

const

Slice BM.0-Browse-Edit — DataObjectRef-typed accessor for the pump curve, used by the Q_PROPERTY on SWMMPumpPropertyAdapter. Constructs the ref with kind=AnyCurve (pump curves accept several engine curve types). Empty currentName means no curve is assigned yet (the engine returns curveIdx == -1).

Here is the call graph for this function:

pumpInitState()

SWMMLinkPropertyAdapter::PumpInitState SWMMLinkPropertyAdapter::pumpInitState

(

)

const

Here is the call graph for this function:

pumpShutoffDepth()

double SWMMLinkPropertyAdapter::pumpShutoffDepth

(

)

const

BN-LINK-05.

Here is the call graph for this function:

pumpStartupDepth()

double SWMMLinkPropertyAdapter::pumpStartupDepth

(

)

const

BN-LINK-05.

Here is the call graph for this function:

refresh

void SWMMLinkPropertyAdapter::refresh ( )

inlineslot

Round-4 follow-up — see SWMMNodePropertyAdapter::refresh.

Here is the call graph for this function:

renameRequested

void SWMMLinkPropertyAdapter::renameRequested ( const QString &  oldName, const QString &  newName  )

signal

Here is the caller graph for this function:

roughness()

double SWMMLinkPropertyAdapter::roughness

(

)

const

seepRate()

double SWMMLinkPropertyAdapter::seepRate

(

)

const

swmm_link_get_seep_rate

setBarrels

void SWMMLinkPropertyAdapter::setBarrels ( int  v )

slot

Here is the call graph for this function:

setCrestHeight

void SWMMLinkPropertyAdapter::setCrestHeight ( double  v )

slot

setCulvertCodeRef

void SWMMLinkPropertyAdapter::setCulvertCodeRef ( const CulvertCodeRef &  )

inlineslot

Here is the call graph for this function:

setDischargeCoeff

void SWMMLinkPropertyAdapter::setDischargeCoeff ( double  v )

slot

setEndContractions

void SWMMLinkPropertyAdapter::setEndContractions ( double  v )

slot

setFlapGate

void SWMMLinkPropertyAdapter::setFlapGate ( FlapGate  v )

slot

Here is the call graph for this function:

setInitialFlow

void SWMMLinkPropertyAdapter::setInitialFlow ( double  v )

slot

setInitialQualityRef

void SWMMLinkPropertyAdapter::setInitialQualityRef ( const InitialQualityEditRef &  )

inlineslot

Here is the call graph for this function:

setInletUsageRef

void SWMMLinkPropertyAdapter::setInletUsageRef ( const LinkCompoundEditRef &  )

inlineslot

Here is the call graph for this function:

setLength

void SWMMLinkPropertyAdapter::setLength ( double  v )

slot

setLossAvg

void SWMMLinkPropertyAdapter::setLossAvg ( double  v )

slot

Here is the call graph for this function:

setLossInlet

void SWMMLinkPropertyAdapter::setLossInlet ( double  v )

slot

setLossOutlet

void SWMMLinkPropertyAdapter::setLossOutlet ( double  v )

slot

Here is the call graph for this function:

setMaxFlow

void SWMMLinkPropertyAdapter::setMaxFlow ( double  v )

slot

setModelLayer()

void SWMMLinkPropertyAdapter::setModelLayer ( SWMMModelLayer *  layer )

inline

Slice BM.0-Browse-Edit — bind the active project's model layer so DataObjectRef-typed properties (pumpCurve) can construct refs with the right layer pointer. Mirror of SWMMNodePropertyAdapter::setModelLayer.

setName

void SWMMLinkPropertyAdapter::setName ( const QString &  newName )

slot

Here is the call graph for this function:

setOffsetDn

void SWMMLinkPropertyAdapter::setOffsetDn ( double  v )

slot

setOffsetUp

void SWMMLinkPropertyAdapter::setOffsetUp ( double  v )

slot

setOrificeOpenCloseRate

void SWMMLinkPropertyAdapter::setOrificeOpenCloseRate ( double  v )

slot

BN-LINK-06.

Here is the call graph for this function:

setOrificeType

void SWMMLinkPropertyAdapter::setOrificeType ( OrificeType  v )

slot

Slice SD partial.

Here is the call graph for this function:

setOutletExpon

void SWMMLinkPropertyAdapter::setOutletExpon ( double  v )

slot

Slice SD partial.

Here is the call graph for this function:

setOutletRatingType

void SWMMLinkPropertyAdapter::setOutletRatingType ( OutletRatingType  v )

slot

Slice SD partial.

Here is the call graph for this function:

setPumpCurveRef

void SWMMLinkPropertyAdapter::setPumpCurveRef ( const DataObjectRef &  ref )

slot

Slice BM.0-Browse-Edit — writes the selected curve via swmm_link_set_pump_curve. Looks up the engine curve index from ref.currentName; no-op if empty or unknown.

Here is the call graph for this function:

setPumpInitState

void SWMMLinkPropertyAdapter::setPumpInitState ( PumpInitState  v )

slot

Here is the call graph for this function:

setPumpShutoffDepth

void SWMMLinkPropertyAdapter::setPumpShutoffDepth ( double  v )

slot

BN-LINK-05.

Here is the call graph for this function:

setPumpStartupDepth

void SWMMLinkPropertyAdapter::setPumpStartupDepth ( double  v )

slot

BN-LINK-05.

Here is the call graph for this function:

setRoughness

void SWMMLinkPropertyAdapter::setRoughness ( double  v )

slot

setSeepRate

void SWMMLinkPropertyAdapter::setSeepRate ( double  v )

slot

setStatsRegistry

void SWMMLinkPropertyAdapter::setStatsRegistry ( openswmmvis::OutputStatsRegistry *  registry )

slot

Stats-source dispatch — see SWMMNodePropertyAdapter (Slice QA.2) for the full contract. The stat* getters read the editing engine's ambient stats while the id is null, and the registry-resolved SWMMResultsLayer's linkStat*() accessors otherwise.

Here is the caller graph for this function:

setStatsSource

void SWMMLinkPropertyAdapter::setStatsSource ( const QUuid &  id )

slot

Here is the call graph for this function:

setTag

void SWMMLinkPropertyAdapter::setTag ( const QString &  t )

slot

Slice SA.

Here is the call graph for this function:

setUserFlagsRef

void SWMMLinkPropertyAdapter::setUserFlagsRef ( const UserFlagsEditRef &  )

inlineslot

Here is the call graph for this function:

setWeirType

void SWMMLinkPropertyAdapter::setWeirType ( WeirType  v )

slot

Slice SD partial.

Here is the call graph for this function:

setXsectGeom1

void SWMMLinkPropertyAdapter::setXsectGeom1 ( double  v )

slot

Here is the call graph for this function:

setXsectGeom2

void SWMMLinkPropertyAdapter::setXsectGeom2 ( double  v )

slot

Here is the call graph for this function:

setXsectGeom3

void SWMMLinkPropertyAdapter::setXsectGeom3 ( double  v )

slot

Here is the call graph for this function:

setXsectGeom4

void SWMMLinkPropertyAdapter::setXsectGeom4 ( double  v )

slot

Here is the call graph for this function:

setXsectionRef

void SWMMLinkPropertyAdapter::setXsectionRef ( const LinkCompoundEditRef &  )

inlineslot

Slice SC.1 — Compound-ref write slots. The cell's LinkCompoundEditButton invokes these via the delegate's setModelData round-trip after the dialog closes. The actual engine mutations already happened inside the dialog (the Apply-as-you-go pages route through SWMMModelLayer::applyLinkXsect / _Barrels / _CulvertCode), so these slots are no-ops except for emitting changed() so the property tree (and the attribute table) re-reads its summary. Their existence is what flips QMetaProperty::isWritable() to true, which is what QVariantPropertyItem checks to mark the cell editable — without these, the cell never enters edit mode and the registered LinkCompoundEditButton creator never fires.

Here is the call graph for this function:

statMaxFilling()

double SWMMLinkPropertyAdapter::statMaxFilling

(

)

const

statMaxFlow()

double SWMMLinkPropertyAdapter::statMaxFlow

(

)

const

statMaxVelocity()

double SWMMLinkPropertyAdapter::statMaxVelocity

(

)

const

statPumpCycles()

double SWMMLinkPropertyAdapter::statPumpCycles

(

)

const

statPumpOnTime()

double SWMMLinkPropertyAdapter::statPumpOnTime

(

)

const

statPumpVolume()

double SWMMLinkPropertyAdapter::statPumpVolume

(

)

const

statsSourceId

QUuid SWMMLinkPropertyAdapter::statsSourceId ( ) const

inlineslot

statSurchargeTime()

double SWMMLinkPropertyAdapter::statSurchargeTime

(

)

const

statVolFlow()

double SWMMLinkPropertyAdapter::statVolFlow

(

)

const

tag()

QString SWMMLinkPropertyAdapter::tag

(

)

const

Slice SA — [TAGS] value.

Here is the call graph for this function:

toNode()

QString SWMMLinkPropertyAdapter::toNode

(

)

const

Here is the call graph for this function:

updateStoredName

void SWMMLinkPropertyAdapter::updateStoredName ( const QString &  newName )

inlineslot

See SWMMNodePropertyAdapter::updateStoredName.

userFlagsRef()

UserFlagsEditRef SWMMLinkPropertyAdapter::userFlagsRef

(

)

const

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

Here is the call graph for this function:

weirType()

SWMMLinkPropertyAdapter::WeirType SWMMLinkPropertyAdapter::weirType

(

)

const

Slice SD partial.

Here is the call graph for this function:

writeXsectGeom()

void SWMMLinkPropertyAdapter::writeXsectGeom ( int  ordinal, double  v  )

protected

Read-modify-write one geom (ordinal 1..4) of the xsect tuple; no-op when the geom doesn't apply to the current shape. Emits changed().

Here is the call graph for this function:

Here is the caller graph for this function:

xsectGeom1()

double SWMMLinkPropertyAdapter::xsectGeom1

(

)

const

Here is the call graph for this function:

xsectGeom2()

double SWMMLinkPropertyAdapter::xsectGeom2

(

)

const

Here is the call graph for this function:

xsectGeom3()

double SWMMLinkPropertyAdapter::xsectGeom3

(

)

const

Here is the call graph for this function:

xsectGeom4()

double SWMMLinkPropertyAdapter::xsectGeom4

(

)

const

Here is the call graph for this function:

xsectionRef()

LinkCompoundEditRef SWMMLinkPropertyAdapter::xsectionRef

(

)

const

Slice SC.1 — Compound-attribute refs for the link-side Property Browser cells (cross section / inlet usage). Each builds the engine summary live so the cell shows a useful preview even before the user opens the dialog.

Here is the call graph for this function:

xsectShapeId()

int SWMMLinkPropertyAdapter::xsectShapeId

(

)

const

current SWMM_XSECT_* id

Here is the call graph for this function:

Member Data Documentation

m_engine

SWMM_Engine SWMMLinkPropertyAdapter::m_engine

protected

m_layer

SWMMModelLayer* SWMMLinkPropertyAdapter::m_layer = nullptr

protected

Bound via setModelLayer.

m_name

QString SWMMLinkPropertyAdapter::m_name

protected

m_statsRegistry

openswmmvis::OutputStatsRegistry* SWMMLinkPropertyAdapter::m_statsRegistry = nullptr

protected

m_statsSourceId

QUuid SWMMLinkPropertyAdapter::m_statsSourceId

protected

Stats-source dispatch state — see SWMMNodePropertyAdapter.

Property Documentation

fromNode

QString SWMMLinkPropertyAdapter::fromNode

read

linkKind

LinkKind SWMMLinkPropertyAdapter::linkKind

read

name

QString SWMMLinkPropertyAdapter::name

readwrite

tag

QString SWMMLinkPropertyAdapter::tag

readwrite

Slice SA — Free-form [TAGS] label (mirrors SWMMNodePropertyAdapter::tag). Editable text; index-keyed in the engine, so it survives a rename. Subclasses must declare a matching Q_PROPERTY row to actually expose the field to QPropertyModel — declaring the WRITE+READ pair here keeps QML / scripting clients happy without forcing the inline cell on every link kind.

toNode

QString SWMMLinkPropertyAdapter::toNode

read

---

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

• /home/runner/work/openswmm.gui/openswmm.gui/include/ui/properties/swmmlinkpropertyadapter.h
• /home/runner/work/openswmm.gui/openswmm.gui/src/ui/properties/swmmlinkpropertyadapter.cpp