TimeSeriesManager.h

Go to the documentation of this file.

// SPDX-License-Identifier: LGPL-3.0-or-later
/***********************************************************************************/
/*  Copyright 2014 WSL Institute for Snow and Avalanche Research    SLF-DAVOS      */
/***********************************************************************************/
/* This file is part of MeteoIO.
    MeteoIO is free software: you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    MeteoIO is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Lesser General Public License for more details.
 
    You should have received a copy of the GNU Lesser General Public License
    along with MeteoIO.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef TIMESERIESMANAGER_H
#define TIMESERIESMANAGER_H
 
#include <meteoio/DataGenerator.h>
#include <meteoio/MeteoProcessor.h>
#include <meteoio/dataClasses/MeteoData.h>
#include <meteoio/dataClasses/Buffer.h>
#include <meteoio/IOHandler.h>
#include <meteoio/Config.h>
 
#include <map>
#include <vector>
#include <utility>
#include <string>
 
namespace mio {
 
class TimeSeriesManager {
        public:
                enum cache_types {
                        RAW,    
                        FILTERED,       
                        POINTS, 
                        ALL     
                };
                
                TimeSeriesManager(IOHandler& in_iohandler, const Config& in_cfg, const char& rank=1, const IOUtils::OperationMode &mode=IOUtils::STD);
 
                size_t getStationData(const Date& date, STATIONS_SET& vecStation);
 
                size_t getMeteoData(const Date& dateStart, const Date& dateEnd,
                                    std::vector< METEO_SET >& vecVecMeteo);
 
                size_t getMeteoData(const Date& i_date, METEO_SET& vecMeteo);
 
                void push_meteo_data(const IOUtils::ProcessingLevel& level, const Date& date_start, const Date& date_end,
                                     const std::vector< MeteoData >& vecMeteo, const bool& invalidate_cache=true);
                
                void push_meteo_data(const IOUtils::ProcessingLevel& level, const Date& date_start, const Date& date_end,
                                     const std::vector< METEO_SET >& vecMeteo);
 
                void setProcessingLevel(const unsigned int& i_level);
 
                void setBufferProperties(const double& buffer_size, const double& buff_before);
 
                void setRawBufferProperties(const Date& raw_buffer_start, const Date& raw_buffer_end);
                
                void getBufferProperties(Duration &o_buffer_size, Duration &o_buff_before) const;
 
                double getAvgSamplingRate() const;
 
                void writeMeteoData(const std::vector< METEO_SET >& vecMeteo, const std::string& name="");
 
                const std::string toString() const;
 
                void add_to_points_cache(const Date& i_date, const METEO_SET& vecMeteo);
 
                void clear_cache(const cache_types& cache);
                
                const Config& getConfig() const {return cfg;}
 
                const IOHandler& getIOHandler() const {return iohandler;}
 
                Date getBufferStart(const cache_types& cache) const;
 
                Date getBufferEnd(const cache_types& cache) const;
                
                Date getDataStart(const cache_types& cache) const;
                
                Date getDataEnd(const cache_types& cache) const;
 
                
        private:
                static bool compare(std::pair<Date, METEO_SET> p1, std::pair<Date, METEO_SET> p2);
                void setDfltBufferProperties();
                void fill_filtered_cache();
                void fillRawBuffer(const Date& date_start, const Date& date_end);
 
                const Config& cfg;
                IOHandler& iohandler;
                MeteoProcessor meteoprocessor;
                DataGenerator dataGenerator;
 
                ProcessingProperties proc_properties; 
                std::map<Date, METEO_SET > point_cache;  
                MeteoBuffer raw_buffer; 
                MeteoBuffer filtered_cache; 
 
                Date raw_requested_start, raw_requested_end; 
                Duration chunk_size; 
                Duration buff_before; 
                unsigned int processing_level;
};
} //end namespace
#endif