xsectsampler.h

Go to the documentation of this file.

 
#ifndef OPENSWMMVIS_SECTIONVIEW_XSECTSAMPLER_H
#define OPENSWMMVIS_SECTIONVIEW_XSECTSAMPLER_H
 
#include <QPolygonF>
#include <QVector>
 
#include <openswmm/engine/openswmm_engine.h>
#include <openswmm/engine/openswmm_links.h>
 
namespace openswmmvis::sectionview {
 
struct XsectFullProps
{
    double yFull = 0.0;   
    double aFull = 0.0;   
    double rFull = 0.0;   
    double wMax  = 0.0;   
    double sFull = 0.0;   
    double aMax  = 0.0;   
    bool   open  = false; 
};
 
class XsectSampler
{
public:
    XsectSampler() = default;
    ~XsectSampler();
 
    XsectSampler(XsectSampler &&other) noexcept;
    XsectSampler &operator=(XsectSampler &&other) noexcept;
    XsectSampler(const XsectSampler &) = delete;
    XsectSampler &operator=(const XsectSampler &) = delete;
 
    // ---- Construction ------------------------------------------------------
 
    [[nodiscard]] static XsectSampler fromShape(int shape, double geom1,
                                                double geom2, double geom3,
                                                double geom4, bool si);
 
    [[nodiscard]] static XsectSampler fromLink(SWMM_Engine engine, int linkIdx);
 
    [[nodiscard]] static XsectSampler fromTransect(
        const QVector<double> &stations, const QVector<double> &elevations,
        double xLeftBank, double xRightBank,
        double nLeft, double nChannel, double nRight,
        double lengthFactor, bool si);
 
    [[nodiscard]] static XsectSampler fromStreet(
        double width, double curbHeight, double slope, double roughness,
        double gutterDepression, double gutterWidth, int sides,
        double backWidth, double backSlope, double backRoughness, bool si);
 
    [[nodiscard]] static XsectSampler fromCurve(
        double yFull, const QVector<double> &normDepths,
        const QVector<double> &normWidths, bool si);
 
    // ---- Queries -----------------------------------------------------------
 
    [[nodiscard]] bool isValid() const noexcept { return m_handle != nullptr; }
 
    [[nodiscard]] int shape() const;
 
    [[nodiscard]] XsectFullProps fullProps() const;
 
    [[nodiscard]] QVector<double> widthsAtDepths(const QVector<double> &depths) const;
 
    [[nodiscard]] QPolygonF outline(int samples = 240) const;
 
private:
    explicit XsectSampler(void *handle) noexcept : m_handle(handle) {}
    void reset() noexcept;
 
    void *m_handle = nullptr;   
};
 
// ---- Link geometry resolution (shared by the Section View and the profile
//      plot, so both surfaces read one implementation) ----------------------
 
[[nodiscard]] XsectSampler samplerFromStreetIndex(SWMM_Engine engine,
                                                  int streetIdx, bool si);
 
[[nodiscard]] XsectSampler samplerForLink(SWMM_Engine engine, int linkIdx,
                                          int shape, double g1, double g2,
                                          double g3, double g4, bool si);
 
[[nodiscard]] double linkFullDepth(SWMM_Engine engine, int linkIdx, int shape,
                                   double g1, double g2, double g3, double g4,
                                   bool si, bool *outOpenTop = nullptr);
 
} // namespace openswmmvis::sectionview
 
#endif // OPENSWMMVIS_SECTIONVIEW_XSECTSAMPLER_H