SpatialFrame.hpp

Go to the documentation of this file.

 
#ifndef OPENSWMM_ENGINE_SPATIAL_FRAME_HPP
#define OPENSWMM_ENGINE_SPATIAL_FRAME_HPP
 
#include <string>
#include <vector>
#include <cstdint>
 
namespace openswmm {
 
// ============================================================================
// Forward declarations for 2D coupling (R30)
// ============================================================================
 
class ICouplingPoint {
public:
    virtual ~ICouplingPoint() = default;
 
    virtual int object_index() const noexcept = 0;
 
    virtual const char* object_type() const noexcept = 0;
 
    virtual void exchange_to_2d(double value) = 0;
 
    virtual double receive_from_2d() const = 0;
};
 
// ============================================================================
// SpatialFrame
// ============================================================================
 
struct SpatialFrame {
    // -----------------------------------------------------------------------
    // Coordinate reference system
    // -----------------------------------------------------------------------
 
    std::string crs;
 
    bool is_geographic = false;
 
    // -----------------------------------------------------------------------
    // Node coordinates (indexed parallel to NodeData)
    // -----------------------------------------------------------------------
 
    std::vector<double> node_x;
 
    std::vector<double> node_y;
 
    // -----------------------------------------------------------------------
    // Link coordinates (one point per link — nominal centroid or from-node)
    // -----------------------------------------------------------------------
 
    std::vector<double> link_x;
 
    std::vector<double> link_y;
 
    // -----------------------------------------------------------------------
    // Subcatchment centroid coordinates
    // -----------------------------------------------------------------------
 
    std::vector<double> subcatch_x;
 
    std::vector<double> subcatch_y;
 
    // -----------------------------------------------------------------------
    // Link vertices (polyline points between from-node and to-node)
    // -----------------------------------------------------------------------
 
    std::vector<std::vector<double>> link_vertices_x;
 
    std::vector<std::vector<double>> link_vertices_y;
 
    // -----------------------------------------------------------------------
    // Subcatchment polygon vertices
    // -----------------------------------------------------------------------
 
    std::vector<std::vector<double>> subcatch_polygon_x;
 
    std::vector<std::vector<double>> subcatch_polygon_y;
 
    // -----------------------------------------------------------------------
    // Gage coordinates
    // -----------------------------------------------------------------------
 
    std::vector<double> gage_x;
 
    std::vector<double> gage_y;
 
    // -----------------------------------------------------------------------
    // 2D coupling interface (R30)
    // -----------------------------------------------------------------------
 
    std::vector<ICouplingPoint*> coupling_points;
 
    void register_coupling_point(ICouplingPoint* point) {
        if (point) coupling_points.push_back(point);
    }
 
    bool has_2d_coupling() const noexcept {
        return !coupling_points.empty();
    }
};
 
} /* namespace openswmm */
 
#endif /* OPENSWMM_ENGINE_SPATIAL_FRAME_HPP */