OpenSWMM Engine  6.0.0-alpha.1
Data-oriented, plugin-extensible SWMM Engine (6.0.0-alpha.1)
Loading...
Searching...
No Matches
ObjectDeleter.hpp File Reference

Internal C++ API for object deletion and cascade analysis. More...

#include "../core/SimulationContext.hpp"
#include <vector>
Include dependency graph for ObjectDeleter.hpp:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  openswmm::edit::CascadeEntry
 Describes one object that was impacted (deleted or nullified) during a cascade deletion. More...
 
struct  openswmm::edit::CascadeResult
 Aggregate cascade result for one deletion operation. More...
 

Namespaces

namespace  openswmm
 
namespace  openswmm::edit
 

Functions

CascadeResult openswmm::edit::analyze_node_impact (const SimulationContext &ctx, int node_idx)
 
CascadeResult openswmm::edit::analyze_link_impact (const SimulationContext &ctx, int link_idx)
 
CascadeResult openswmm::edit::analyze_subcatch_impact (const SimulationContext &ctx, int sc_idx)
 
CascadeResult openswmm::edit::analyze_gage_impact (const SimulationContext &ctx, int gage_idx)
 
CascadeResult openswmm::edit::analyze_table_impact (const SimulationContext &ctx, int table_idx)
 
CascadeResult openswmm::edit::analyze_transect_impact (const SimulationContext &ctx, int transect_idx)
 
CascadeResult openswmm::edit::delete_node (SimulationContext &ctx, int node_idx)
 
CascadeResult openswmm::edit::delete_link (SimulationContext &ctx, int link_idx)
 
CascadeResult openswmm::edit::delete_subcatch (SimulationContext &ctx, int sc_idx)
 
CascadeResult openswmm::edit::delete_gage (SimulationContext &ctx, int gage_idx)
 
CascadeResult openswmm::edit::delete_table (SimulationContext &ctx, int table_idx)
 
CascadeResult openswmm::edit::delete_transect (SimulationContext &ctx, int transect_idx)
 

Detailed Description

Internal C++ API for object deletion and cascade analysis.

Provides non-destructive impact analysis and destructive deletion for all major object types in a SimulationContext. All mutating functions require the context to be in BUILDING or OPENED state (enforced by the C ABI wrapper in openswmm_edit_impl.cpp, NOT here).

Author
Caleb Buahin caleb.nosp@m..bua.nosp@m.hin@g.nosp@m.mail.nosp@m..com
License\n MIT License