IOManager.h

Go to the documentation of this file.

// SPDX-License-Identifier: LGPL-3.0-or-later
/***********************************************************************************/
/*  Copyright 2009 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 IOMANAGER_H
#define IOMANAGER_H
 
#include <meteoio/DataGenerator.h>
#include <meteoio/Meteo2DInterpolator.h>
#include <meteoio/dataClasses/MeteoData.h>
#include <meteoio/TimeSeriesManager.h>
#include <meteoio/GridsManager.h>
 
#include <map>
#include <set>
#include <vector>
#include <string>
 
namespace mio {
 
class TimeSeriesManager;
class GridsManager;
class Meteo2DInterpolator;
 
class IOManager {
        public:
                IOManager(const std::string& filename_in);
                IOManager(const Config& i_cfg);
 
                //Legacy support to support functionality of the IOInterface superclass:
                void read2DGrid(Grid2DObject& grid_out, const std::string& options="") {gdm1.read2DGrid(grid_out, options);}
                void read2DGrid(Grid2DObject& grid_out, const MeteoGrids::Parameters& parameter, const Date& date) {gdm1.read2DGrid(grid_out, parameter, date);}
                void read3DGrid(Grid3DObject& grid_out, const std::string& options="") {gdm1.read3DGrid(grid_out, options);}
                void read3DGrid(Grid3DObject& grid_out, const MeteoGrids::Parameters& parameter, const Date& date) {gdm1.read3DGrid(grid_out, parameter, date);}
                void readDEM(DEMObject& dem_out) {gdm1.readDEM(dem_out);}
                void readAssimilationData(const Date& date_in, Grid2DObject& da_out) {gdm1.readAssimilationData(date_in, da_out);}
                void readLanduse(Grid2DObject& landuse_out) {gdm1.readLanduse(landuse_out);}
                void readGlacier(Grid2DObject& glacier_out) {gdm1.readGlacier(glacier_out);}
                void readPOI(std::vector<Coords>& pts) {iohandler.readPOI(pts);}
                void write2DGrid(const Grid2DObject& grid_in, const std::string& options="") {gdm1.write2DGrid(grid_in, options);}
                void write2DGrid(const Grid2DObject& grid_in, const MeteoGrids::Parameters& parameter, const Date& date) {gdm1.write2DGrid(grid_in, parameter, date);}
                void write3DGrid(const Grid3DObject& grid_in, const std::string& options="") {gdm1.write3DGrid(grid_in, options);}
                void write3DGrid(const Grid3DObject& grid_in, const MeteoGrids::Parameters& parameter, const Date& date) {gdm1.write3DGrid(grid_in, parameter, date);}
                bool list2DGrids(const Date& start, const Date& end, std::map<Date, std::set<size_t> > &list){return iohandler.list2DGrids(start,end,list);}
                void setOfstreamDefault(const Config& i_cfg);
                //end legacy support
 
                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< METEO_SET >& vecMeteo) {tsm1.push_meteo_data(level, date_start, date_end, vecMeteo);}
 
                bool getMeteoData(const Date& date, const DEMObject& dem, const MeteoData::Parameters& meteoparam,
                                 Grid2DObject& result);
 
                bool getMeteoData(const Date& date, const DEMObject& dem, const std::string& param_name,
                                 Grid2DObject& result);
 
                bool getMeteoData(const Date& date, const DEMObject& dem, const MeteoData::Parameters& meteoparam,
                                 Grid2DObject& result, std::string& info_string);
 
                bool getMeteoData(const Date& date, const DEMObject& dem, const std::string& param_name,
                                 Grid2DObject& result, std::string& info_string);
 
                void interpolate(const Date& date, const DEMObject& dem, const MeteoData::Parameters& meteoparam,
                                 const std::vector<Coords>& in_coords, std::vector<double>& result);
 
                void interpolate(const Date& date, const DEMObject& dem, const MeteoData::Parameters& meteoparam,
                                 const std::vector<Coords>& in_coords, std::vector<double>& result, std::string& info_string);
 
                void interpolate(const Date& date, const DEMObject& dem, const MeteoData::Parameters& meteoparam,
                                 const std::vector<StationData>& in_stations, std::vector<double>& result, std::string& info_string);
 
                void setProcessingLevel(const unsigned int& i_level);
 
                void setMinBufferRequirements(const double& buffer_size, const double& buff_before) {tsm1.setBufferProperties(buffer_size, buff_before);}
 
                double getAvgSamplingRate() const;
 
                void writeMeteoData(const std::vector< METEO_SET >& vecMeteo, const std::string& option="") {tsm1.writeMeteoData(vecMeteo, option);}
 
                const Config& getConfig() const {return cfg;}
 
                const std::string toString() const;
 
                void add_to_points_cache(const Date& i_date, const METEO_SET& vecMeteo);
 
                void clear_cache();
 
 
        private:
                static IOUtils::OperationMode getIOManagerTSMode(const Config& i_cfg);
 
                static IOUtils::OperationMode getIOManagerGridMode(const Config& i_cfg);
 
                void initVirtualStations();
                std::vector<METEO_SET> getVirtualStationsData(const DEMObject& dem, const Date& dateStart, const Date& dateEnd);
                void initIOManager();
 
                const Config cfg; 
                const IOUtils::OperationMode ts_mode;
                IOHandler iohandler;
                TimeSeriesManager tsm1, tsm2;
                GridsManager gdm1;
                Meteo2DInterpolator interpolator;
                DEMObject source_dem;
                std::vector<size_t> v_params, grids_params; 
                std::vector<StationData> v_stations, v_gridstations; 
                unsigned int vstations_refresh_rate, vstations_refresh_offset; 
                bool write_resampled_grids = false; 
};
} //end namespace
#endif