Spatial frame containing CRS and georeferenced coordinates. More...

#include <SpatialFrame.hpp>

Collaboration diagram for openswmm::SpatialFrame:

Public Member Functions
void	register_coupling_point (ICouplingPoint *point)
	Append a borrowed coupling point without deduplication.

bool	has_2d_coupling () const noexcept
	Check whether the registration vector contains any entries.

void	shrink_to_fit ()
	Request capacity reduction for coordinate and vertex arrays.

Public Attributes
std::string	crs
	CRS specification string.

bool	is_geographic = false
	True if the CRS represents geographic coordinates (lon/lat).

double	map_x1 = 0.0
	Map extent minimum X (left).

double	map_y1 = 0.0
	Map extent minimum Y (bottom).

double	map_x2 = 0.0
	Map extent maximum X (right).

double	map_y2 = 0.0
	Map extent maximum Y (top).

std::string	map_units
	Map units string from [MAP] UNITS keyword.

std::vector< double >	node_x
	Node X coordinates (easting or longitude).

std::vector< double >	node_y
	Node Y coordinates (northing or latitude).

std::vector< uint8_t >	node_has_xy
	G-X2 (2026-09-19): 1 when the node's coordinates were authored ([COORDINATES], the GeoPackage geometry, the spatial C API or a virtual-junction split). A node whose entry is 0 sits at the (0, 0) fill and must not be located on a mesh by it. Sized with node_x.

std::vector< double >	link_x
	Link centroid X coordinates.

std::vector< double >	link_y
	Link centroid Y coordinates.

std::vector< double >	subcatch_x
	Subcatchment centroid X.

std::vector< double >	subcatch_y
	Subcatchment centroid Y.

std::vector< std::vector< double > >	link_vertices_x
	Per-link X vertices. link_vertices_x[link_idx] is a vector of X coords.

std::vector< std::vector< double > >	link_vertices_y
	Per-link Y vertices. link_vertices_y[link_idx] is a vector of Y coords.

std::vector< std::vector< double > >	subcatch_polygon_x
	Per-subcatchment X vertices. Multiple rings are concatenated with explicit closures; the final ring may be open.

std::vector< std::vector< double > >	subcatch_polygon_y
	Per-subcatchment polygon Y vertices.

std::vector< double >	gage_x
	Gage X coordinates.

std::vector< double >	gage_y
	Gage Y coordinates.

std::vector< ICouplingPoint * >	coupling_points
	Registered 2D coupling points.

Detailed Description

Spatial frame containing CRS and georeferenced coordinates.

Coordinates are stored in the CRS specified by the crs field. If crs is empty, coordinates are in model units (as in legacy SWMM).

Arrays are indexed identically to the corresponding SoA data stores (NodeData, LinkData, SubcatchData). Index i in node_x corresponds to node i in NodeData.

Member Function Documentation

◆ has_2d_coupling()

bool openswmm::SpatialFrame::has_2d_coupling ( ) const

inlinenoexcept

Check whether the registration vector contains any entries.

Returns: True when coupling_points is nonempty; does not validate object indices, point lifetime or solver wiring.

◆ register_coupling_point()

void openswmm::SpatialFrame::register_coupling_point ( ICouplingPoint * point )

inline

Append a borrowed coupling point without deduplication.

Does not invoke exchange methods, locate the object on a mesh or take ownership. Caller serializes vector mutation and traversal.

Parameters

[in] point Non-owning pointer that must outlive all uses of the frame entry; NULL is ignored.

◆ shrink_to_fit()

void openswmm::SpatialFrame::shrink_to_fit ( )

inline

Request capacity reduction for coordinate and vertex arrays.

Preserves values but can invalidate references, pointers and iterators if a vector reallocates. Visits outer and inner geometry vectors; node_has_xy and coupling_points are not compacted. Standard vector capacity requests need not reduce allocation.

Member Data Documentation

◆ coupling_points

