FMTModelParser.h

Go to the documentation of this file.

/*
Copyright (c) 2019 Gouvernement du Québec
 
SPDX-License-Identifier: LiLiQ-R-1.1
License-Filename: LICENSES/EN/LiLiQ-R11unicode.txt
*/
 
#ifndef FMTmodelparser_Hm_included
#define FMTmodelparser_Hm_included
 
 
#include <map>
#include <string>
#include <vector>
#include "FMTParser.h"
#include "FMTOutputNode.h"
#include "FMTConstants.h"
 
 
namespace Models {
    class FMTModel;
}
 
 
namespace Core {
    class FMTSchedule;
    class FMTConstraint;
    class FMTOutput;
}
 
 
namespace Parser
{
class FMTConstantParser;
class FMTLandscapeParser;
class FMTAreaParser;
class FMTYieldParser;
class FMTActionParser;
class FMTLifespanParser;
class FMTOutputParser;
class FMTOptimizationParser;
class FMTScheduleParser;
// DocString: FMTModelParser
class FMTEXPORT FMTModelParser : public FMTParser
    {
    public:
        // DocString: FMTModelParser()
        FMTModelParser();
        // DocString: ~FMTModelParser()
        virtual ~FMTModelParser() = default;
        // DocString: FMTModelParser(const FMTModelParser&)
        FMTModelParser(const FMTModelParser& rhs);
        // DocString: FMTModelParser::operator=
        FMTModelParser& operator = (const FMTModelParser& rhs);
        // DocString: FMTModelParser::read
        Models::FMTModel read(const std::string& con,const std::string& lan,
                      const std::string& lif,const std::string& are,const std::string& yld,
                      const std::string& act,const std::string& tr,const std::string& out,
                        std::string opt = std::string());
        // DocString: FMTModelParser::readtemplate
        std::vector<Models::FMTModel>readTemplates(const std::string& primarym_location,const std::string& templatefolder);
        // DocString: FMTModelParser::readproject
        std::vector<Models::FMTModel>readproject(const std::string& primarym_location,
            std::vector<std::string>scenarios = std::vector<std::string>(),
            bool readarea = true,bool readoutputs = true, bool readoptimize = true);
        // DocString: FMTModelParser::writeToProject
        void writeToProject(const std::string& primarym_location,
            const Models::FMTModel& model);
        // DocString: FMTModelParser::readSchedules
        std::vector<std::vector<Core::FMTSchedule>>readSchedules(const std::string& primarym_location,
            const std::vector<Models::FMTModel>& models);
        // DocString: FMTModelParser::getConstraintsFromString
        std::vector<Core::FMTConstraint>getConstraintsFromString(std::string constraintstr,
            const Models::FMTModel& model,Core::FMTConstants constants = Core::FMTConstants());
        // DocString: FMTModelParser::write
        void write(const Models::FMTModel& model,const std::string& folder) const;
        #ifdef FMTWITHGDAL
        // DocString: FMTModelParser::createResultsLayer
        OGRLayer* createResultsLayer(
            const std::string& p_modelName,
            GDALDataset* p_dataset,
            std::vector<std::string> p_creationOptions = std::vector<std::string>()) const;
        // DocString: FMTModelParser::fillUpInfeasibles
        void fillUpInfeasibles(OGRLayer* layer,
            const std::vector<Core::FMTOutput>&theoutputs,
            const int& iteration,const int& firstPeriod, const int&lastPeriod) const;
        // DocString: FMTModelParser::writeFeatures
        void writeFeatures(OGRLayer* layer,const int& firstPeriod, const int& iteration,
            const std::vector<Core::FMTOutput>&theoutputs,
            const std::map<std::string,std::vector<std::vector<double>>>& values, bool writeNaN = false)const;
        // DocString: FMTModelParser::writeResults
        void writeResults(const Models::FMTModel& model,
            const std::vector<Core::FMTOutput>&theoutputs,
            const int& firstPeriod, const int& lastPeriod,
            const std::string& location,
            Core::FMToutputlevel level = Core::FMToutputlevel::standard,
            std::string gdaldrivername= "CSV") const;
        #endif 
    protected:
    #ifdef FMTWITHGDAL
        // DocString: FMTModelParser::getIterationsValues()
        std::map<std::string, std::vector<std::vector<double>>>getIterationsValues(OGRLayer* layer) const;
        // DocString: FMTModelParser::createDriftLayer()
        OGRLayer* createDriftLayer(GDALDataset* dataset, std::vector<std::string> creationoptions = std::vector<std::string>()) const;
        // DocString: FMTModelParser::writedriftr()
        void writeDrift(OGRLayer* layer, const std::map<std::string, std::map<double, std::vector<double>>>& lowervalues,
            const std::map<std::string, std::map<double, std::vector<double>>>& uppervalues) const;
    #endif
        // DocString: FMTModelParser::writePrimary()
        void writePrimary(
            const std::string& location,
            const std::string& lanfile,
            const std::string& arefile,
            const std::string& yldfile,
            const std::string& actfile,
            const std::string& trnfile,
            const std::string& outfile,
            const std::string& optfile,
            const std::string& liffile,
            std::string seqfile = std::string()) const;
        // DocString: FMTModelParser::writeModel
        void writeModel(const Models::FMTModel& model,
            const std::string& lanfile,
            const std::string& arefile,
            const std::string& yldfile,
            const std::string& actfile,
            const std::string& trnfile,
            const std::string& outfile,
            const std::string& optfile,
            const std::string& liffile,
            const std::string& seqfile) const;
    private:
        // DocString: FMTModelParser::referenceRead
        Models::FMTModel referenceRead(std::map<std::string, std::vector<int>>& commonm_sections,
            std::vector<Models::FMTModel>& models,
            const std::string& con, const std::string& lan,
            const std::string& lif, const std::string& are, const std::string& yld,
            const std::string& act, const std::string& tr, const std::string& out,
            std::string opt = std::string(), bool allow_mapping = false);
        // DocString: FMTModelParser::readFromFolder
        std::vector<Models::FMTModel>readFromFolder(const std::string& primarym_location,
            const std::string& folder,
            std::vector<std::string>scenarios,
            bool validatescenarioname,
            bool readarea = true, bool readoutputs = true, bool readoptimize = true);
        // DocString: FMTModelParser::setSolverParameters
        void setSolverParameters(Models::FMTModel& p_model, const std::string& p_optimize_file) const;
    };
}
 
#endif // FMTmodelparser_Hm_included