SourceResultHistory.hpp

Go to the documentation of this file.

// SPDX-License-Identifier: Apache-2.0

 
#pragma once
#include <map>
#include <cstdint>
#include <string>
#include <vector>
 
namespace openswmm::twoD {
class CommonSourceStage;

struct SourceResultTable {
    std::vector<std::string> fields, units;
    std::vector<std::vector<double>> columns;
    std::size_t rows() const { return columns.empty() ? 0 : columns.front().size(); }
};

class SourceResultHistory {
public:
    std::string append(const CommonSourceStage&);
    std::string resume(const CommonSourceStage&);
    const std::map<std::string, SourceResultTable>& tables() const { return tables_; }
    const std::vector<std::string>& sourceNames() const { return sources_; }
    const std::vector<std::string>& pollutantNames() const { return pollutants_; }
    const std::vector<std::string>& pollutantMassUnits() const { return mass_units_; }
    bool outfallReturnsAvailable() const { return outfall_returns_; }
    std::string save(const std::string& path) const;
    static std::string read(const std::string& path, SourceResultHistory& out, bool& available);
 
private:
    friend struct SourceResultFile;
    friend struct EngineSourceResultFile;
    friend class EngineSourceResultHistory;
    friend class EngineSourceResultStream;
    void appendRows(const CommonSourceStage&, std::size_t frame, double start);
    static SourceResultHistory projection(const CommonSourceStage&, std::size_t frame,
                                          double start);
    friend class Default2DOutputPlugin;
    friend class ExplicitInertialSolver;
    std::string refreshCheckpointMatch(const CommonSourceStage&);
    void initializeIdentity(const CommonSourceStage&);
    std::string resumeCapturedBoundary(const CommonSourceStage&);
    std::string writeIntoOpenResult(std::int64_t file) const; // engine's HDF5 instance only
    std::string extends(const SourceResultHistory& prefix) const;
    static std::map<std::string, SourceResultTable> schema(bool outfall_returns = false);
    std::string validate() const;
    const CommonSourceStage* stage_ = nullptr;
    bool outfall_returns_ = false;
    std::string model_, boundary_;
    std::vector<std::string> sources_, pollutants_, mass_units_;
    std::map<std::string, SourceResultTable> tables_;
};
}