openswmm_edit.h

Go to the documentation of this file.

 
#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_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);
 
/* =========================================================================
 * 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_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);
 
/* =========================================================================
 * 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);
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* OPENSWMM_EDIT_H */