swmmlinkpropertyadapter.h

Go to the documentation of this file.

 
#ifndef SWMMLINKPROPERTYADAPTER_H
#define SWMMLINKPROPERTYADAPTER_H
 
#include <QObject>
#include <QString>
#include <QUuid>                            // Stats-source identity (QA.2 mirror)
 
#include <openswmm/engine/openswmm_engine.h>
 
#include "ui/properties/culvertcoderef.h"        // ATTRIBUTE_EDITOR_WIRING Phase 0
#include "ui/properties/dataobjectref.h"
#include "ui/properties/initialqualityeditref.h" // Initial-quality UI round
#include "ui/properties/linkcompoundeditref.h"   // Slice SC.1
#include "ui/properties/userflagseditref.h"      // USER_FLAGS Phase 4
 
class SWMMModelLayer;
 
namespace openswmmvis { class OutputStatsRegistry; }    // QA.2 mirror
 
class SWMMLinkPropertyAdapter : public QObject
{
    Q_OBJECT
 
public:
    enum LinkKind     { Conduit = 0, Pump = 1, Orifice = 2, Weir = 3, Outlet = 4 };
    enum FlapGate     { NO = 0, YES = 1 };
    enum PumpInitState { OFF = 0, ON = 1 };
    // Slice SD partial — orifice flow-attack classification. Mirrors
    // SWMM_OrificeType in openswmm_links.h:34 and the legacy SWMM-GUI
    // combo order in SWMM-GUI/Epaswmm5/objprops.txt:862.
    enum OrificeType  { SIDE = 0, BOTTOM = 1 };
    // Slice SD partial (BN-LINK-03) — weir flow classification. Mirrors
    // SWMM_WeirType in openswmm_links.h and the legacy combo at
    // SWMM-GUI/Epaswmm5/objprops.txt:160. The companion "Shape" combo
    // is derived from the type (see objprops.txt:162) — no separate
    // Q_ENUM needed on the GUI side.
    enum WeirType {
        TRANSVERSE  = 0,
        SIDEFLOW    = 1,
        VNOTCH      = 2,
        TRAPEZOIDAL = 3,
        ROADWAY     = 4,
    };
    // Slice SD partial (BN-LINK-04) — outlet rating-curve classification.
    // Mirrors SWMM_OutletRatingType in openswmm_links.h and the legacy
    // combo at SWMM-GUI/Epaswmm5/objprops.txt:913. The four-value
    // FUNCTIONAL×{HEAD,DEPTH} / TABULAR×{HEAD,DEPTH} grid drives
    // conditional visibility of the exponent / curve picker rows.
    enum OutletRatingType {
        FUNCTIONAL_HEAD  = 0,
        FUNCTIONAL_DEPTH = 1,
        TABULAR_HEAD     = 2,
        TABULAR_DEPTH    = 3,
    };
    Q_ENUM(LinkKind)
    Q_ENUM(FlapGate)
    Q_ENUM(PumpInitState)
    Q_ENUM(OrificeType)
    Q_ENUM(WeirType)
    Q_ENUM(OutletRatingType)
 
    // Common to every link type.
    Q_PROPERTY(QString  name         READ name  WRITE setName)
    Q_PROPERTY(LinkKind linkKind     READ linkKind)
    Q_PROPERTY(QString  fromNode     READ fromNode)
    Q_PROPERTY(QString  toNode       READ toNode)
    Q_PROPERTY(QString  tag          READ tag   WRITE setTag   NOTIFY changed)
 
    SWMMLinkPropertyAdapter(SWMM_Engine engine, QString name,
                              QObject *parent = nullptr);
 
    void setModelLayer(SWMMModelLayer *layer) { m_layer = layer; }
    [[nodiscard]] SWMMModelLayer *modelLayer() const { return m_layer; }
 
    [[nodiscard]] QString  name() const     { return m_name; }
    [[nodiscard]] LinkKind linkKind() const;
    [[nodiscard]] QString  fromNode() const;
    [[nodiscard]] QString  toNode() const;
    [[nodiscard]] QString  tag()      const;   
 
