inletpropertybag.h

Go to the documentation of this file.

 
#ifndef OPENSWMMVIS_UI_DIALOGS_INLETPROPERTYBAG_H
#define OPENSWMMVIS_UI_DIALOGS_INLETPROPERTYBAG_H
 
#include "inlet/inletprovider.h"
 
#include <QObject>
#include <QPointer>
#include <QString>
 
#include <functional>
 
namespace openswmmvis::ui {
 
class InletPropertyBag : public QObject
{
    Q_OBJECT
 
    // ---- Grate -------------------------------------------------------------
    Q_PROPERTY(GrateTypeQ grateType      READ grateType      WRITE setGrateType      NOTIFY grateTypeChanged)
    Q_PROPERTY(double     grateLength    READ grateLength    WRITE setGrateLength    NOTIFY grateLengthChanged)
    Q_PROPERTY(double     grateWidth     READ grateWidth     WRITE setGrateWidth     NOTIFY grateWidthChanged)
    Q_PROPERTY(double     openFraction   READ openFraction   WRITE setOpenFraction   NOTIFY openFractionChanged)
    Q_PROPERTY(double     splashVelocity READ splashVelocity WRITE setSplashVelocity NOTIFY splashVelocityChanged)
 
    // ---- Curb opening ------------------------------------------------------
    Q_PROPERTY(double      curbLength  READ curbLength  WRITE setCurbLength  NOTIFY curbLengthChanged)
    Q_PROPERTY(double      curbHeight  READ curbHeight  WRITE setCurbHeight  NOTIFY curbHeightChanged)
    Q_PROPERTY(ThroatTypeQ throatAngle READ throatAngle WRITE setThroatAngle NOTIFY throatAngleChanged)
 
    // ---- Slotted drain -----------------------------------------------------
    Q_PROPERTY(double slotLength READ slotLength WRITE setSlotLength NOTIFY slotLengthChanged)
    Q_PROPERTY(double slotWidth  READ slotWidth  WRITE setSlotWidth  NOTIFY slotWidthChanged)
 
    // ---- Custom ------------------------------------------------------------
    Q_PROPERTY(CurveKindQ curveKind READ curveKind WRITE setCurveKind NOTIFY curveKindChanged)
    Q_PROPERTY(QString    curveId   READ curveId   WRITE setCurveId   NOTIFY curveIdChanged)
 
public:
    enum class GrateTypeQ : int {
        P_BAR_50     = static_cast<int>(inlet::GrateType::PBar50),
        P_BAR_50x100 = static_cast<int>(inlet::GrateType::PBar50x100),
        P_BAR_30     = static_cast<int>(inlet::GrateType::PBar30),
        CURVED_VANE  = static_cast<int>(inlet::GrateType::CurvedVane),
        TILT_BAR_45  = static_cast<int>(inlet::GrateType::TiltBar45),
        TILT_BAR_30  = static_cast<int>(inlet::GrateType::TiltBar30),
        RETICULINE   = static_cast<int>(inlet::GrateType::Reticuline),
        GENERIC      = static_cast<int>(inlet::GrateType::Generic),
    };
    Q_ENUM(GrateTypeQ)
 
    enum class ThroatTypeQ : int {
        HORIZONTAL = static_cast<int>(inlet::ThroatType::Horizontal),
        INCLINED   = static_cast<int>(inlet::ThroatType::Inclined),
        VERTICAL   = static_cast<int>(inlet::ThroatType::Vertical),
    };
    Q_ENUM(ThroatTypeQ)
 
    enum class CurveKindQ : int {
        NONE      = static_cast<int>(inlet::InletCurveKind::None),
        DIVERSION = static_cast<int>(inlet::InletCurveKind::Diversion),
        RATING    = static_cast<int>(inlet::InletCurveKind::Rating),
    };
    Q_ENUM(CurveKindQ)
 
    
    enum Group {
        NoGroup      = 0x0,
        GrateGroup   = 0x1,
        CurbGroup    = 0x2,
        SlottedGroup = 0x4,
        CustomGroup  = 0x8,
    };
    Q_DECLARE_FLAGS(Groups, Group)
 
    
    using CommitFn = std::function<void(const inlet::InletDesignData &before,
                                        const inlet::InletDesignData &after)>;
 