std::vector<ICouplingPoint*> openswmm::SpatialFrame::coupling_points

Registered 2D coupling points.

2D components register ICouplingPoint objects here to establish exchange at specific 1D objects. Registration stores the pointers only; a driver integrating this interface must invoke exchange_to_2d()/receive_from_2d() explicitly. The concrete SurfaceRouter2D uses its own coupling data structures.

Not owned — the 2D component manages the lifetime of these objects.

◆ crs

std::string openswmm::SpatialFrame::crs

CRS specification string.

EPSG code (e.g., "EPSG:4326") or PROJ string (e.g., "+proj=utm +zone=33 +datum=WGS84"). Empty string means no CRS is specified (legacy behavior).

Set from the CRS key in [OPTIONS]:

[OPTIONS]

CRS EPSG:4326

◆ gage_x

std::vector<double> openswmm::SpatialFrame::gage_x

Gage X coordinates.

◆ gage_y

std::vector<double> openswmm::SpatialFrame::gage_y

Gage Y coordinates.

◆ is_geographic

bool openswmm::SpatialFrame::is_geographic = false

True if the CRS represents geographic coordinates (lon/lat).

Used for distance calculations and 2D coupling.

◆ link_vertices_x

std::vector<std::vector<double> > openswmm::SpatialFrame::link_vertices_x

Per-link X vertices. link_vertices_x[link_idx] is a vector of X coords.

◆ link_vertices_y

std::vector<std::vector<double> > openswmm::SpatialFrame::link_vertices_y

Per-link Y vertices. link_vertices_y[link_idx] is a vector of Y coords.

◆ link_x

std::vector<double> openswmm::SpatialFrame::link_x

Link centroid X coordinates.

◆ link_y

std::vector<double> openswmm::SpatialFrame::link_y

Link centroid Y coordinates.

◆ map_units

std::string openswmm::SpatialFrame::map_units

Map units string from [MAP] UNITS keyword.

Typically NONE, FEET, METERS, or DEGREES.

◆ map_x1

double openswmm::SpatialFrame::map_x1 = 0.0

Map extent minimum X (left).

◆ map_x2

double openswmm::SpatialFrame::map_x2 = 0.0

Map extent maximum X (right).

◆ map_y1

double openswmm::SpatialFrame::map_y1 = 0.0

Map extent minimum Y (bottom).

◆ map_y2

double openswmm::SpatialFrame::map_y2 = 0.0

Map extent maximum Y (top).

◆ node_has_xy

std::vector<uint8_t> openswmm::SpatialFrame::node_has_xy

G-X2 (2026-09-19): 1 when the node's coordinates were authored ([COORDINATES], the GeoPackage geometry, the spatial C API or a virtual-junction split). A node whose entry is 0 sits at the (0, 0) fill and must not be located on a mesh by it. Sized with node_x.

◆ node_x

std::vector<double> openswmm::SpatialFrame::node_x

Node X coordinates (easting or longitude).

◆ node_y

std::vector<double> openswmm::SpatialFrame::node_y

Node Y coordinates (northing or latitude).

◆ subcatch_polygon_x

std::vector<std::vector<double> > openswmm::SpatialFrame::subcatch_polygon_x

Per-subcatchment X vertices. Multiple rings are concatenated with explicit closures; the final ring may be open.

◆ subcatch_polygon_y

std::vector<std::vector<double> > openswmm::SpatialFrame::subcatch_polygon_y

Per-subcatchment polygon Y vertices.

◆ subcatch_x

std::vector<double> openswmm::SpatialFrame::subcatch_x

Subcatchment centroid X.

◆ subcatch_y

std::vector<double> openswmm::SpatialFrame::subcatch_y

Subcatchment centroid Y.

The documentation for this struct was generated from the following file:

/home/runner/work/openswmm.engine/openswmm.engine/src/engine/core/SpatialFrame.hpp

Public Member Functions

Public Attributes