#include <swmmnodepropertyadapter.h>

Inheritance diagram for SWMMInletJunctionPropertyAdapter:

Collaboration diagram for SWMMInletJunctionPropertyAdapter:

Public Member Functions
	SWMMInletJunctionPropertyAdapter (SWMM_Engine engine, QString name, QObject *parent=nullptr)

Public Member Functions inherited from SWMMVirtualJunctionPropertyAdapter
	SWMMNodePropertyAdapter (SWMM_Engine engine, QString name, QObject *parent=nullptr)

Public Member Functions inherited from SWMMNodePropertyAdapter
	SWMMNodePropertyAdapter (SWMM_Engine engine, QString name, QObject *parent=nullptr)

void	setModelLayer (SWMMModelLayer *layer)

SWMMModelLayer *	modelLayer () const

QString	name () const

NodeKind	nodeKind () const

QString	tag () const

double	invertElev () const

double	maxDepth () const

double	rimDepth () const

double	initialDepth () const

double	surchargeDepth () const

double	pondedArea () const

double	seepRate () const

double	xCoord () const

double	yCoord () const

OutfallType	outfallType () const

FlapGate	outfallFlapGate () const

DividerType	dividerType () const

double	crownElev () const

double	fullVolume () const

int	degree () const

double	statMaxDepth () const

double	statMaxOverflow () const

double	statVolFlooded () const

double	statTimeFlooded () const

NodeCompoundEditRef	inflowsRef () const

NodeCompoundEditRef	dwfRef () const

NodeCompoundEditRef	rdiiRef () const

NodeCompoundEditRef	treatmentRef () const

NodeCompoundEditRef	groundwaterSourcesRef () const

UserFlagsEditRef	userFlagsRef () const

InitialQualityEditRef	initialQualityRef () const

double	outfallStage () const

DataObjectRef	outfallTidalCurveRef () const

DataObjectRef	outfallTimeseriesRef () const

DataObjectRef	inletDesignRef () const

DataObjectRef	captureNodeRef () const

int	numInlets () const

double	pctClogged () const

double	flowRestriction () const

double	depressionHeight () const

double	depressionWidth () const

InletPlacement	placement () const

QString	approachStreet () const

StorageShape	storageShape () const

DataObjectRef	storageCurveRef () const

double	storageCoeffA () const

double	storageExpB () const

double	storageConstC () const

double	storageParam1 () const

double	storageParam2 () const

double	storageParam3 () const

Q_INVOKABLE QString	displayLabelFor (const QString &property) const

Properties
DataObjectRef	inletDesign

DataObjectRef	captureNode

int	numInlets

double	pctClogged

double	flowRestriction

double	depressionHeight

double	depressionWidth

SWMMNodePropertyAdapter::InletPlacement	placement

QString	approachStreet

Properties inherited from SWMMVirtualJunctionPropertyAdapter
double	rimDepth

double	crownElev

int	degree

double	statMaxDepth

NodeCompoundEditRef	inflows

NodeCompoundEditRef	dwf

NodeCompoundEditRef	rdii

NodeCompoundEditRef	treatment

NodeCompoundEditRef	groundwaterSources

UserFlagsEditRef	userFlags

Properties inherited from SWMMNodePropertyAdapter
QString	name

NodeKind	nodeKind

double	invertElev

QString	tag

double	xCoord

double	yCoord

Additional Inherited Members
Public Types inherited from SWMMNodePropertyAdapter
enum	NodeKind { Junction = 0 , Outfall = 1 , Storage = 2 , Divider = 3 , VirtualJunction = 4 , InletJunction = 5 }

enum	OutfallType { FREE = 0 , NORMAL = 1 , FIXED = 2 , TIDAL = 3 , TIMESERIES = 4 }

enum	DividerType { CUTOFF = 0 , OVERFLOW_ = 1 , TABULAR = 2 , WEIR = 3 }

enum	FlapGate { NO = 0 , YES = 1 }

enum	InletPlacement { AUTOMATIC = 0 , ON_GRADE = 1 , ON_SAG = 2 }

enum	StorageShape { Tabular = 0 , Functional = 1 , Cylindrical = 2 , Conical = 3 , Paraboloid = 4 , Pyramidal = 5 }

Public Slots inherited from SWMMNodePropertyAdapter
void	setName (const QString &newName)

void	setTag (const QString &t)

void	setInvertElev (double v)

void	setMaxDepth (double v)

void	setRimDepth (double v)

void	setInitialDepth (double v)

void	setSurchargeDepth (double v)

void	setPondedArea (double v)

void	setSeepRate (double v)

void	setXCoord (double v)

void	setYCoord (double v)

void	setOutfallType (OutfallType v)

void	setOutfallFlapGate (FlapGate v)

