openswmm_spatial.h

Go to the documentation of this file.

// SPDX-License-Identifier: Apache-2.0
//
// Copyright 2026 Caleb Buahin
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

 
#ifndef OPENSWMM_SPATIAL_H
#define OPENSWMM_SPATIAL_H
 
#include "openswmm_engine.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* =========================================================================
 * CRS (Coordinate Reference System)
 * ========================================================================= */

SWMM_ENGINE_API int swmm_spatial_set_crs(SWMM_Engine engine, const char* crs);

SWMM_ENGINE_API int swmm_spatial_get_crs(SWMM_Engine engine, char* buf, int buflen);
 
/* =========================================================================
 * Node coordinates
 * ========================================================================= */

SWMM_ENGINE_API int swmm_spatial_set_node_coord(SWMM_Engine engine, int idx, double x, double y);

SWMM_ENGINE_API int swmm_spatial_node_has_coord(SWMM_Engine engine, int idx, int* present);

SWMM_ENGINE_API int swmm_spatial_get_node_coord(SWMM_Engine engine, int idx, double* x, double* y);

SWMM_ENGINE_API int swmm_spatial_get_node_coords_bulk(SWMM_Engine engine, double* x_buf,
                                                      double* y_buf, int count);

SWMM_ENGINE_API int swmm_spatial_set_node_coords_bulk(SWMM_Engine engine, const double* x_buf,
                                                      const double* y_buf, int count);
 
/* =========================================================================
 * Link coordinates (centroid or midpoint)
 * ========================================================================= */

SWMM_ENGINE_API int swmm_spatial_set_link_coord(SWMM_Engine engine, int idx, double x, double y);

SWMM_ENGINE_API int swmm_spatial_get_link_coord(SWMM_Engine engine, int idx, double* x, double* y);
 
/* =========================================================================
 * Link vertices (polyline)
 * ========================================================================= */

SWMM_ENGINE_API int swmm_spatial_set_link_vertices(SWMM_Engine engine, int idx, const double* x,
                                                   const double* y, int count);

SWMM_ENGINE_API int swmm_spatial_get_link_vertex_count(SWMM_Engine engine, int idx, int* count);

SWMM_ENGINE_API int swmm_spatial_get_link_vertices(SWMM_Engine engine, int idx, double* x,
                                                   double* y, int max_count);
 
/* =========================================================================
 * Subcatchment coordinates (centroid)
 * ========================================================================= */

SWMM_ENGINE_API int swmm_spatial_set_subcatch_coord(SWMM_Engine engine, int idx, double x,
                                                    double y);

SWMM_ENGINE_API int swmm_spatial_get_subcatch_coord(SWMM_Engine engine, int idx, double* x,
                                                    double* y);
 
/* =========================================================================
 * Subcatchment polygon
 * ========================================================================= */

SWMM_ENGINE_API int swmm_spatial_set_subcatch_polygon(SWMM_Engine engine, int idx, const double* x,
                                                      const double* y, int count);

SWMM_ENGINE_API int swmm_spatial_get_subcatch_polygon_count(SWMM_Engine engine, int idx,
                                                            int* count);

SWMM_ENGINE_API int swmm_spatial_get_subcatch_polygon(SWMM_Engine engine, int idx, double* x,
                                                      double* y, int max_count);
 
/* =========================================================================
 * Gage coordinates
 * ========================================================================= */

SWMM_ENGINE_API int swmm_spatial_set_gage_coord(SWMM_Engine engine, int idx, double x, double y);

SWMM_ENGINE_API int swmm_spatial_get_gage_coord(SWMM_Engine engine, int idx, double* x, double* y);
 
/* =========================================================================
 * [MAP] extent and units, and GUI annotation sections
 * (closed C-API gaps 2026-10-11)
 * ========================================================================= */

SWMM_ENGINE_API int swmm_spatial_get_map_dimensions(SWMM_Engine engine, double* x1, double* y1,
                                                    double* x2, double* y2);

SWMM_ENGINE_API int swmm_spatial_set_map_dimensions(SWMM_Engine engine, double x1, double y1,
                                                    double x2, double y2);

SWMM_ENGINE_API int swmm_spatial_get_map_units(SWMM_Engine engine, char* buf, int buflen);

SWMM_ENGINE_API int swmm_spatial_set_map_units(SWMM_Engine engine, const char* units);

SWMM_ENGINE_API int swmm_spatial_get_annotation(SWMM_Engine engine, const char* section, char* buf,
                                                int buflen, int* required);

SWMM_ENGINE_API int swmm_spatial_set_annotation(SWMM_Engine engine, const char* section,
                                                const char* text);
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* OPENSWMM_SPATIAL_H */