    [[nodiscard]] double length()           const;
    [[nodiscard]] double roughness()        const;
    [[nodiscard]] double offsetUp()         const;
    [[nodiscard]] double offsetDn()         const;
    [[nodiscard]] double crestHeight()      const;
    [[nodiscard]] double dischargeCoeff()   const;
    [[nodiscard]] double endContractions()  const;
    [[nodiscard]] FlapGate      flapGate()      const;
    [[nodiscard]] PumpInitState pumpInitState() const;
    [[nodiscard]] QString       pumpCurveName() const;
    [[nodiscard]] OrificeType      orificeType()      const;  
    [[nodiscard]] WeirType         weirType()         const;  
    [[nodiscard]] OutletRatingType outletRatingType() const;  
    [[nodiscard]] double           outletExpon()      const;  
    [[nodiscard]] double           pumpStartupDepth() const;  
    [[nodiscard]] double           pumpShutoffDepth() const;  
    [[nodiscard]] double           orificeOpenCloseRate() const;  
 
    // Slice SB — conduit scalar parity (matches legacy ConduitProps in
    // SWMM-GUI/Epaswmm5/objprops.txt rows 12-17, 21). All accessors live
    // on the base so the GETTER_D macro can be reused; only the
    // SWMMConduitPropertyAdapter subclass exposes them as Q_PROPERTY rows
    // because pumps / orifices / weirs / outlets don't carry these
    // fields on the legacy editor side.
    [[nodiscard]] double initialFlow()      const;   
    [[nodiscard]] double maxFlow()          const;   
    [[nodiscard]] double lossInlet()        const;   
    [[nodiscard]] double lossOutlet()       const;   
    [[nodiscard]] double lossAvg()          const;   
    [[nodiscard]] double seepRate()         const;   
    [[nodiscard]] int    barrels()          const;   
 
    // Direct inline cross-section geometry — geom1..geom4 of the engine
    // xsect tuple, exposed alongside the compound `xsection` editor so the
    // user can tweak a single dimension without opening the dialog. The
    // engine has no per-geom setter, so each setter read-modify-writes the
    // whole tuple (mirrors the loss-coeff slots). `xsectShapeId` lets the
    // Property Browser grey out geoms that don't apply to the current
    // shape (see openswmmvis::xsectGeomApplies).
    [[nodiscard]] int    xsectShapeId() const;       
    [[nodiscard]] double xsectGeom1()   const;
    [[nodiscard]] double xsectGeom2()   const;
    [[nodiscard]] double xsectGeom3()   const;
    [[nodiscard]] double xsectGeom4()   const;
 
    // Read-only post-run summary statistics (mirror of the node adapter's
    // Slice QA.2 block and the Attribute Table's link dynamics columns).
    // Zero until a run's results are bound via setStatsSource; the three
    // pump utilisation getters are meaningful only on pumps.
    [[nodiscard]] double statMaxFlow()       const;
    [[nodiscard]] double statMaxVelocity()   const;
    [[nodiscard]] double statMaxFilling()    const;
    [[nodiscard]] double statVolFlow()       const;
    [[nodiscard]] double statSurchargeTime() const;
    [[nodiscard]] double statPumpCycles()    const;
    [[nodiscard]] double statPumpOnTime()    const;
    [[nodiscard]] double statPumpVolume()    const;
 
    [[nodiscard]] DataObjectRef pumpCurveRef() const;
 
    [[nodiscard]] LinkCompoundEditRef xsectionRef()    const;
    [[nodiscard]] LinkCompoundEditRef inletUsageRef()  const;
 
    [[nodiscard]] CulvertCodeRef culvertCodeRef() const;
 
    [[nodiscard]] UserFlagsEditRef userFlagsRef() const;
 
    [[nodiscard]] InitialQualityEditRef initialQualityRef() const;
 
