simulationstatusmodel.h

Go to the documentation of this file.

 
#ifndef SIMULATIONSTATUSMODEL_H
#define SIMULATIONSTATUSMODEL_H
 
#include <QAbstractItemModel>
#include <QDateTime>
#include <QStringList>
#include <QMap>
#include <QtNumeric>
 
class SWMMVisProjectWindow;  // Forward declaration
 
enum class SimulationJobStatus {
    Idle,       
    Running,
    Success,
    Failed,
    Cancelled
};
 
struct SimulationJobRecord {
    int     id              = -1;
    QString instanceName;           
    QString inpPath;                
    QString engineVersion;          
 
    SimulationJobStatus status      = SimulationJobStatus::Running;
    double  progress                = 0.0;  
 
    // Continuity errors: polled by the runner in the step loop and
    // pushed live during the run, not just at finish.
    double  runoffErrPct            = 0.0;
    double  routingErrPct           = 0.0;
    double  twoDErrPct              = qQNaN(); 
 
    int     errorCode               = 0;
    QString errorMessage;
 
    // Wall-clock timestamps for the run's lifecycle.
    QDateTime startedAt;
    QDateTime finishedAt;
 
    // Simulation timeline (engine-side dates). Start / end are set once
    // from the runner; current is pushed every progress tick directly as
    // a QDateTime (converted from the engine OADate on the worker
    // thread), so the model stores what it receives verbatim.
    QDateTime startSimDate;
    QDateTime endSimDate;
    QDateTime currentSimDate;
 
    double  avgTimestepSec           = 0.0;  
 
    // 2D solver telemetry (swmm_2d_get_run_stats), pushed with each tick.
    QString         twoDBackend;             
    int             twoDMomentum = 0;        
    int             twoDLtsTiers = 0;        
    qint64          twoDSteps    = 0;        
    QVector<qint64> twoDTierCells;           
 
    QStringList warnings;           
    int         droppedWarnings = 0; 
};
 
class SimulationStatusModel : public QAbstractItemModel
{
    Q_OBJECT
 
public:
    static constexpr int ColName        = 0;
    static constexpr int ColStatus      = 1;
    static constexpr int ColProgress    = 2;
    static constexpr int ColStartDate   = 3;
    static constexpr int ColCurrentDate = 4;
    static constexpr int ColEndDate     = 5;
    static constexpr int ColRunoffErr   = 6;
    static constexpr int ColRoutingErr  = 7;
    static constexpr int ColTwoDErr     = 8;
    static constexpr int ColDuration     = 9;
    static constexpr int ColAvgTimestep  = 10;
    static constexpr int ColVersion      = 11;
    static constexpr int Col2DBackend    = 12;   
    static constexpr int ColLtsTiers     = 13;   
    static constexpr int NumColumns      = 14;
 
    explicit SimulationStatusModel(QObject *parent = nullptr);
 
    // ── Public mutators (called from GUI thread via queued signals) ──────────
    int  addJob(const QString &instanceName, const QString &inpPath,
                const QString &engineVersion = QString());
 
    int  addOrReuseJobForModel(SWMMVisProjectWindow *model,
                               const QString &instanceName,
                               const QString &inpPath,
                               const QString &engineVersion = QString());
 
    int  ensureJobForModel(SWMMVisProjectWindow *model,
                           const QString &instanceName,
                           const QString &inpPath,
                           const QString &engineVersion);
 
    void updateProgress(int jobId, double fraction,
                        const QDateTime &currentSimDate,
                        double runoffErrFrac = 0.0,
                        double routingErrFrac = 0.0,
                        double avgTimestepSec = 0.0,
                        double twoDErrFrac = qQNaN());
 
    void updateTwoDSolverStats(int jobId, const QString &backend, int momentum,
                               int ltsTiers, qint64 steps,
                               const QVector<qint64> &tierCells);
 
    void setSimulationDates(int jobId,
                            const QDateTime &startSimDate,
                            const QDateTime &endSimDate);
 
    void addWarning(int jobId, int code, const QString &message);
 
    void finishJob(int jobId, bool success, int errCode, const QString &errMsg,
                   double runoffErrFrac, double routingErrFrac,
                   double twoDErrFrac = qQNaN());
 
    const SimulationJobRecord *jobRecord(int jobId) const;
 
    int jobIdForRow(int row) const;
 
    QList<int> clearJobsForModel(SWMMVisProjectWindow *model);
 
    // ── QAbstractItemModel ───────────────────────────────────────────────────
    QModelIndex index(int row, int column,
                      const QModelIndex &parent = QModelIndex()) const override;
    QModelIndex parent(const QModelIndex &child) const override;
    int  rowCount   (const QModelIndex &parent = QModelIndex()) const override;
    int  columnCount(const QModelIndex &parent = QModelIndex()) const override;
    QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const override;
    QVariant headerData(int section, Qt::Orientation orientation,
                        int role = Qt::DisplayRole) const override;
 
private:
    // sentinel internalId for top-level (job) indices
    static constexpr quintptr kRootId = ~quintptr(0);
 
    int  jobIndexById(int jobId) const;
 
    QList<SimulationJobRecord> m_jobs;
    int m_nextId = 0;
 
    // Mapping from (model instance, engine version) → persistent job ID.
    // Different engine versions for the same model get separate rows.
    QMap<SWMMVisProjectWindow*, QMap<QString, int>> m_modelToJobId;
};
 
#endif // SIMULATIONSTATUSMODEL_H