ObjectDeleter.hpp

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_ENGINE_OBJECT_DELETER_HPP
#define OPENSWMM_ENGINE_OBJECT_DELETER_HPP
 
#include "../core/SimulationContext.hpp"
#include <string>
#include <vector>
 
namespace openswmm::edit {
 
// ============================================================================
// Cascade result
// ============================================================================

struct CascadeEntry {
    int         obj_type;  
    int         obj_idx;   
    const char* field;     
    bool        cascaded;  
};

struct CascadeResult {
    std::vector<CascadeEntry> entries;
 
    void add(int ot, int oi, const char* f, bool deleted) {
        entries.push_back({ot, oi, f, deleted});
    }
};
 
// ============================================================================
// Impact analysis — read-only
// ============================================================================
 
CascadeResult analyze_node_impact    (const SimulationContext& ctx, int node_idx);
CascadeResult analyze_link_impact    (const SimulationContext& ctx, int link_idx);
CascadeResult analyze_subcatch_impact(const SimulationContext& ctx, int sc_idx);
CascadeResult analyze_gage_impact    (const SimulationContext& ctx, int gage_idx);
CascadeResult analyze_table_impact   (const SimulationContext& ctx, int table_idx);
CascadeResult analyze_transect_impact(const SimulationContext& ctx, int transect_idx);
 
CascadeResult analyze_pollutant_impact(const SimulationContext& ctx, int pollut_idx);
CascadeResult analyze_pattern_impact  (const SimulationContext& ctx, int pattern_idx);
CascadeResult analyze_aquifer_impact  (const SimulationContext& ctx, int aquifer_idx);
CascadeResult analyze_snowpack_impact (const SimulationContext& ctx, int snowpack_idx);
CascadeResult analyze_lid_impact      (const SimulationContext& ctx, int lid_idx);
CascadeResult analyze_street_impact   (const SimulationContext& ctx, int street_idx);
CascadeResult analyze_inlet_impact    (const SimulationContext& ctx, int inlet_idx);
CascadeResult analyze_landuse_impact  (const SimulationContext& ctx, int landuse_idx);
CascadeResult analyze_hydrograph_impact(const SimulationContext& ctx, const std::string& uh_name);

std::vector<int> find_control_rule_refs(const SimulationContext& ctx,
                                        const std::string& object_name);
 
// ============================================================================
// Deletion — mutates ctx
// ============================================================================
 
CascadeResult delete_node    (SimulationContext& ctx, int node_idx);
CascadeResult delete_link    (SimulationContext& ctx, int link_idx);
CascadeResult delete_subcatch(SimulationContext& ctx, int sc_idx);
CascadeResult delete_gage    (SimulationContext& ctx, int gage_idx);

CascadeResult delete_nodes_many     (SimulationContext& ctx, std::vector<int> indices);
CascadeResult delete_links_many     (SimulationContext& ctx, std::vector<int> indices);
CascadeResult delete_subcatches_many(SimulationContext& ctx, std::vector<int> indices);
CascadeResult delete_gages_many     (SimulationContext& ctx, std::vector<int> indices);
CascadeResult delete_table   (SimulationContext& ctx, int table_idx);
CascadeResult delete_transect(SimulationContext& ctx, int transect_idx);
 
CascadeResult delete_pollutant(SimulationContext& ctx, int pollut_idx);
CascadeResult delete_pattern  (SimulationContext& ctx, int pattern_idx);
CascadeResult delete_aquifer  (SimulationContext& ctx, int aquifer_idx);
CascadeResult delete_snowpack (SimulationContext& ctx, int snowpack_idx);
CascadeResult delete_lid      (SimulationContext& ctx, int lid_idx);
CascadeResult delete_street   (SimulationContext& ctx, int street_idx);
CascadeResult delete_inlet    (SimulationContext& ctx, int inlet_idx);
CascadeResult delete_landuse  (SimulationContext& ctx, int landuse_idx);
CascadeResult delete_hydrograph(SimulationContext& ctx, const std::string& uh_name);
 
} // namespace openswmm::edit
 
#endif /* OPENSWMM_ENGINE_OBJECT_DELETER_HPP */