    Q_INVOKABLE QString displayLabelFor(const QString &property) const;
 
public slots:
    void setName(const QString &newName);
    void setTag(const QString &t);              
    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);            
    void setWeirType(WeirType v);                  
    void setOutletRatingType(OutletRatingType v);  
    void setOutletExpon(double v);                 
    void setPumpStartupDepth(double v);            
    void setPumpShutoffDepth(double v);            
    void setOrificeOpenCloseRate(double v);        
    // Slice SB — conduit scalar setters. Loss-coefficient setters read
    // the other two coefficients from the engine first then write the
    // full triple via `swmm_link_set_loss_coeff` (atomic from a caller's
    // view); the three rows look independent in the Property Browser
    // but the three-coeff write is one engine call.
    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);
    // Inline cross-section geom setters — read-modify-write the engine
    // xsect tuple (shape + the other three geoms preserved). No-op when
    // the geom doesn't apply to the current shape, so a stray write from
    // a greyed cell can't corrupt the section.
    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 &)    { emit changed(); }
    void setUserFlagsRef(const UserFlagsEditRef &)      { emit changed(); }
    void setInitialQualityRef(const InitialQualityEditRef &) { emit changed(); }
    void setCulvertCodeRef(const CulvertCodeRef &)      { emit changed(); }
    void setInletUsageRef(const LinkCompoundEditRef &)  { emit changed(); }
 
    void refresh() { emit changed(); }
 
    void updateStoredName(const QString &newName) { m_name = newName; }
 
    void setStatsRegistry(openswmmvis::OutputStatsRegistry *registry);
    void setStatsSource(const QUuid &id);
    [[nodiscard]] QUuid statsSourceId() const { return m_statsSourceId; }
 
signals:
    void changed();
    void renameRequested(const QString &oldName, const QString &newName);
    void displayLabelsChanged();
 
protected:
    [[nodiscard]] int linkIdx() const;
    void writeXsectGeom(int ordinal, double v);
    SWMM_Engine     m_engine;
    QString         m_name;
    SWMMModelLayer *m_layer = nullptr;  
 
    QUuid                              m_statsSourceId;
    openswmmvis::OutputStatsRegistry  *m_statsRegistry = nullptr;
};
 
class SWMMConduitPropertyAdapter : public SWMMLinkPropertyAdapter
{
    Q_OBJECT
    Q_PROPERTY(double length     READ length     WRITE setLength    NOTIFY changed)
    Q_PROPERTY(double roughness  READ roughness  WRITE setRoughness NOTIFY changed)
    Q_PROPERTY(double offsetUp   READ offsetUp   WRITE setOffsetUp  NOTIFY changed)
    Q_PROPERTY(double offsetDn   READ offsetDn   WRITE setOffsetDn  NOTIFY changed)
    // Slice SB — conduit scalar parity rows. Loss coefficients are
    // exposed as three separate Q_PROPERTYs per §S.1 Q-S4 decision.
    Q_PROPERTY(double initialFlow READ initialFlow WRITE setInitialFlow NOTIFY changed)
    Q_PROPERTY(double maxFlow     READ maxFlow     WRITE setMaxFlow     NOTIFY changed)
    Q_PROPERTY(double lossInlet   READ lossInlet   WRITE setLossInlet   NOTIFY changed)
    Q_PROPERTY(double lossOutlet  READ lossOutlet  WRITE setLossOutlet  NOTIFY changed)
    Q_PROPERTY(double lossAvg     READ lossAvg     WRITE setLossAvg     NOTIFY changed)
    Q_PROPERTY(double seepRate    READ seepRate    WRITE setSeepRate    NOTIFY changed)
    Q_PROPERTY(int    barrels     READ barrels     WRITE setBarrels     NOTIFY changed)
    Q_PROPERTY(SWMMLinkPropertyAdapter::FlapGate flapGate
               READ flapGate WRITE setFlapGate NOTIFY changed)
    // Slice SC.1 — compound-attribute "Edit…" cells.
    Q_PROPERTY(LinkCompoundEditRef xsection
               READ xsectionRef    WRITE setXsectionRef    NOTIFY changed)
    // Direct inline geom1..geom4 (generic labels; PropertiesPanel greys
    // out the ones that don't apply to the current shape).
    Q_PROPERTY(double geom1 READ xsectGeom1 WRITE setXsectGeom1 NOTIFY changed)
    Q_PROPERTY(double geom2 READ xsectGeom2 WRITE setXsectGeom2 NOTIFY changed)
    Q_PROPERTY(double geom3 READ xsectGeom3 WRITE setXsectGeom3 NOTIFY changed)
    Q_PROPERTY(double geom4 READ xsectGeom4 WRITE setXsectGeom4 NOTIFY changed)
    Q_PROPERTY(CulvertCodeRef culvertCode
               READ culvertCodeRef WRITE setCulvertCodeRef NOTIFY changed)
    Q_PROPERTY(LinkCompoundEditRef inletUsage
               READ inletUsageRef  WRITE setInletUsageRef  NOTIFY changed)
    // Read-only post-run summary (no WRITE → non-editable). Mirrors the
    // Attribute Table's link dynamics columns; values follow the bound
    // stats source (see the base class).
    Q_PROPERTY(double statMaxFlow       READ statMaxFlow       NOTIFY changed)
    Q_PROPERTY(double statMaxVelocity   READ statMaxVelocity   NOTIFY changed)
    Q_PROPERTY(double statMaxFilling    READ statMaxFilling    NOTIFY changed)
    Q_PROPERTY(double statVolFlow       READ statVolFlow       NOTIFY changed)
    Q_PROPERTY(double statSurchargeTime READ statSurchargeTime NOTIFY changed)
    Q_PROPERTY(InitialQualityEditRef initialQuality
               READ initialQualityRef WRITE setInitialQualityRef NOTIFY changed)
    Q_PROPERTY(UserFlagsEditRef userFlags
               READ userFlagsRef WRITE setUserFlagsRef NOTIFY changed)
public:
    using SWMMLinkPropertyAdapter::SWMMLinkPropertyAdapter;
};
 
