SMETIO.h

Go to the documentation of this file.

// SPDX-License-Identifier: LGPL-3.0-or-later
/***********************************************************************************/
/*  Copyright 2010 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 SMETIO_H
#define SMETIO_H
 
#include <meteoio/IOInterface.h>
#include <meteoio/plugins/libsmet.h>
#include <meteoio/plugins/libacdd.h>
 
#include <string>
#include <vector>
 
#ifdef _MSC_VER
        #pragma warning(disable:4512) //we don't need any = operator!
#endif
 
namespace mio {
class SMETIO : public IOInterface {
        public:
                SMETIO(const std::string& configfile);
                SMETIO(const SMETIO&);
                SMETIO(const Config& cfgreader);
 
                virtual void readStationData(const Date& date, std::vector<StationData>& vecStation);
                virtual void readMeteoData(const Date& dateStart, const Date& dateEnd,
                                           std::vector< std::vector<MeteoData> >& vecMeteo);
 
                virtual void writeMeteoData(const std::vector< std::vector<MeteoData> >& vecMeteo,
                                            const std::string& name="");
 
                virtual void readPOI(std::vector<Coords>& pts);
 
        private:
                typedef struct PLOT_ATTR {
                        PLOT_ATTR() : units(), description(), color(), min(IOUtils::nodata), max(IOUtils::nodata) {} //please do NOT use this constructor!
                        PLOT_ATTR(const std::string& i_units, const std::string& i_description, const std::string& i_color) : units(i_units), description(i_description), color(i_color), min(IOUtils::nodata), max(IOUtils::nodata) {}
                        PLOT_ATTR(const std::string& i_units, const std::string& i_description, const std::string& i_color, const double& i_min, const double& i_max) : units(i_units), description(i_description), color(i_color), min(i_min), max(i_max) {}
                        PLOT_ATTR(const size_t& parindex, const std::string& i_color, const double& i_min, const double& i_max) : units(MeteoGrids::getParameterUnits(parindex)), description(MeteoGrids::getParameterDescription(parindex, false)), color(i_color), min(i_min), max(i_max) {}
 
                        std::string units; 
                        std::string description; 
                        std::string color; 
                        double min; 
                        double max; 
                } plot_attr;
                
                typedef enum VERSIONING_TYPE {
                            NO_VERSIONING, 
                            NOW, 
                            DATA_START, 
                            DATA_END, 
                            DATA_YEARS 
                } VersioningType;
                
                static std::map<std::string, plot_attr> initPlotParams();
                static double getSnowpackSlope(const std::string& id);
                void read_meta_data(const smet::SMETReader& myreader, StationData& meta);
                void identify_fields(const std::vector<std::string>& fields, std::vector<size_t>& indexes,
                                     bool& julian_present, MeteoData& md);
                void populateMeteo(const smet::SMETReader& myreader, const std::vector<std::string>& timestamps,
                               const std::vector<double>& mydata, std::vector<MeteoData>& vecMeteo);
 
                void parseInputOutputSection();
                bool checkConsistency(const std::vector<MeteoData>& vecMeteo, StationData& sd);
                size_t getNrOfParameters(const std::string& stationname, const std::vector<MeteoData>& vecMeteo);
                bool getPlotProperties(std::string param, std::ostringstream &plot_units, std::ostringstream &plot_description, std::ostringstream &plot_color, std::ostringstream &plot_min, std::ostringstream &plot_max) const;
                void getFormatting(const std::string& parname, int& prec, int& width) const;
                std::string buildVersionString(const std::vector< std::vector<MeteoData> >& vecMeteo, const double& smet_timezone) const;
                double olwr_to_tss(const double& olwr);
                void generateHeaderInfo(const StationData& sd, const bool& i_outputIsAscii, const bool& isConsistent,
                                        const double& smet_timezone, const std::set<std::string>& paramInUse, smet::SMETWriter& mywriter);
 
                static const char* dflt_extension;
                static const double snVirtualSlopeAngle;
                const Config cfg;
                ACDD acdd;
                std::map<std::string, plot_attr> plot_ppt; 
                std::string coordin, coordinparam, coordout, coordoutparam; //default projection parameters
                std::vector<smet::SMETReader> vec_smet_reader;
                std::vector<std::string> vecFiles;  //read from the Config [Input] section
                std::string outpath;                //read from the Config [Output] section
                double out_dflt_TZ;     //default time zone
                double plugin_nodata;
                int default_prec, default_width; //output default precision and width
                char output_separator;         //output field separator
                VersioningType outputVersioning; //this is usefull when generating multiple versions of the same dataset, for example with forecast data
                bool outputCommentedHeaders;   //prefix all headers with a '#' for easy import into dbs but breaks SMET conformance
                bool outputIsAscii, outputPlotHeaders, randomColors, allowAppend, allowOverwrite, snowpack_slopes;//read from the Config [Output] section
                // the default values of allowOverwrite and allowAppend should be kept as they are, to allow backward compatibility
};
 
} //namespace
#endif