simulationoptionsdialog.h

Go to the documentation of this file.

 
#ifndef SIMULATIONOPTIONSDIALOG_H
#define SIMULATIONOPTIONSDIALOG_H
 
#include <QDateTime>
#include <QDialog>
#include <QList>
#include <QPair>
#include <QString>
#include <QStringList>
 
class QCheckBox;
class QComboBox;
class QGroupBox;
class QDateEdit;
class QDateTimeEdit;
class QDoubleSpinBox;
class QLabel;
class QLineEdit;
class QPushButton;
class QSpinBox;
class QTableView;
class QTableWidget;
class QTabWidget;
class QListWidget;
class QStackedWidget;
class QTextEdit;
class QToolButton;
class QAction;
class QButtonGroup;
class QRadioButton;
class QCustomTimespanEdit;
 
class SWMMModelLayer;
class SWMMVisProjectWindow;
class HotstartSavesModel;
class HotstartSavesDateTimeDelegate;
class PathBrowseDelegate;
class PluginsTableModel;
class ProcessComponentsModel;
class ProcessComponentIdDelegate;
 
namespace openswmmvis::ui {
    class RelativePathPicker;
}
 
#include <openswmm/engine/openswmm_engine.h>
 
#include <memory>
 
#include <QVector>
 
#include <functional>
 
#include "ui/dialogs/simoptions/enginecapabilities.h"
// Full definition, not a forward declaration: the dialog holds a
// unique_ptr<SimOptionsContext> and its destructor is inline (moc vtable).
#include "ui/dialogs/simoptions/simoptionscontext.h"
 
namespace openswmmvis::ui {
class SimOptionsPage;
class DatesPage;
class FilesPage;
class HydraulicsPage;
class MeshPage;
class ModelsPage;
class PerformancePage;
class QualityPage;
class SpatialPage;
class TitleNotesPage;
class TwoDPage;
}
 
class SimulationOptionsDialog : public QDialog
{
    Q_OBJECT
 
public:
    explicit SimulationOptionsDialog(SWMM_Engine engine,
                                     SWMMModelLayer *layer = nullptr,
                                     const QString &engineVersion = QStringLiteral("6.0.0"),
                                     SWMMVisProjectWindow *projectWindow = nullptr,
                                     QWidget *parent = nullptr);
    // Inline so leaf tests that only compile simulationoptionshelpers.cpp can
    // still link the moc-generated vtable. Defining it out-of-line in the
    // main .cpp would force the test to drag in the entire dialog (and its
    // OGR/GDAL deps via the spatial-tab code).
    ~SimulationOptionsDialog() override = default;
 
    [[nodiscard]] bool wroteAnyChanges() const { return m_wroteChanges; }
 
    [[nodiscard]] QStringList lastWriteKeys() const;
 
    // ---- Pure helpers (testable without an engine) ------------------------
 
    [[nodiscard]] static int parseEngineBool(const QString &s);
 
    [[nodiscard]] static QString engineBoolString(bool on);
 
    static void fastPresetValues(int &out_threads, double &out_min_step_sec);
 
    static int fastPresetThreads();
 
    static QString threadLimitsSummary(const SWMM_ThreadInfo &ti);
 
    static void formatEngineDateTime(const QDateTime &dt,
                                     QString &out_date,
                                     QString &out_time);
 
    [[nodiscard]] static QDateTime parseEngineDateTime(const QString &date,
                                                       const QString &time);
 
    [[nodiscard]] static double    oaDateFromQDateTime(const QDateTime &dt);
 
    [[nodiscard]] static QDateTime qDateTimeFromOaDate(double oa);
 
    [[nodiscard]] static qint64 parseStepSeconds(const QString &s,
                                                 qint64 fallback);
 
    [[nodiscard]] static bool optionValueEquals(const QString &a,
                                                const QString &b);
 
    [[nodiscard]] static QList<int> selectedRowsDescending(
        const QTableWidget *table);
 
private slots:
    void onApply();
    void onAccept();
 
private:
    bool confirmBeforeWrite();
 
    void applyEngineConstraints();
 
    void buildUi();
 
    struct PageGate {
        enum class Target { SidebarRow, Tab, Widget };
        Target                target   = Target::Widget;
        int                   row      = -1;
        QTabWidget           *tabs     = nullptr;
        int                   tabIndex = -1;
        QWidget              *widget   = nullptr;
        std::function<bool()> enabled;
        QString               reasonWhenOff;
    };
 
    void refreshGates();     
    void buildGateTable();   
 
    void addCategory(const QString &title, QWidget *page);
    void addPage(openswmmvis::ui::SimOptionsPage *page);
 
    void readFromEngine();
    int  writeToEngine();   
 
    SWMM_Engine     m_engine = nullptr;
    SWMMModelLayer *m_layer  = nullptr;
    SWMMVisProjectWindow *m_projectWindow = nullptr;  
    QString         m_engineVersion;        
    bool            m_wroteChanges = false;
 
    // ---- sidebar rows the gate table names ------------------------------
    int             m_2DRow          = -1;   
    int             m_meshRow        = -1;   
    int             m_qualityRow     = -1;   
    int             m_hydraulicsRow  = -1;   
    QVector<PageGate> m_gates;               
    QListWidget    *m_categoryList   = nullptr;   
    QStackedWidget *m_pages          = nullptr;   
 
    // ---- page registry ---------------------------------------------------
    openswmmvis::ui::EngineCapabilities        m_caps;       
    std::unique_ptr<openswmmvis::ui::SimOptionsContext> m_ctx;
    QVector<openswmmvis::ui::SimOptionsPage *> m_pageOrder;  
    // Pages the dialog talks to by name — every one of these is either a gate
    // input, a gate target, or one half of a cross-page hook (PLAN §4.1).
    openswmmvis::ui::DatesPage                *m_datesPage      = nullptr;
    openswmmvis::ui::FilesPage                *m_filesPage      = nullptr;
    openswmmvis::ui::HydraulicsPage           *m_hydraulicsPage = nullptr;
    openswmmvis::ui::ModelsPage               *m_modelsPage     = nullptr;
    openswmmvis::ui::QualityPage              *m_qualityPage    = nullptr;
    openswmmvis::ui::SpatialPage              *m_spatialPage    = nullptr;
#ifdef OPENSWMM_HAS_2D
    openswmmvis::ui::TwoDPage                 *m_twoDPage       = nullptr;
#endif
};
 
#endif // SIMULATIONOPTIONSDIALOG_H