MultiColumnSeriesFile.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_MULTI_COLUMN_SERIES_FILE_HPP
#define OPENSWMM_ENGINE_MULTI_COLUMN_SERIES_FILE_HPP
 
#include <string>
#include <string_view>
#include <unordered_map>
#include <vector>
 
namespace openswmm::input {

struct ParsedSeriesFile {
    std::vector<std::string>          headers;

    std::vector<double>               dates;

    std::vector<std::vector<double>>  columns;

    double first_date = 0.0, last_date = 0.0;
 
    // Per-column statistics over the WHOLE file (index-aligned with
    // `headers`; entry 0 unused). These preserve the "Rainfall File
    // Summary" values a per-gage scan used to produce.
    std::vector<double>               col_first_date;
    std::vector<double>               col_last_date;
    std::vector<long>                 col_periods_precip;  
    std::vector<long>                 col_unparsed_cells;  

    long                              unparsed_rows = 0;

    int find_column(std::string_view name) const;

    int first_data_column() const {
        return headers.size() > 1 ? 1 : -1;
    }
};

enum class SeriesFileStatus {
    OK,            
    OPEN_FAILED,   
    FORMAT_FAILED  
};

bool parse_series_datetime(const std::string& cell, double& out);

bool parse_multicolumn_series_file(const std::string& abs_path,
                                   ParsedSeriesFile& out,
                                   std::vector<std::string>& errors,
                                   SeriesFileStatus* status = nullptr);

bool looks_like_multicolumn_series_file(const std::string& abs_path);

bool split_series_file_token(std::string_view token,
                             std::string& path_out,
                             std::string& column_out);

class MultiColumnFileCache {
public:
    const ParsedSeriesFile* get_or_parse(const std::string& abs_path,
                                         std::vector<std::string>& errors,
                                         SeriesFileStatus* status = nullptr);

    int parse_count() const noexcept { return parse_count_; }
 
private:
    struct Entry {
        SeriesFileStatus status = SeriesFileStatus::OPEN_FAILED;
        ParsedSeriesFile file;
    };
    std::unordered_map<std::string, Entry> files_;
    int parse_count_ = 0;
};

long multicolumn_parse_count_total() noexcept;
 
} /* namespace openswmm::input */
 
#endif /* OPENSWMM_ENGINE_MULTI_COLUMN_SERIES_FILE_HPP */