time_series_writer.hpp

Go to the documentation of this file.

#pragma once
 
#include <span>
#include <string>
#include <vector>
 
#include "netcdf_file.hpp"
 
namespace kynema::util {
 
class TimeSeriesWriter {
public:
    static constexpr size_t kDefaultBufferSize{0};
 
    explicit TimeSeriesWriter(const std::string& file_path, bool create = true);
 
    TimeSeriesWriter(
        const std::string& file_path, bool create, const std::vector<std::string>& channel_names,
        const std::vector<std::string>& channel_units = {}, size_t buffer_size = kDefaultBufferSize
    );
 
    ~TimeSeriesWriter();
 
    // Rule of five -> explicitly delete the copy ctor, copy assignment operator,
    // move ctor, and move assignment operator
    TimeSeriesWriter(const TimeSeriesWriter&) = delete;
    TimeSeriesWriter& operator=(const TimeSeriesWriter&) = delete;
    TimeSeriesWriter(TimeSeriesWriter&&) = delete;
    TimeSeriesWriter& operator=(TimeSeriesWriter&&) = delete;
 
    void WriteValuesAtTimestep(
        const std::string& variable_name, size_t timestep, std::span<const double> values
    );
 
    void WriteValueAtTimestep(
        const std::string& variable_name, size_t timestep, const double& value
    );
 
    void WriteRowAtTimestep(size_t timestep, std::span<const double> row);
 
    void Flush();
 
    void Close();
 
    void Open();
 
    [[nodiscard]] const NetCdfFile& GetFile() const;
 
    [[nodiscard]] const std::vector<std::string>& GetChannelNames() const;
 
    [[nodiscard]] const std::vector<std::string>& GetChannelUnits() const;
 
    [[nodiscard]] size_t GetNumChannels() const;
 
    [[nodiscard]] size_t GetBufferSize() const;
 
private:
    NetCdfFile file_;
 
    //-----------------------------------
    // channel output variables
    //-----------------------------------
 
    std::vector<std::string> channel_names_;
    std::vector<std::string> channel_units_;
    size_t num_channels_;
    size_t buffer_size_;
 
    //-----------------------------------
    // support for buffering
    //-----------------------------------
 
    struct BufferedData {
        std::vector<double> data;  //< Flattened row-major buffer
        size_t start_timestep{0};  //< First timestep in the buffer
        size_t num_rows{0};        //< Number of complete rows currently in buffer
    };
 
    BufferedData buffer_;  //< Buffer for time-series data
 
    void FlushBuffer();
};
 
}  // namespace kynema::util