RdiiInterface.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_RDII_INTERFACE_HPP
#define OPENSWMM_RDII_INTERFACE_HPP
 
#include <cstdio>
#include <string>
#include <vector>
 
namespace openswmm {
 
struct SimulationContext;
 
namespace rdii_iface {
 
static const char RDII_FILE_STAMP[] = "SWMM5-RDII";

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

    int openForRead(SimulationContext& ctx, const std::string& path);

    int openForWrite(const std::string& path, int rdii_step, const std::vector<int>& node_idx);

    void applyFlows(SimulationContext& ctx, double current_date);

    void saveFlows(double current_date, const std::vector<double>& node_flows);

    void close();

    bool isOpen() const { return fp_ != nullptr; }
    bool isWriting() const { return writing_; }
    int step() const { return rdii_step_; }
 
private:
    std::FILE* fp_ = nullptr;
    bool writing_ = false;
    bool binary_ = true;
 
    int rdii_step_ = 0;         
    int flow_units_ = 0;        
    std::vector<int> node_idx_; 
    std::vector<float> flows_;  
    double start_date_ = 0.0;   
    double end_date_ = 0.0;     
    bool have_record_ = false;

    int readBinaryHeader(SimulationContext& ctx);
    int readTextHeader(SimulationContext& ctx);
    bool readNextRecord(); 
};
 
} // namespace rdii_iface
} // namespace openswmm
 
#endif // OPENSWMM_RDII_INTERFACE_HPP