    explicit InletPropertyBag(QObject *parent = nullptr);
 
    void bind(inlet::InletProvider *p);
    inlet::InletProvider *provider() const noexcept;
 
    void setCommitHandler(CommitFn fn);
 
    Groups visibleGroups() const;
 
    static Groups groupsFor(inlet::InletType t);
 
    static Group groupOf(const QString &property);
 
    Q_INVOKABLE bool isPropertyVisible(const QString &property) const;
 
    Q_INVOKABLE QString displayLabelFor(const QString &property) const;
 
    GrateTypeQ  grateType()      const noexcept { return m_grateType; }
    double      grateLength()    const noexcept { return m_grateLength; }
    double      grateWidth()     const noexcept { return m_grateWidth; }
    double      openFraction()   const noexcept { return m_openFraction; }
    double      splashVelocity() const noexcept { return m_splashVelocity; }
    double      curbLength()     const noexcept { return m_curbLength; }
    double      curbHeight()     const noexcept { return m_curbHeight; }
    ThroatTypeQ throatAngle()    const noexcept { return m_throatAngle; }
    double      slotLength()     const noexcept { return m_slotLength; }
    double      slotWidth()      const noexcept { return m_slotWidth; }
    CurveKindQ  curveKind()      const noexcept { return m_curveKind; }
    QString     curveId()        const          { return m_curveId; }
 
public slots:
    void setGrateType(GrateTypeQ v);
    void setGrateLength(double v);
    void setGrateWidth(double v);
    void setOpenFraction(double v);
    void setSplashVelocity(double v);
    void setCurbLength(double v);
    void setCurbHeight(double v);
    void setThroatAngle(ThroatTypeQ v);
    void setSlotLength(double v);
    void setSlotWidth(double v);
    void setCurveKind(CurveKindQ v);
    void setCurveId(const QString &v);
 
signals:
    void grateTypeChanged(GrateTypeQ);
    void grateLengthChanged(double);
    void grateWidthChanged(double);
    void openFractionChanged(double);
    void splashVelocityChanged(double);
    void curbLengthChanged(double);
    void curbHeightChanged(double);
    void throatAngleChanged(ThroatTypeQ);
    void slotLengthChanged(double);
    void slotWidthChanged(double);
    void curveKindChanged(CurveKindQ);
    void curveIdChanged(const QString &);
 
private slots:
    void onProviderParamsChanged_();
 
private:
    void refreshFromProvider_();
 
    void push_();
 
    inlet::InletDesignData composed_() const;
 
    QPointer<inlet::InletProvider> m_provider;
    CommitFn                       m_commit;
 
    GrateTypeQ  m_grateType      = GrateTypeQ::P_BAR_50;
    double      m_grateLength    = 0.0;
    double      m_grateWidth     = 0.0;
    double      m_openFraction   = 0.0;
    double      m_splashVelocity = 0.0;
    double      m_curbLength     = 0.0;
    double      m_curbHeight     = 0.0;
    ThroatTypeQ m_throatAngle    = ThroatTypeQ::VERTICAL;
    double      m_slotLength     = 0.0;
    double      m_slotWidth      = 0.0;
    CurveKindQ  m_curveKind      = CurveKindQ::NONE;
    QString     m_curveId;
 
    bool m_suppressPush = false;
};
 
} // namespace openswmmvis::ui
 
Q_DECLARE_OPERATORS_FOR_FLAGS(openswmmvis::ui::InletPropertyBag::Groups)
Q_DECLARE_METATYPE(openswmmvis::ui::InletPropertyBag::GrateTypeQ)
Q_DECLARE_METATYPE(openswmmvis::ui::InletPropertyBag::ThroatTypeQ)
Q_DECLARE_METATYPE(openswmmvis::ui::InletPropertyBag::CurveKindQ)
 
#endif // OPENSWMMVIS_UI_DIALOGS_INLETPROPERTYBAG_H