timeseriesprovider.h

Go to the documentation of this file.

 
#ifndef OPENSWMMVIS_TIMESERIES_TIMESERIESPROVIDER_H
#define OPENSWMMVIS_TIMESERIES_TIMESERIESPROVIDER_H
 
#include <QDateTime>
#include <QObject>
#include <QString>
#include <QVector>
 
namespace openswmmvis::timeseries {
 
struct TimeseriesPoint {
    QDateTime time;
    double    value = 0.0;
};
 
class TimeseriesProvider : public QObject
{
    Q_OBJECT
 
public:
    enum class SourceMode {
        Inline,                 
        ExternalFile,           
        GeopackageObserved      
    };
    Q_ENUM(SourceMode)
 
    
    enum class TimeMode {
        Absolute,   
        Relative,   
        Mixed       
    };
    Q_ENUM(TimeMode)
 
    explicit TimeseriesProvider(QString name, QObject *parent = nullptr);
    ~TimeseriesProvider() override;
 
    // ── Identity / metadata ─────────────────────────────────────────────────
 
    QString name() const noexcept { return m_name; }
 
    QString unitsLabel() const noexcept { return m_unitsLabel; }
 
    QString description() const noexcept { return m_description; }
 
    // ── Source mode + file/gpkg metadata ────────────────────────────────────
 
    SourceMode sourceMode() const noexcept { return m_sourceMode; }
 
    QString filePath() const noexcept { return m_filePath; }
 
    QString columnSelector() const noexcept { return m_columnSelector; }
 
    QDateTime fileMTime() const noexcept { return m_fileMTime; }
 
    // ── Point access ────────────────────────────────────────────────────────
 
    int pointCount() const noexcept { return m_points.size(); }
 
    // ── Lazy cache (Step F — ExternalFile mode only) ────────────────────────
 
    bool isPointCacheLoaded() const noexcept;
 
    void disposePointCache();
 
    const TimeseriesPoint& pointAt(int i) const { return m_points.at(i); }
 
    const QVector<TimeseriesPoint>& points() const noexcept { return m_points; }
 
    // ── Mutators (return false + emit mutationRejected on invariant violation) ──
 
    bool setAllPoints(QVector<TimeseriesPoint> newPoints, QString *reasonOut = nullptr);
 
    bool setValueAt(int i, double newValue, QString *reasonOut = nullptr);
 
    bool setValueLive(int i, double newValue);
 
    bool setPointAt(int i, QDateTime newTime, double newValue, QString *reasonOut = nullptr);
 
    int insertPoint(QDateTime time, double value, QString *reasonOut = nullptr);
 
    void removePointsAt(QVector<int> indices);
 
    // ── Identity / metadata mutators ────────────────────────────────────────
 
    void setName(QString newName);
 
    void setUnitsLabel(QString units);
    void setDescription(QString d);
 
    void setSourceMode(SourceMode mode);
    void setFileSource(QString path, QString columnSelector, QDateTime mtime);
 
    // ── Time mode (relative / absolute authoring form) ──────────────────────
 
    TimeMode timeMode() const noexcept;
 
    int relativeCount() const noexcept { return m_relativeCount; }
 
    QDateTime relativeAnchor() const noexcept { return m_relativeAnchor; }
 
    void setRelativeInfo(int count, QDateTime anchor, int allRelativeIntent = -1);
 
    void setTimeMode(TimeMode mode, QDateTime anchorForRelative = {});
 
signals:
    void timeModeChanged();
 
    void pointsChanged(int firstIndex, int count);
 
    void pointsInserted(int at, int count);
 
    void pointsRemoved(int at, int count);
 
    void metadataChanged();
 
    void sourceModeChanged(SourceMode prev, SourceMode now);
 
    void nameChanged(QString prev, QString now);
 
    void mutationRejected(QString reason);
 
    void pointCacheDisposed();
 
private:
    QString                   m_name;
    QString                   m_unitsLabel;
    QString                   m_description;
    SourceMode                m_sourceMode = SourceMode::Inline;
    QString                   m_filePath;
    QString                   m_columnSelector;
    QDateTime                 m_fileMTime;
    QVector<TimeseriesPoint>  m_points;
 
    // Time-mode state (see the TimeMode enum). m_allRelative is the sticky
    // authoring intent: while true, mutators keep the prefix covering every
    // point (and an empty series stays Relative for its first insert).
    int                       m_relativeCount = 0;
    bool                      m_allRelative = false;
    QDateTime                 m_relativeAnchor;
 
    static bool isStrictMonotone_(const QVector<TimeseriesPoint>& pts);
 
    void reconcileRelativeAfterMutation_(TimeMode prevMode);
};
 
} // namespace openswmmvis::timeseries
 
#endif // OPENSWMMVIS_TIMESERIES_TIMESERIESPROVIDER_H