patternprovider.h

Go to the documentation of this file.

 
#ifndef OPENSWMMVIS_PATTERN_PATTERNPROVIDER_H
#define OPENSWMMVIS_PATTERN_PATTERNPROVIDER_H
 
#include <QObject>
#include <QString>
#include <QVector>
 
namespace openswmmvis::pattern {
 
enum class PatternType {
    Monthly = 0,    
    Daily   = 1,    
    Hourly  = 2,    
    Weekend = 3,    
};
 
class PatternProvider : public QObject
{
    Q_OBJECT
 
public:
    PatternProvider(QString name, PatternType type, QObject *parent = nullptr);
    ~PatternProvider() override;
 
    // ── Identity / metadata ─────────────────────────────────────────────────
 
    QString name() const noexcept { return m_name; }
 
    PatternType type() const noexcept { return m_type; }
 
    static int factorCountFor(PatternType t) noexcept;
 
    int factorCount() const noexcept { return factorCountFor(m_type); }
 
    static QString rowLabel(PatternType t, int i);
 
    // ── Factor access ───────────────────────────────────────────────────────
 
    double factor(int i) const { return m_factors.at(i); }
 
    const QVector<double>& factors() const noexcept { return m_factors; }
 
    double sumOfFactors() const noexcept;
 
    // ── Mutators (return false + emit mutationRejected on invariant violation) ──
 
    bool setFactor(int i, double v, QString *reasonOut = nullptr);
 
    bool setFactorLive(int i, double v);
 
    bool setAllFactors(QVector<double> f, QString *reasonOut = nullptr);
 
    bool normalize(double targetSum = 1.0, QString *reasonOut = nullptr);
 
    bool swapFactors(int i, int j, QString *reasonOut = nullptr);
 
    void setName(QString newName);
 
    void setType(PatternType t);
 
signals:
    void factorChanged(int i);
 
    void factorsChanged();
 
    void nameChanged(QString prev, QString now);
 
    void typeChanged(PatternType prev, PatternType now);
 
    void mutationRejected(QString reason);
 
private:
    QString          m_name;
    PatternType      m_type;
    QVector<double>  m_factors;     
};
 
} // namespace openswmmvis::pattern
 
#endif // OPENSWMMVIS_PATTERN_PATTERNPROVIDER_H