ObjectDeleter.hpp File Reference

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

#include "../core/SimulationContext.hpp"
#include <string>
#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)
	Inspect references to a node.
CascadeResult	openswmm::edit::analyze_link_impact (const SimulationContext &ctx, int link_idx)
	Inspect references to a link.
CascadeResult	openswmm::edit::analyze_subcatch_impact (const SimulationContext &ctx, int sc_idx)
	Inspect references to a subcatchment.
CascadeResult	openswmm::edit::analyze_gage_impact (const SimulationContext &ctx, int gage_idx)
	Inspect references to a rain gage.
CascadeResult	openswmm::edit::analyze_table_impact (const SimulationContext &ctx, int table_idx)
	Inspect references to a time-series/curve table.
CascadeResult	openswmm::edit::analyze_transect_impact (const SimulationContext &ctx, int transect_idx)
	Inspect references to a transect.
CascadeResult	openswmm::edit::analyze_pollutant_impact (const SimulationContext &ctx, int pollut_idx)
	Inspect references to a pollutant.
CascadeResult	openswmm::edit::analyze_pattern_impact (const SimulationContext &ctx, int pattern_idx)
	Inspect references to a time pattern.
CascadeResult	openswmm::edit::analyze_aquifer_impact (const SimulationContext &ctx, int aquifer_idx)
	Inspect references to a aquifer.
CascadeResult	openswmm::edit::analyze_snowpack_impact (const SimulationContext &ctx, int snowpack_idx)
	Inspect references to a snowpack.
CascadeResult	openswmm::edit::analyze_lid_impact (const SimulationContext &ctx, int lid_idx)
	Inspect references to a LID control.
CascadeResult	openswmm::edit::analyze_street_impact (const SimulationContext &ctx, int street_idx)
	Inspect references to a street.
CascadeResult	openswmm::edit::analyze_inlet_impact (const SimulationContext &ctx, int inlet_idx)
	Inspect references to a inlet design.
CascadeResult	openswmm::edit::analyze_landuse_impact (const SimulationContext &ctx, int landuse_idx)
	Inspect references to a land use.
CascadeResult	openswmm::edit::analyze_hydrograph_impact (const SimulationContext &ctx, const std::string &uh_name)
	Inspect RDII references to an exact-case hydrograph group.
std::vector< int >	openswmm::edit::find_control_rule_refs (const SimulationContext &ctx, const std::string &object_name)
	Find stored rule-text tokens naming an object after an object keyword.
CascadeResult	openswmm::edit::delete_node (SimulationContext &ctx, int node_idx)
	Delete a node.
CascadeResult	openswmm::edit::delete_link (SimulationContext &ctx, int link_idx)
	Delete a link.
CascadeResult	openswmm::edit::delete_subcatch (SimulationContext &ctx, int sc_idx)
	Delete a subcatchment.
CascadeResult	openswmm::edit::delete_gage (SimulationContext &ctx, int gage_idx)
	Delete a rain gage.
CascadeResult	openswmm::edit::delete_nodes_many (SimulationContext &ctx, std::vector< int > indices)
	Delete node rows in deduplicated descending pre-batch order.
CascadeResult	openswmm::edit::delete_links_many (SimulationContext &ctx, std::vector< int > indices)
	Delete link rows in deduplicated descending pre-batch order.
CascadeResult	openswmm::edit::delete_subcatches_many (SimulationContext &ctx, std::vector< int > indices)
	Delete subcatchment rows in deduplicated descending pre-batch order.
CascadeResult	openswmm::edit::delete_gages_many (SimulationContext &ctx, std::vector< int > indices)
	Delete rain gage rows in deduplicated descending pre-batch order.
CascadeResult	openswmm::edit::delete_table (SimulationContext &ctx, int table_idx)
	Delete a time-series/curve table.
CascadeResult	openswmm::edit::delete_transect (SimulationContext &ctx, int transect_idx)
	Delete a transect.
CascadeResult	openswmm::edit::delete_pollutant (SimulationContext &ctx, int pollut_idx)
	Delete a pollutant.
CascadeResult	openswmm::edit::delete_pattern (SimulationContext &ctx, int pattern_idx)
	Delete a time pattern.
CascadeResult	openswmm::edit::delete_aquifer (SimulationContext &ctx, int aquifer_idx)
	Delete a aquifer.
CascadeResult	openswmm::edit::delete_snowpack (SimulationContext &ctx, int snowpack_idx)
	Delete a snowpack.
CascadeResult	openswmm::edit::delete_lid (SimulationContext &ctx, int lid_idx)
	Delete a LID control.
CascadeResult	openswmm::edit::delete_street (SimulationContext &ctx, int street_idx)
	Delete a street.
CascadeResult	openswmm::edit::delete_inlet (SimulationContext &ctx, int inlet_idx)
	Delete a inlet design.
CascadeResult	openswmm::edit::delete_landuse (SimulationContext &ctx, int landuse_idx)
	Delete a land use.
CascadeResult	openswmm::edit::delete_hydrograph (SimulationContext &ctx, const std::string &uh_name)
	Delete all authoring rows belonging to an exact-case hydrograph group.

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

Copyright

Copyright (c) 2026 Caleb Buahin. All rights reserved.

License

Apache-2.0