xsectshapegeom.h

Go to the documentation of this file.

 
#ifndef XSECTSHAPEGEOM_H
#define XSECTSHAPEGEOM_H
 
#include <QString>
 
#include <openswmm/engine/openswmm_links.h>
 
namespace openswmmvis {
 
struct XsectShapeRow {
    const char *name;        
    int         engineId;    
    const char *geom1Label;  
    const char *geom2Label;
    const char *geom3Label;
    const char *geom4Label;
};
 
inline constexpr int kXsectIrregularId = SWMM_XSECT_IRREGULAR;
inline constexpr int kXsectStreetId    = SWMM_XSECT_STREET;
inline constexpr int kXsectCustomId    = SWMM_XSECT_CUSTOM;
 
inline constexpr XsectShapeRow kXsectShapes[] = {
    { "CIRCULAR",        SWMM_XSECT_CIRCULAR,       "Diameter",  "",             "",               ""  },
    { "FILLED_CIRCULAR", SWMM_XSECT_FILLED_CIRCULAR,"Diameter",  "Filled Depth", "",               ""  },
    { "RECT_CLOSED",     SWMM_XSECT_RECT_CLOSED,    "Max Depth", "Width",        "",               ""  },
    { "RECT_OPEN",       SWMM_XSECT_RECT_OPEN,      "Max Depth", "Width",        "",               ""  },
    { "TRAPEZOIDAL",     SWMM_XSECT_TRAPEZOIDAL,    "Max Depth", "Bottom Width", "Left Slope",     "Right Slope" },
    { "TRIANGULAR",      SWMM_XSECT_TRIANGULAR,     "Max Depth", "Top Width",    "",               ""  },
    { "PARABOLIC",       SWMM_XSECT_PARABOLIC,      "Max Depth", "Top Width",    "",               ""  },
    { "POWER",           SWMM_XSECT_POWER,          "Max Depth", "Top Width",    "Exponent",       ""  },
    { "RECT_TRIANGULAR", SWMM_XSECT_RECT_TRIANG,    "Max Depth", "Top Width",    "Triangle Height","" },
    { "RECT_ROUND",      SWMM_XSECT_RECT_ROUND,     "Max Depth", "Top Width",    "Bottom Radius",  ""  },
    { "MOD_BASKETHANDLE",SWMM_XSECT_MOD_BASKET,     "Max Depth", "Bottom Width", "Top Radius",     ""  },
    { "HORIZ_ELLIPSE",   SWMM_XSECT_HORIZ_ELLIPSE,  "Max Height","Max Width",    "",               ""  },
    { "VERT_ELLIPSE",    SWMM_XSECT_VERT_ELLIPSE,   "Max Height","Max Width",    "",               ""  },
    { "ARCH",            SWMM_XSECT_ARCH,           "Max Height","Max Width",    "",               ""  },
    { "EGGSHAPED",       SWMM_XSECT_EGGSHAPED,      "Max Depth", "",             "",               ""  },
    { "HORSESHOE",       SWMM_XSECT_HORSESHOE,      "Max Depth", "",             "",               ""  },
    { "GOTHIC",          SWMM_XSECT_GOTHIC,         "Max Depth", "",             "",               ""  },
    { "CATENARY",        SWMM_XSECT_CATENARY,       "Max Depth", "",             "",               ""  },
    { "SEMIELLIPTICAL",  SWMM_XSECT_SEMIELLIPTICAL, "Max Depth", "",             "",               ""  },
    // Slice SP.3 — the five shapes the engine has always supported but the
    // picker never surfaced (they had no SVG artwork; the section preview now
    // draws every shape procedurally, so the gap is closed).
    { "BASKETHANDLE",    SWMM_XSECT_BASKETHANDLE,   "Max Depth", "",             "",               ""  },
    { "SEMICIRCULAR",    SWMM_XSECT_SEMICIRCULAR,   "Max Depth", "",             "",               ""  },
    // FORCE_MAIN is geometrically a circular pipe; geom2 selects the friction
    // law's coefficient (Hazen-Williams C or Darcy-Weisbach roughness height),
    // NOT a dimension — hence the explicit label.
    { "FORCE_MAIN",      SWMM_XSECT_FORCE_MAIN,     "Diameter",  "Roughness (C or e)", "",         ""  },
    { "IRREGULAR",       SWMM_XSECT_IRREGULAR,      "Transect (index)", "",      "",               ""  },
    { "CUSTOM",          SWMM_XSECT_CUSTOM,         "Max Depth", "Shape Curve (index)", "",        ""  },
    { "STREET",          SWMM_XSECT_STREET,         "Street (index)",   "",      "",               ""  },
    // DUMMY carries no geometry at all: it exists so a link can be routed
    // without conveyance. No geom is editable.
    { "DUMMY",           SWMM_XSECT_DUMMY,          "",          "",             "",               ""  },
};
 
inline const XsectShapeRow *findXsectShapeRow(int engineId)
{
    for (const auto &r : kXsectShapes) {
        if (r.engineId == engineId) return &r;
    }
    return &kXsectShapes[0];
}
 
inline QString xsectShapeName(int engineId)
{
    for (const auto &r : kXsectShapes) {
        if (r.engineId == engineId) return QString::fromLatin1(r.name);
    }
    return {};
}
 
inline QString xsectGeomLabel(int shapeId, int ordinal)
{
    const XsectShapeRow *r = findXsectShapeRow(shapeId);
    const char *lbl = nullptr;
    switch (ordinal) {
    case 1: lbl = r->geom1Label; break;
    case 2: lbl = r->geom2Label; break;
    case 3: lbl = r->geom3Label; break;
    case 4: lbl = r->geom4Label; break;
    default: return {};
    }
    return (lbl && *lbl) ? QString::fromLatin1(lbl) : QString();
}
 
inline bool xsectGeomApplies(int shapeId, int ordinal)
{
    if (shapeId == kXsectIrregularId || shapeId == kXsectStreetId)
        return false;
    if (shapeId == kXsectCustomId && ordinal == 2)
        return false;
    return !xsectGeomLabel(shapeId, ordinal).isEmpty();
}
 
inline bool xsectGeomIsPickerIndex(int shapeId, int ordinal)
{
    if (ordinal == 1
        && (shapeId == kXsectIrregularId || shapeId == kXsectStreetId))
        return true;
    return shapeId == kXsectCustomId && ordinal == 2;
}
 
} // namespace openswmmvis
 
#endif // XSECTSHAPEGEOM_H