SensorData.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) OpenGeoSys Community (opengeosys.org)
// SPDX-License-Identifier: BSD-3-Clause
 
#pragma once
 
#include <cstddef>
#include <string>
#include <vector>

enum class SensorDataType
{
    OTHER = 0,
    PRECIPITATION,
    EVAPORATION,
    TEMPERATURE
    // please expand if necessary
};

enum class TimeStepType
{
    NONE = 0,
    SECONDS,
    MINUTES,
    DAYS,
    WEEKS,
    MONTHS,
    YEARS,
    DATE,     // time series is given as a vector of dates
    DATETIME  // time series is given as a vector of date + time
};

class SensorData final
{
public:
    explicit SensorData(const std::string& file_name);

    explicit SensorData(std::vector<std::size_t> time_steps);
 
    ~SensorData();

    void addTimeSeries(const std::string& data_name, std::vector<float>* data,
                       const std::string& data_unit_string = "");

    void addTimeSeries(SensorDataType data_name, std::vector<float>* data,
                       const std::string& data_unit_string = "");

    const std::vector<float>* getTimeSeries(
        SensorDataType time_series_name) const;

    const std::vector<SensorDataType>& getTimeSeriesNames() const
    {
        return _vec_names;
    }

    const std::vector<std::size_t>& getTimeSteps() const { return _time_steps; }

    std::size_t getStartTime() const { return _start; }

    std::size_t getEndTime() const { return _end; }

    std::size_t getStepSize() const { return _step_size; }

    void setTimeUnit(TimeStepType t) { _time_unit = t; }

    TimeStepType getTimeUnit() const { return _time_unit; }

    static std::string convertSensorDataType2String(SensorDataType t);

    static SensorDataType convertString2SensorDataType(const std::string& s);
 
private:
    int readDataFromFile(const std::string& file_name);
 
    std::size_t _start;
    std::size_t _end;
    std::size_t _step_size;
    TimeStepType _time_unit;
    std::vector<std::string> _data_unit_string;
    std::vector<std::size_t> _time_steps;
    std::vector<SensorDataType> _vec_names;
    std::vector<std::vector<float>*> _data_vecs;
};