class SWMMPumpPropertyAdapter : public SWMMLinkPropertyAdapter
{
    Q_OBJECT
    // Slice BM.0-Browse-Edit (2026-05-25) — typed as DataObjectRef so the
    // QPropertyItemDelegate hands out the picker editor (combo + browse
    // button + right-click menu). Engine setter is swmm_link_set_pump_curve.
    Q_PROPERTY(DataObjectRef pumpCurve
               READ pumpCurveRef WRITE setPumpCurveRef NOTIFY changed)
    Q_PROPERTY(SWMMLinkPropertyAdapter::PumpInitState initState
               READ pumpInitState WRITE setPumpInitState NOTIFY changed)
    Q_PROPERTY(double startupDepth
               READ pumpStartupDepth WRITE setPumpStartupDepth NOTIFY changed)
    Q_PROPERTY(double shutoffDepth
               READ pumpShutoffDepth WRITE setPumpShutoffDepth NOTIFY changed)
    // Read-only post-run summary — the shared link block plus the pump
    // utilisation trio (Attribute Table parity; see the base class).
    Q_PROPERTY(double statMaxFlow       READ statMaxFlow       NOTIFY changed)
    Q_PROPERTY(double statMaxVelocity   READ statMaxVelocity   NOTIFY changed)
    Q_PROPERTY(double statMaxFilling    READ statMaxFilling    NOTIFY changed)
    Q_PROPERTY(double statVolFlow       READ statVolFlow       NOTIFY changed)
    Q_PROPERTY(double statSurchargeTime READ statSurchargeTime NOTIFY changed)
    Q_PROPERTY(double statPumpCycles    READ statPumpCycles    NOTIFY changed)
    Q_PROPERTY(double statPumpOnTime    READ statPumpOnTime    NOTIFY changed)
    Q_PROPERTY(double statPumpVolume    READ statPumpVolume    NOTIFY changed)
    Q_PROPERTY(InitialQualityEditRef initialQuality
               READ initialQualityRef WRITE setInitialQualityRef NOTIFY changed)
    Q_PROPERTY(UserFlagsEditRef userFlags
               READ userFlagsRef WRITE setUserFlagsRef NOTIFY changed)
public:
    using SWMMLinkPropertyAdapter::SWMMLinkPropertyAdapter;
};
 
