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
Public Member Functions | Properties | List of all members
SWMMOutfallPropertyAdapter Class Reference

#include <swmmnodepropertyadapter.h>

Inheritance diagram for SWMMOutfallPropertyAdapter:
Collaboration diagram for SWMMOutfallPropertyAdapter:

Public Member Functions

 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

SWMMNodePropertyAdapter::OutfallType outfallType
 
double outfallStage
 
DataObjectRef outfallTidalCurve
 
DataObjectRef outfallTimeseries
 
SWMMNodePropertyAdapter::FlapGate outfallFlapGate
 
double crownElev
 
double fullVolume
 
int degree
 
double statMaxDepth
 
double statMaxOverflow
 
double statVolFlooded
 
double statTimeFlooded
 
NodeCompoundEditRef inflows
 
NodeCompoundEditRef dwf
 
NodeCompoundEditRef rdii
 
NodeCompoundEditRef treatment
 
NodeCompoundEditRef groundwaterSources
 
InitialQualityEditRef initialQuality
 
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

Outfall adapter — [OUTFALLS] columns: Name, Elev, Type, Gated, (StageData when FIXED). No depth/ponding attributes — those don't apply at a boundary node.

Member Function Documentation

◆ SWMMNodePropertyAdapter()

SWMMNodePropertyAdapter::SWMMNodePropertyAdapter ( SWMM_Engine  engine,
QString  name,
QObject *  parent = nullptr 
)
Parameters
engineEngine handle (non-null).
nameNode id (must already exist on the engine).

Property Documentation

◆ crownElev

double SWMMOutfallPropertyAdapter::crownElev
read

◆ degree

int SWMMOutfallPropertyAdapter::degree
read

◆ dwf

NodeCompoundEditRef SWMMOutfallPropertyAdapter::dwf
readwrite

◆ fullVolume

double SWMMOutfallPropertyAdapter::fullVolume
read

◆ groundwaterSources

NodeCompoundEditRef SWMMOutfallPropertyAdapter::groundwaterSources
readwrite

◆ inflows

NodeCompoundEditRef SWMMOutfallPropertyAdapter::inflows
readwrite

◆ initialQuality

InitialQualityEditRef SWMMOutfallPropertyAdapter::initialQuality
readwrite

◆ outfallFlapGate

SWMMNodePropertyAdapter::FlapGate SWMMOutfallPropertyAdapter::outfallFlapGate
readwrite

◆ outfallStage

double SWMMOutfallPropertyAdapter::outfallStage
readwrite

◆ outfallTidalCurve

DataObjectRef SWMMOutfallPropertyAdapter::outfallTidalCurve
readwrite

◆ outfallTimeseries

DataObjectRef SWMMOutfallPropertyAdapter::outfallTimeseries
readwrite

◆ outfallType

SWMMNodePropertyAdapter::OutfallType SWMMOutfallPropertyAdapter::outfallType
readwrite

◆ rdii

NodeCompoundEditRef SWMMOutfallPropertyAdapter::rdii
readwrite

◆ statMaxDepth

double SWMMOutfallPropertyAdapter::statMaxDepth
read

◆ statMaxOverflow

double SWMMOutfallPropertyAdapter::statMaxOverflow
read

◆ statTimeFlooded

double SWMMOutfallPropertyAdapter::statTimeFlooded
read

◆ statVolFlooded

double SWMMOutfallPropertyAdapter::statVolFlooded
read

◆ treatment

NodeCompoundEditRef SWMMOutfallPropertyAdapter::treatment
readwrite

◆ userFlags

UserFlagsEditRef SWMMOutfallPropertyAdapter::userFlags
readwrite
The documentation for this class was generated from the following file: