openswmm_edit.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_EDIT_H
#define OPENSWMM_EDIT_H
 
#include "openswmm_engine.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* =========================================================================
 * Impact report — returned by analyze_impact and delete functions
 * ========================================================================= */

typedef enum SWMM_RefType {
    SWMM_REF_NODE         = 0,  
    SWMM_REF_LINK         = 1,  
    SWMM_REF_SUBCATCH     = 2,  
    SWMM_REF_GAGE         = 3,  
    SWMM_REF_TABLE        = 4,  
    SWMM_REF_TRANSECT     = 5,  
    SWMM_REF_INLET_USAGE  = 6,  
    SWMM_REF_EXT_INFLOW   = 7,  
    SWMM_REF_DWF_INFLOW   = 8,  
    SWMM_REF_RDII_ASSIGN  = 9,  
    SWMM_REF_TREATMENT    = 10, 
    SWMM_REF_LID_USAGE    = 11, 
    SWMM_REF_SNOWPACK     = 12, 
    SWMM_REF_HYDROGRAPH   = 13, 
    SWMM_REF_POLLUTANT    = 14, 
    SWMM_REF_PATTERN      = 15, 
    SWMM_REF_AQUIFER      = 16, 
    SWMM_REF_LID_CONTROL  = 17, 
    SWMM_REF_STREET       = 18, 
    SWMM_REF_INLET_DESIGN = 19, 
    SWMM_REF_LANDUSE      = 20, 
    SWMM_REF_CONTROL_RULE = 21  
} SWMM_RefType;

typedef struct SWMM_ImpactEntry {
    int         obj_type;  
    int         obj_idx;   
    const char* field;     
    int         cascaded;  
} SWMM_ImpactEntry;

typedef struct SWMM_ImpactReport {
    SWMM_ImpactEntry* entries;   
    int               n_entries; 
} SWMM_ImpactReport;

SWMM_ENGINE_API void swmm_impact_report_free(SWMM_ImpactReport* report);
 
/* =========================================================================
 * Impact analysis — read-only, works in any state where data exists
 * ========================================================================= */

SWMM_ENGINE_API int swmm_node_analyze_impact(
    SWMM_Engine engine, int idx, SWMM_ImpactReport* report_out);

SWMM_ENGINE_API int swmm_link_analyze_impact(
    SWMM_Engine engine, int idx, SWMM_ImpactReport* report_out);

SWMM_ENGINE_API int swmm_subcatch_analyze_impact(
    SWMM_Engine engine, int idx, SWMM_ImpactReport* report_out);

SWMM_ENGINE_API int swmm_gage_analyze_impact(
    SWMM_Engine engine, int idx, SWMM_ImpactReport* report_out);

SWMM_ENGINE_API int swmm_table_analyze_impact(
    SWMM_Engine engine, int idx, SWMM_ImpactReport* report_out);

SWMM_ENGINE_API int swmm_transect_analyze_impact(
    SWMM_Engine engine, int idx, SWMM_ImpactReport* report_out);

SWMM_ENGINE_API int swmm_pollutant_analyze_impact(
    SWMM_Engine engine, int idx, SWMM_ImpactReport* report_out);

SWMM_ENGINE_API int swmm_pattern_analyze_impact(
    SWMM_Engine engine, int idx, SWMM_ImpactReport* report_out);

SWMM_ENGINE_API int swmm_aquifer_analyze_impact(
    SWMM_Engine engine, int idx, SWMM_ImpactReport* report_out);

SWMM_ENGINE_API int swmm_snowpack_analyze_impact(
    SWMM_Engine engine, int idx, SWMM_ImpactReport* report_out);

SWMM_ENGINE_API int swmm_lid_analyze_impact(
    SWMM_Engine engine, int idx, SWMM_ImpactReport* report_out);

SWMM_ENGINE_API int swmm_street_analyze_impact(
    SWMM_Engine engine, int idx, SWMM_ImpactReport* report_out);

SWMM_ENGINE_API int swmm_inlet_analyze_impact(
    SWMM_Engine engine, int idx, SWMM_ImpactReport* report_out);

SWMM_ENGINE_API int swmm_landuse_analyze_impact(
    SWMM_Engine engine, int idx, SWMM_ImpactReport* report_out);

SWMM_ENGINE_API int swmm_hydrograph_analyze_impact(
    SWMM_Engine engine, const char* uh_name, SWMM_ImpactReport* report_out);
 
/* =========================================================================
 * Deletion — BUILDING or OPENED state only
 * ========================================================================= */

SWMM_ENGINE_API int swmm_node_delete(
    SWMM_Engine engine, int idx, SWMM_ImpactReport* cascade_out);

SWMM_ENGINE_API int swmm_link_delete(
    SWMM_Engine engine, int idx, SWMM_ImpactReport* cascade_out);

SWMM_ENGINE_API int swmm_subcatch_delete(
    SWMM_Engine engine, int idx, SWMM_ImpactReport* cascade_out);

SWMM_ENGINE_API int swmm_gage_delete(
    SWMM_Engine engine, int idx, SWMM_ImpactReport* cascade_out);

SWMM_ENGINE_API int swmm_node_delete_many(
    SWMM_Engine engine, const int* indices, int n,
    SWMM_ImpactReport* cascade_out);

SWMM_ENGINE_API int swmm_link_delete_many(
    SWMM_Engine engine, const int* indices, int n,
    SWMM_ImpactReport* cascade_out);

SWMM_ENGINE_API int swmm_subcatch_delete_many(
    SWMM_Engine engine, const int* indices, int n,
    SWMM_ImpactReport* cascade_out);

SWMM_ENGINE_API int swmm_gage_delete_many(
    SWMM_Engine engine, const int* indices, int n,
    SWMM_ImpactReport* cascade_out);

SWMM_ENGINE_API int swmm_table_delete(
    SWMM_Engine engine, int idx, SWMM_ImpactReport* cascade_out);

SWMM_ENGINE_API int swmm_transect_delete(
    SWMM_Engine engine, int idx, SWMM_ImpactReport* cascade_out);

SWMM_ENGINE_API int swmm_pollutant_delete(
    SWMM_Engine engine, int idx, SWMM_ImpactReport* cascade_out);

SWMM_ENGINE_API int swmm_pattern_delete(
    SWMM_Engine engine, int idx, SWMM_ImpactReport* cascade_out);

SWMM_ENGINE_API int swmm_aquifer_delete(
    SWMM_Engine engine, int idx, SWMM_ImpactReport* cascade_out);

SWMM_ENGINE_API int swmm_snowpack_delete(
    SWMM_Engine engine, int idx, SWMM_ImpactReport* cascade_out);

SWMM_ENGINE_API int swmm_lid_delete(
    SWMM_Engine engine, int idx, SWMM_ImpactReport* cascade_out);

SWMM_ENGINE_API int swmm_street_delete(
    SWMM_Engine engine, int idx, SWMM_ImpactReport* cascade_out);

SWMM_ENGINE_API int swmm_inlet_delete(
    SWMM_Engine engine, int idx, SWMM_ImpactReport* cascade_out);

SWMM_ENGINE_API int swmm_landuse_delete(
    SWMM_Engine engine, int idx, SWMM_ImpactReport* cascade_out);

SWMM_ENGINE_API int swmm_hydrograph_delete(
    SWMM_Engine engine, const char* uh_name, SWMM_ImpactReport* cascade_out);
 
/* =========================================================================
 * Type conversion result — returned by convert functions
 * ========================================================================= */

typedef struct SWMM_ConversionResult {
    int          new_type;       
    const char** cleared_fields; 
    int          n_cleared;      
    const char** warnings;       
    int          n_warnings;     
} SWMM_ConversionResult;

SWMM_ENGINE_API void swmm_conversion_result_free(SWMM_ConversionResult* result);
 
/* =========================================================================
 * Type conversion — BUILDING or OPENED state only
 * ========================================================================= */

SWMM_ENGINE_API int swmm_node_convert(
    SWMM_Engine engine, int idx, int new_type,
    SWMM_ConversionResult* result_out);

SWMM_ENGINE_API int swmm_link_convert(
    SWMM_Engine engine, int idx, int new_type,
    SWMM_ConversionResult* result_out);
 
/* =========================================================================
 * Conduit split / virtual-junction fusion — BUILDING or OPENED state only
 * (refactored engine only; see openswmm_nodes.h swmm_node_set_virtual)
 * ========================================================================= */

SWMM_ENGINE_API int swmm_conduit_split(
    SWMM_Engine engine, int link_idx, double t,
    const char* new_node_name, const char* new_link_name,
    int make_virtual, int* new_node_idx, int* new_link_idx);

SWMM_ENGINE_API int swmm_virtual_junction_fuse(
    SWMM_Engine engine, int node_idx, int* surviving_link_idx);

SWMM_ENGINE_API int swmm_conduit_split_inlet(
    SWMM_Engine engine, int link_idx, double t,
    const char* new_node_name, const char* new_link_name,
    const char* inlet_id, const char* capture_node,
    int* new_node_idx, int* new_link_idx);

SWMM_ENGINE_API int swmm_inlet_junction_fuse(
    SWMM_Engine engine, int node_idx, int* surviving_link_idx);
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* OPENSWMM_EDIT_H */