class SWMMOrificePropertyAdapter : public SWMMLinkPropertyAdapter
{
    Q_OBJECT
    // Slice SD partial (2026-05-25) — orifice TYPE row, engine-backed via
    // BN-LINK-02 (swmm_link_get/set_orifice_type). Sits at the top of the
    // form matching legacy OrificeProps[5] row order.
    Q_PROPERTY(SWMMLinkPropertyAdapter::OrificeType orificeType
               READ orificeType WRITE setOrificeType NOTIFY changed)
    Q_PROPERTY(double offset         READ offsetUp        WRITE setOffsetUp        NOTIFY changed)
    Q_PROPERTY(double dischargeCoeff READ dischargeCoeff  WRITE setDischargeCoeff  NOTIFY changed)
    Q_PROPERTY(SWMMLinkPropertyAdapter::FlapGate flapGate
               READ flapGate WRITE setFlapGate NOTIFY changed)
    // Slice SD partial (BN-LINK-06) — orifice open/close rate (1/s).
    // 0 = instantaneous. Legacy SWMM-GUI surfaces this as "Time to
    // Open/Close (hr)" — clients that want the hours UX should
    // convert before/after calling the setter.
    Q_PROPERTY(double openCloseRate
               READ orificeOpenCloseRate WRITE setOrificeOpenCloseRate NOTIFY changed)
    Q_PROPERTY(LinkCompoundEditRef xsection
               READ xsectionRef WRITE setXsectionRef NOTIFY changed)
    // Direct inline geom1..geom4 (orifices use CIRCULAR / RECT_CLOSED, so
    // only geom1/geom2 ever apply; the rest grey out).
    Q_PROPERTY(double geom1 READ xsectGeom1 WRITE setXsectGeom1 NOTIFY changed)
    Q_PROPERTY(double geom2 READ xsectGeom2 WRITE setXsectGeom2 NOTIFY changed)
    Q_PROPERTY(double geom3 READ xsectGeom3 WRITE setXsectGeom3 NOTIFY changed)
    Q_PROPERTY(double geom4 READ xsectGeom4 WRITE setXsectGeom4 NOTIFY changed)
    // Read-only post-run summary (Attribute Table parity; see base class).
    Q_PROPERTY(double statMaxFlow       READ statMaxFlow       NOTIFY changed)
    Q_PROPERTY(double statMaxVelocity   READ statMaxVelocity   NOTIFY changed)
    Q_PROPERTY(double statMaxFilling    READ statMaxFilling    NOTIFY changed)
    Q_PROPERTY(double statVolFlow       READ statVolFlow       NOTIFY changed)
    Q_PROPERTY(double statSurchargeTime READ statSurchargeTime NOTIFY changed)
    Q_PROPERTY(InitialQualityEditRef initialQuality
               READ initialQualityRef WRITE setInitialQualityRef NOTIFY changed)
    Q_PROPERTY(UserFlagsEditRef userFlags
               READ userFlagsRef WRITE setUserFlagsRef NOTIFY changed)
public:
    using SWMMLinkPropertyAdapter::SWMMLinkPropertyAdapter;
};
 
