RunoffInterface.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_RUNOFF_INTERFACE_HPP
#define OPENSWMM_RUNOFF_INTERFACE_HPP
 
#include <string>
#include <vector>
#include <cstdio>
 
namespace openswmm {
 
struct SimulationContext;
 
namespace runoff_iface {
 
static constexpr int N_FIXED_RESULTS = 8; 
static const char FILE_STAMP[] = "SWMM5-RUNOFF";

class RunoffInterfaceFile {
public:
    ~RunoffInterfaceFile() { close(); }

    int openForWrite(const std::string& path, int n_subcatch, int n_pollut, int flow_units);

    int openForRead(const std::string& path, int n_subcatch, int n_pollut, int flow_units);

    void saveResults(const SimulationContext& ctx, double dt);

    bool readResults(SimulationContext& ctx, double* dt_out = nullptr);

    void close();

    bool isOpen() const { return fp_ != nullptr; }
 
private:
    std::FILE* fp_ = nullptr;
    bool writing_ = false;
    int n_subcatch_ = 0;
    int n_pollut_ = 0;
    int n_results_ = 0;   
    int flow_units_ = 0;  
    int unit_system_ = 0; 
    int step_count_ = 0;
    long max_steps_pos_ = 0; 
    std::vector<float> buf_; 
};
 
} // namespace runoff_iface
} // namespace openswmm
 
#endif // OPENSWMM_RUNOFF_INTERFACE_HPP