inletprovider.h

Go to the documentation of this file.

 
#ifndef OPENSWMMVIS_INLET_INLETPROVIDER_H
#define OPENSWMMVIS_INLET_INLETPROVIDER_H
 
#include <QObject>
#include <QString>
 
namespace openswmmvis::inlet {
 
enum class InletType {
    Grate     = 0,
    Curb      = 1,
    Combo     = 2,
    Slotted   = 3,
    DropGrate = 4,
    DropCurb  = 5,
    Custom    = 6,
};
 
enum class GrateType {
    PBar50     = 0,
    PBar50x100 = 1,
    PBar30     = 2,
    CurvedVane = 3,
    TiltBar45  = 4,
    TiltBar30  = 5,
    Reticuline = 6,
    Generic    = 7,
};
 
enum class ThroatType {
    Horizontal = 0,
    Inclined   = 1,
    Vertical   = 2,
};
 
enum class InletCurveKind {
    None      = 0,
    Diversion = 1,   
    Rating    = 2,   
};
 
struct InletDesignData
{
    InletType      type         = InletType::Grate;
 
    // GRATE / DROP_GRATE / COMBO
    double         grateLength  = 2.0;
    double         grateWidth   = 2.0;
    GrateType      grateType    = GrateType::PBar50;
    double         openArea     = 0.8;    
    double         splashVeloc  = 0.0;    
 
    // CURB / DROP_CURB / COMBO
    double         curbLength   = 2.0;
    double         curbHeight   = 0.5;
    ThroatType     throat       = ThroatType::Vertical;
 
    // SLOTTED
    double         slotLength   = 2.0;
    double         slotWidth    = 0.2;
 
    // CUSTOM
    QString        curveId;
    InletCurveKind curveKind    = InletCurveKind::None;
};
 
class InletProvider : public QObject
{
    Q_OBJECT
 
public:
    explicit InletProvider(QString name, QObject *parent = nullptr);
    ~InletProvider() override;
 
    QString name()     const noexcept { return m_name; }
    QString comments() const          { return m_comments; }
 
    const InletDesignData &design() const noexcept { return m_design; }
 
    InletType      type()        const noexcept { return m_design.type; }
    double         grateLength() const noexcept { return m_design.grateLength; }
    double         grateWidth()  const noexcept { return m_design.grateWidth; }
    GrateType      grateType()   const noexcept { return m_design.grateType; }
    double         openArea()    const noexcept { return m_design.openArea; }
    double         splashVeloc() const noexcept { return m_design.splashVeloc; }
    double         curbLength()  const noexcept { return m_design.curbLength; }
    double         curbHeight()  const noexcept { return m_design.curbHeight; }
    ThroatType     throat()      const noexcept { return m_design.throat; }
    double         slotLength()  const noexcept { return m_design.slotLength; }
    double         slotWidth()   const noexcept { return m_design.slotWidth; }
    QString        curveId()     const          { return m_design.curveId; }
    InletCurveKind curveKind()   const noexcept { return m_design.curveKind; }
 
    void setName(QString newName);
    void setComments(QString text);
 
    void setDesign(const InletDesignData &d);
 
    void setType(InletType v);
    void setGrateLength(double v);
    void setGrateWidth(double v);
    void setGrateType(GrateType v);
    void setOpenArea(double v);
    void setSplashVeloc(double v);
    void setCurbLength(double v);
    void setCurbHeight(double v);
    void setThroat(ThroatType v);
    void setSlotLength(double v);
    void setSlotWidth(double v);
    void setCurveId(QString v);
    void setCurveKind(InletCurveKind v);
 
signals:
    void nameChanged(QString prev, QString now);
    void paramsChanged();
    void commentsChanged();
 
private:
    QString         m_name;
    QString         m_comments;
    InletDesignData m_design;
};
 
bool operator==(const InletDesignData &a, const InletDesignData &b);
inline bool operator!=(const InletDesignData &a, const InletDesignData &b)
{ return !(a == b); }
 
QString inletTypeLabel(InletType t);
 
const char *inletTypeKeyword(InletType t);
 
QString grateTypeLabel(GrateType t);
 
} // namespace openswmmvis::inlet
 
#endif // OPENSWMMVIS_INLET_INLETPROVIDER_H