class SWMMWeirPropertyAdapter : public SWMMLinkPropertyAdapter
{
    Q_OBJECT
    // Slice SD partial (BN-LINK-03, 2026-05-25) — weir TYPE row sits at
    // the top of the form matching legacy WeirProps[5] row order.
    Q_PROPERTY(SWMMLinkPropertyAdapter::WeirType weirType
               READ weirType WRITE setWeirType NOTIFY changed)
    Q_PROPERTY(double offsetUp        READ offsetUp        WRITE setOffsetUp        NOTIFY changed)
    Q_PROPERTY(double offsetDn        READ offsetDn        WRITE setOffsetDn        NOTIFY changed)
    Q_PROPERTY(double crestHeight     READ crestHeight     WRITE setCrestHeight     NOTIFY changed)
    Q_PROPERTY(double dischargeCoeff  READ dischargeCoeff  WRITE setDischargeCoeff  NOTIFY changed)
    Q_PROPERTY(double endContractions READ endContractions WRITE setEndContractions NOTIFY changed)
    Q_PROPERTY(SWMMLinkPropertyAdapter::FlapGate flapGate
               READ flapGate WRITE setFlapGate NOTIFY changed)
    Q_PROPERTY(LinkCompoundEditRef xsection
               READ xsectionRef WRITE setXsectionRef NOTIFY changed)
    // Direct inline geom1..geom4 (weirs use RECT_OPEN / TRAPEZOIDAL /
    // TRIANGULAR; inapplicable geoms grey out per shape).
    Q_PROPERTY(double geom1 READ xsectGeom1 WRITE setXsectGeom1 NOTIFY changed)
    Q_PROPERTY(double geom2 READ xsectGeom2 WRITE setXsectGeom2 NOTIFY changed)
    Q_PROPERTY(double geom3 READ xsectGeom3 WRITE setXsectGeom3 NOTIFY changed)
    Q_PROPERTY(double geom4 READ xsectGeom4 WRITE setXsectGeom4 NOTIFY changed)
    // Read-only post-run summary (Attribute Table parity; see base class).
    Q_PROPERTY(double statMaxFlow       READ statMaxFlow       NOTIFY changed)
    Q_PROPERTY(double statMaxVelocity   READ statMaxVelocity   NOTIFY changed)
    Q_PROPERTY(double statMaxFilling    READ statMaxFilling    NOTIFY changed)
    Q_PROPERTY(double statVolFlow       READ statVolFlow       NOTIFY changed)
    Q_PROPERTY(double statSurchargeTime READ statSurchargeTime NOTIFY changed)
    Q_PROPERTY(InitialQualityEditRef initialQuality
               READ initialQualityRef WRITE setInitialQualityRef NOTIFY changed)
    Q_PROPERTY(UserFlagsEditRef userFlags
               READ userFlagsRef WRITE setUserFlagsRef NOTIFY changed)
public:
    using SWMMLinkPropertyAdapter::SWMMLinkPropertyAdapter;
};
 
class SWMMOutletPropertyAdapter : public SWMMLinkPropertyAdapter
{
    Q_OBJECT
    // Slice SD partial — rating-curve TYPE sits at the top to match
    // legacy OutletProps[7] row order.
    Q_PROPERTY(SWMMLinkPropertyAdapter::OutletRatingType ratingType
               READ outletRatingType WRITE setOutletRatingType NOTIFY changed)
    Q_PROPERTY(double offset         READ offsetUp        WRITE setOffsetUp        NOTIFY changed)
    // Functional-form coefficient (legacy "Coefficient" row) reuses
    // the shared discharge-coeff scalar — same engine field (cd) used
    // by orifices and weirs.
    Q_PROPERTY(double coefficient    READ dischargeCoeff  WRITE setDischargeCoeff  NOTIFY changed)
    Q_PROPERTY(double expon          READ outletExpon     WRITE setOutletExpon     NOTIFY changed)
    // Tabular curve picker reuses the existing DataObjectRef pump-curve
    // accessor (the engine shares the curve-index slot between pumps
    // and tabular outlets per `LinksHandler::handle_outlets:229`).
    Q_PROPERTY(DataObjectRef outletCurve
               READ pumpCurveRef WRITE setPumpCurveRef NOTIFY changed)
    Q_PROPERTY(SWMMLinkPropertyAdapter::FlapGate flapGate
               READ flapGate WRITE setFlapGate NOTIFY changed)
    // Read-only post-run summary (Attribute Table parity; see base class).
    Q_PROPERTY(double statMaxFlow       READ statMaxFlow       NOTIFY changed)
    Q_PROPERTY(double statMaxVelocity   READ statMaxVelocity   NOTIFY changed)
    Q_PROPERTY(double statMaxFilling    READ statMaxFilling    NOTIFY changed)
    Q_PROPERTY(double statVolFlow       READ statVolFlow       NOTIFY changed)
    Q_PROPERTY(double statSurchargeTime READ statSurchargeTime NOTIFY changed)
    Q_PROPERTY(InitialQualityEditRef initialQuality
               READ initialQualityRef WRITE setInitialQualityRef NOTIFY changed)
    Q_PROPERTY(UserFlagsEditRef userFlags
               READ userFlagsRef WRITE setUserFlagsRef NOTIFY changed)
public:
    using SWMMLinkPropertyAdapter::SWMMLinkPropertyAdapter;
};
 
#endif // SWMMLINKPROPERTYADAPTER_H