mesh2dresultsexport.h

Go to the documentation of this file.

 
#ifndef OPENSWMMVIS_IO_MESH2DRESULTSEXPORT_H
#define OPENSWMMVIS_IO_MESH2DRESULTSEXPORT_H
 
#include <QString>
#include <QStringList>
 
#include <functional>
#include <vector>
 
class IMesh2DSource;
 
namespace openswmmvis::io {
 
enum class Mesh2DExportFormat
{
    Shapefile,    
    GeoPackage,   
    GeoTiff       
};
 
enum class Mesh2DInterp
{
    NaturalNeighbour,  
    Idw,               
    GreenGauss         
};
 
enum Mesh2DVariable : unsigned
{
    Mesh2DDepth = 1u << 0,   
    Mesh2DHead  = 1u << 1,   
    Mesh2DVx    = 1u << 2,   
    Mesh2DVy    = 1u << 3,   
    Mesh2DVmag  = 1u << 4    
};
 
constexpr float kMesh2DNoData = -9999.0f;
 
constexpr unsigned kMesh2DMaxVariables = Mesh2DDepth | Mesh2DHead | Mesh2DVmag;
 
struct Mesh2DExportOptions
{
    QString basePath;
 
    Mesh2DExportFormat format = Mesh2DExportFormat::GeoTiff;
 
    unsigned variables = Mesh2DDepth | Mesh2DHead | Mesh2DVmag;
 
    std::vector<int> timeSteps;
 
    bool includeMax = true;
 
    // ── Raster only ────────────────────────────────────────────────────
    double cellSize = 0.0;
    Mesh2DInterp interp = Mesh2DInterp::NaturalNeighbour;
    int idwNeighbours = 8;
    double idwPower = 2.0;
    bool maskDry = true;
};
 
struct Mesh2DExportInputs
{
    IMesh2DSource *source = nullptr;   
    double unitFactor = 1.0;
    double dryDepthM = 1e-4;
    QString srsWkt;
};
 
struct Mesh2DExportReport
{
    QStringList files;      
    QString     error;      
    QStringList warnings;   
};
 
using Mesh2DExportProgress =
    std::function<bool(int done, int total, const QString &what)>;
 
bool exportMesh2DResults(const Mesh2DExportInputs &inputs,
                         const Mesh2DExportOptions &options,
                         const Mesh2DExportProgress &progress,
                         Mesh2DExportReport *report);
 
struct Mesh2DGridHint
{
    double extentWidth  = 0.0;   
    double extentHeight = 0.0;
    double suggestedCellSize = 0.0;
 
    bool isValid() const
    {
        return extentWidth > 0.0 && extentHeight > 0.0 && suggestedCellSize > 0.0;
    }
};
 
Mesh2DGridHint mesh2DGridHint(IMesh2DSource *source, double unitFactor);
 
QString mesh2DVariableKey(Mesh2DVariable variable);
 
QString mesh2DVariableLabel(Mesh2DVariable variable);
 
} // namespace openswmmvis::io
 
#endif // OPENSWMMVIS_IO_MESH2DRESULTSEXPORT_H