plotattribute.h

Go to the documentation of this file.

 
#ifndef OPENSWMMVIS_PLOT_PLOTATTRIBUTE_H
#define OPENSWMMVIS_PLOT_PLOTATTRIBUTE_H
 
#include <QString>
#include <QVector>
 
namespace openswmmvis::plot {
 
enum class UnitSystem {
    US,   
    SI    
};
 
enum class PlotAttribute {
    Unknown          = 0,
 
    // ----- 1D node variables (engine SWMM_OUT_NODE_*) -----------------------
    NodeDepth        = 1,   
    NodeHead         = 2,   
    NodeVolume       = 3,   
    NodeLateralInflow= 4,   
    NodeTotalInflow  = 5,   
    NodeOverflow     = 6,   
 
    // ----- 1D link variables (engine SWMM_OUT_LINK_*) -----------------------
    LinkFlow         = 7,   
    LinkDepth        = 8,   
    LinkVelocity     = 9,   
    LinkVolume       = 10,  
    LinkCapacity     = 11,  
 
    // ----- 1D subcatchment variables (engine SWMM_OUT_SUBCATCH_*) -----------
    SubcatchRainfall  = 12, 
    SubcatchSnowDepth = 13, 
    SubcatchEvap      = 14, 
    SubcatchInfil     = 15, 
    SubcatchRunoff    = 16, 
 
    // ----- 2D mesh-cell variables (CF.3) -----------------------------------
    // Separate from Node*/Link* on purpose; see file header.
    Mesh2DDepth       = 17, 
    Mesh2DHGL         = 18, 
    Mesh2DVelocityMag = 19, 
    Mesh2DVelocityX   = 20, 
    Mesh2DVelocityY   = 21, 
 
    // ----- System-wide variables (engine SWMM_OUT_SYS_*) -------------------
    // Slice AT.2 — one global series per attribute per run. ObjectRef name
    // is unused; ObjectRef::Kind::System is the discriminator.
    SystemTemperature = 22, 
    SystemRainfall    = 23, 
    SystemSnowDepth   = 24, 
    SystemEvap        = 25, 
    SystemInfil       = 26, 
    SystemRunoff      = 27, 
    SystemDwInflow    = 28, 
    SystemGwInflow    = 29, 
    SystemLatInflow   = 30, 
    SystemFlooding    = 31, 
    SystemOutflow     = 32, 
    SystemStorage     = 33, 
    SystemEvapTotal   = 34, 
    SystemPET         = 35, 
 
    // ----- 2D mesh-edge variables ------------------------------------------
    // Both derive from the engine's single Mesh2_edge_flux dataset (volumetric
    // F_e, m³/s). Flow is that value directly; unit-width flux is F_e ÷ edge length.
    Mesh2DEdgeFlux    = 36, 
    Mesh2DEdgeFlow    = 37, 
 
    // ----- 2D mesh-cell rainfall (engine Mesh2_face_rainfall / _rain_cum) --
    Mesh2DRainfall    = 38, 
    Mesh2DRainVolume  = 39, 
};
 
QString labelFor(PlotAttribute a);
 
QString unitsFor(PlotAttribute a, UnitSystem u);
 
QString labelWithUnits(PlotAttribute a, UnitSystem u);
 
UnitSystem unitSystemFromFlowUnits(int flowUnits);
 
// ---------------------------------------------------------------------------
// Canonical plottable-attribute lists. Single source of truth for every UI
// that enumerates attributes (AttributePickerMenu, PlotVariablePickerDialog,
// the Comparison Plot "Add Series" menus, and the "All attributes" fan-out).
// Order is presentation order. A kind-keyed dispatcher lives in irunlayer.h
// (`attributesForKind`) — the nested ObjectRef::Kind can't be named here.
// ---------------------------------------------------------------------------
 
const QVector<PlotAttribute> &nodePlotAttributes();
 
const QVector<PlotAttribute> &linkPlotAttributes();
 
const QVector<PlotAttribute> &subcatchPlotAttributes();
 
const QVector<PlotAttribute> &systemPlotAttributes();
 
const QVector<PlotAttribute> &mesh2DCellPlotAttributes();
 
const QVector<PlotAttribute> &mesh2DEdgePlotAttributes();
 
const QVector<PlotAttribute> &mesh2DVertexPlotAttributes();
 
inline bool isMesh2DAttribute(PlotAttribute a) noexcept
{
    return a == PlotAttribute::Mesh2DDepth      ||
           a == PlotAttribute::Mesh2DHGL        ||
           a == PlotAttribute::Mesh2DVelocityMag||
           a == PlotAttribute::Mesh2DVelocityX  ||
           a == PlotAttribute::Mesh2DVelocityY  ||
           a == PlotAttribute::Mesh2DRainfall   ||
           a == PlotAttribute::Mesh2DRainVolume;
}
 
inline bool isSystemAttribute(PlotAttribute a) noexcept
{
    return a == PlotAttribute::SystemTemperature ||
           a == PlotAttribute::SystemRainfall    ||
           a == PlotAttribute::SystemSnowDepth   ||
           a == PlotAttribute::SystemEvap        ||
           a == PlotAttribute::SystemInfil       ||
           a == PlotAttribute::SystemRunoff      ||
           a == PlotAttribute::SystemDwInflow    ||
           a == PlotAttribute::SystemGwInflow    ||
           a == PlotAttribute::SystemLatInflow   ||
           a == PlotAttribute::SystemFlooding    ||
           a == PlotAttribute::SystemOutflow     ||
           a == PlotAttribute::SystemStorage     ||
           a == PlotAttribute::SystemEvapTotal   ||
           a == PlotAttribute::SystemPET;
}
 
} // namespace openswmmvis::plot
 
#endif // OPENSWMMVIS_PLOT_PLOTATTRIBUTE_H