mesh2dh5reader.h

Go to the documentation of this file.

 
#ifndef OPENSWMMVIS_IO_MESH2DH5READER_H
#define OPENSWMMVIS_IO_MESH2DH5READER_H
 
#include <QString>
 
#include <array>
#include <cstdint>
#include <map>
#include <string>
#include <vector>
 
namespace openswmmvis::io {
 
struct CoordinateReference
{
    QString crs;                        
    double  metresPerModelUnit = 1.0;   
    QString storedUnits;                
    bool    declared = false;           
};
 
class Mesh2DH5Reader
{
public:
    Mesh2DH5Reader();
    ~Mesh2DH5Reader();
 
    // Non-copyable (owns an HDF5 file handle).
    Mesh2DH5Reader(const Mesh2DH5Reader&) = delete;
    Mesh2DH5Reader& operator=(const Mesh2DH5Reader&) = delete;
 
    bool open(const QString& path);
 
    void close();
 
    bool isOpen() const noexcept { return file_id_ >= 0; }
 
    const QString& path() const noexcept { return path_; }
 
    const QString& lastError() const noexcept { return last_error_; }
 
    // ----- Mesh queries (one-shot; cached after first call) ----------------
 
    static constexpr int kEdgeStride = 4;
 
    int vertexCount() const;
    int triangleCount() const;
    int cellCount() const { return triangleCount(); }
    int displayTriangleCount() const;
    int edgeStride() const;
 
    bool readMeshGeometry(std::vector<double>& vx,
                          std::vector<double>& vy,
                          std::vector<double>& vz) const;
 
    bool readCells(std::vector<std::array<int, 4>>& cells) const;
 
    bool readTriangles(std::vector<std::array<int, 3>>& tris) const;
 
    const std::vector<int>& triangleFaceMap() const { return cached_face_map_; }
 
    bool readCoordinateReference(CoordinateReference& out) const;
 
    // ----- Time-series queries ---------------------------------------------
 
    int timeCount() const;
 
    bool readTimes(std::vector<double>& times) const;
 
    bool readDepthsAt(int timeIdx, std::vector<float>& depths) const;
 
    bool readFaceFieldAt(const char* dataset, int timeIdx,
                         std::vector<float>& values) const;
 
    bool hasFaceField(const char* dataset) const;
 
    bool readFaceEnvelope(const char* dataset, std::vector<float>& values) const;
 
    bool readVertexHeadsAt(int timeIdx, std::vector<double>& heads) const;
 
    bool readVertexSignedDepthsAt(int timeIdx, std::vector<float>& depths) const;
 
    bool readEdgeFluxAt(int timeIdx, std::vector<float>& flux) const;
 
    bool readEdgeGeometry(std::vector<float>& length,
                          std::vector<float>& nx,
                          std::vector<float>& ny) const;
 
private:
    QString    path_;
    int64_t    file_id_ = -1;    // hid_t under the hood (stored as int64_t
                                 // to avoid including <hdf5.h> from this header)
    mutable int   cached_n_vert_ = -1;
    mutable int   cached_n_face_ = -1;
    mutable int   cached_face_width_ = -1;     
    mutable int   cached_has_node_head_ = -1;  
    mutable int   cached_has_node_depth_ = -1; 
    mutable int   cached_has_edge_flux_ = -1;  
    mutable std::map<std::string, bool> cached_has_face_field_; 
    mutable QString last_error_;
    // Connectivity, loaded once by loadCells_(): the file's cells, the
    // display sub-triangle fan and its display-triangle → cell map.
    mutable bool cached_cells_loaded_ = false;
    mutable std::vector<std::array<int, 4>> cached_cells_;
    mutable std::vector<std::array<int, 3>> cached_display_tris_;
    mutable std::vector<int>                cached_face_map_;
 
    bool readDim_(const char* dataset, int axis, int& out) const;
    bool setError_(const QString& msg) const;
    bool loadCells_() const;
};
 
} // namespace openswmmvis::io
 
#endif // OPENSWMMVIS_IO_MESH2DH5READER_H