InpWriter.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_INP_WRITER_HPP
#define OPENSWMM_INP_WRITER_HPP
 
#include <cstdio>
#include <functional>
#include <string>
#include <vector>
 
namespace openswmm {
 
struct SimulationContext;
 
namespace inp_writer {

std::string groundwaterSections(const SimulationContext& ctx);

int writeInpFile(const SimulationContext& ctx, const std::string& path,
                 std::vector<std::string>* warnings = nullptr);

struct InpWriteOptions {
    enum class Profile { Full, Swmm5, Swmm5Stock };
    Profile profile = Profile::Full;
    // Internal container serialization: borrowed stream, no mesh sidecar writes.
    FILE* stream = nullptr;
    bool internal_units = false;
    bool inline_mesh = false;
    bool skip_component_files = false;
    enum class OutputKind { Model = 0, Mesh = 1, Component = 2 };
    // Final paths remain the reference anchor. Every actual output is sent
    // here before opening; an empty mapped path refuses that output.
    // The caller owns staging cleanup, validation and publication.
    std::function<std::string(const std::string&, OutputKind)> map_output;
};
 
int writeInpFile(const SimulationContext& ctx, const std::string& path,
                 std::vector<std::string>* warnings, const InpWriteOptions& opts);
 
// Complete native text, anchored at a container destination. No model/mesh files
// are created. internal_units is used only for GeoPackage supplemental sections.
std::string modelText(const SimulationContext& ctx, const std::string& anchor,
                      bool internal_units = false);
 
} // namespace inp_writer
} // namespace openswmm
 
#endif // OPENSWMM_INP_WRITER_HPP