GeneratorAlgorithms.h

Go to the documentation of this file.

// SPDX-License-Identifier: LGPL-3.0-or-later
/***********************************************************************************/
/*  Copyright 2013 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 GENERATORALGORITHMS_H
#define GENERATORALGORITHMS_H
 
#include <meteoio/dataClasses/MeteoData.h>
#include <meteoio/Config.h>
 
#include <vector>
#include <set>
#include <string>
 
#ifdef _MSC_VER
        #pragma warning(disable:4512) //we don't need any = operator!
#endif
 
namespace mio {
 
class GeneratorAlgorithm {
        public:
                virtual ~GeneratorAlgorithm() {}
                //fill one MeteoData, for one station. This is used by the dataGenerators
                virtual bool generate(const size_t& param, MeteoData& md, const std::vector<MeteoData>& vecMeteo) = 0;
 
                virtual bool create(const size_t& param, const size_t& ii_min, const size_t& ii_max, std::vector<MeteoData>& vecMeteo) = 0;
 
                bool skipStation(const std::string& station_id) const;
                
                bool skipTimeStep(const Date& dt) const;
 
                /*
                * @brief Should this height be skipped? based on user-provided height restrictions
                * @param[in] height current height
                * @return true if the provided height should be skipped
                 */
                bool skipHeight(const double& height) const;
 
                std::vector<DateRange> getTimeRestrictions() const {return time_restrictions;}
                std::string getAlgo() const {return algo;}
        protected:
                GeneratorAlgorithm(const std::vector< std::pair<std::string, std::string> >& vecArgs, const std::string& i_algo, const std::string& i_section, const double& TZ); 
                virtual void parse_args(const std::vector< std::pair<std::string, std::string> >& /*vecArgs*/) {}
                static std::set<std::string> initStationSet(const std::vector< std::pair<std::string, std::string> >& vecArgs, const std::string& keyword);
                void initHeightRestrictions(const std::vector<std::pair<std::string, std::string>> vecArgs);
 
                const std::vector<DateRange> time_restrictions;
                const std::set<std::string> excluded_stations, kept_stations;
                std::set<double> included_heights, excluded_heights;
                bool all_heights;
                const std::string algo, section;
                
                //These are used by several generators in order work with radiation data by looking at HS and deciding which albedo should be used
                static const double soil_albedo, snow_albedo, snow_thresh;
                static const double default_height;
};
 
class GeneratorAlgorithmFactory {
        public:
                static GeneratorAlgorithm* getAlgorithm(const Config& cfg, const std::string& i_algoname, const std::string& i_section, const std::vector< std::pair<std::string, std::string> >& vecArgs);
};
 
} //end namespace mio
 
#endif