void	setDividerType (DividerType v)

void	setInflowsRef (const NodeCompoundEditRef &)

void	setDwfRef (const NodeCompoundEditRef &)

void	setRdiiRef (const NodeCompoundEditRef &)

void	setTreatmentRef (const NodeCompoundEditRef &)

void	setGroundwaterSourcesRef (const NodeCompoundEditRef &)

void	setUserFlagsRef (const UserFlagsEditRef &)

void	setInitialQualityRef (const InitialQualityEditRef &)

void	setOutfallStage (double v)

void	setOutfallTidalCurveRef (const DataObjectRef &r)

void	setOutfallTimeseriesRef (const DataObjectRef &r)

void	setInletDesignRef (const DataObjectRef &r)

void	setCaptureNodeRef (const DataObjectRef &r)

void	setNumInlets (int v)

void	setPctClogged (double v)

void	setFlowRestriction (double v)

void	setDepressionHeight (double v)

void	setDepressionWidth (double v)

void	setPlacement (InletPlacement v)

void	setStorageShape (StorageShape v)

void	setStorageCurveRef (const DataObjectRef &r)

void	setStorageCoeffA (double v)

void	setStorageExpB (double v)

void	setStorageConstC (double v)

void	setStorageParam1 (double v)

void	setStorageParam2 (double v)

void	setStorageParam3 (double v)

void	refresh ()

void	updateStoredName (const QString &newName)

void	setStatsRegistry (openswmmvis::OutputStatsRegistry *registry)

void	setStatsSource (const QUuid &id)

QUuid	statsSourceId () const

Signals inherited from SWMMNodePropertyAdapter
void	changed ()

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

void	coordChangeRequested (double newX, double newY)

void	displayLabelsChanged ()

Protected Member Functions inherited from SWMMNodePropertyAdapter
int	nodeIdx () const

void	writeInletUsage (const std::function< bool(SWMM_InletUsage &)> &mutate)

Protected Attributes inherited from SWMMNodePropertyAdapter
SWMM_Engine	m_engine

QString	m_name

SWMMModelLayer *	m_layer = nullptr
	DB.4c — for compound-cell pickers.

QUuid	m_statsSourceId

openswmmvis::OutputStatsRegistry *	m_statsRegistry = nullptr

Detailed Description

Inlet-junction adapter — a virtual junction that additionally owns one [INLET_USAGE] row (host_kind = node). It inherits the whole virtual-junction surface (derived depths, editable invert, the lateral inflow / DWF / RDII / treatment compound rows) and adds the eight editable usage fields plus a read-only context block.

rimDepth is re-labelled "Street Max Depth": unlike a sealed virtual junction, an inlet junction floods above the street section's full depth, and this is the optional [INLET_JUNCTIONS] MaxDepth override for it (see displayLabelFor). It is still not read by the solver's routing — it is the flood threshold and the ground line profile views draw.

Every editable row writes ONE SWMM_InletUsage through SWMMModelLayer::applySetInletUsage wrapped in a SetInletUsageCommand, so an edit here and the same edit made from a conduit's Inlets page are literally the same undoable operation.

Constructor & Destructor Documentation

◆ SWMMInletJunctionPropertyAdapter()

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

inline

Spelled out rather than using Base::Base because the direct base only INHERITS its constructor; re-inheriting an inherited constructor is legal but reads as an accident.

Property Documentation

◆ approachStreet

QString SWMMInletJunctionPropertyAdapter::approachStreet

read

◆ captureNode

DataObjectRef SWMMInletJunctionPropertyAdapter::captureNode

readwrite

◆ depressionHeight

double SWMMInletJunctionPropertyAdapter::depressionHeight

readwrite

◆ depressionWidth

double SWMMInletJunctionPropertyAdapter::depressionWidth

readwrite

◆ flowRestriction

double SWMMInletJunctionPropertyAdapter::flowRestriction

readwrite

◆ inletDesign

DataObjectRef SWMMInletJunctionPropertyAdapter::inletDesign

readwrite

◆ numInlets

int SWMMInletJunctionPropertyAdapter::numInlets

readwrite

◆ pctClogged

double SWMMInletJunctionPropertyAdapter::pctClogged

readwrite

◆ placement

SWMMNodePropertyAdapter::InletPlacement SWMMInletJunctionPropertyAdapter::placement

readwrite

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

/home/runner/work/openswmm.gui/openswmm.gui/include/ui/properties/swmmnodepropertyadapter.h

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SWMMInletJunctionPropertyAdapter()

Property Documentation

◆ approachStreet

◆ captureNode

◆ depressionHeight

◆ depressionWidth

◆ flowRestriction

◆ inletDesign

◆ numInlets

◆ pctClogged

◆ placement