FMTYieldModel.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
*/
#include "FMTObject.h"
#include <boost/serialization/serialization.hpp>
#include <boost/serialization/nvp.hpp>
 
 
#ifndef FMTYIELDMODEL_Hm_included
#define FMTYIELDMODEL_Hm_included
 
namespace Graph
{
    class FMTPredictor;
}
 
namespace Models
{
    class FMTModel;
}
 
namespace boost
{
    namespace property_tree
    {
        template < class Key, class Data, class KeyCompare >
        class basic_ptree;
        typedef basic_ptree< std::string, std::string, std::less<std::string> > ptree;
    }
}
 
namespace Core 
{
    class FMTYieldRequest;
    class FMTTheme;
    class FMTMaskFilter;
    // DocString: FMTYieldModel
    class FMTYieldModel : public FMTObject
    {
    public:
        // DocString: FMTYieldModel::setModel
        virtual void setModel(Models::FMTModel* p_modelPtr);
        // DocString: FMTYieldModel::~FMTYieldModel()
        virtual ~FMTYieldModel();
        // DocString: FMTYieldModel::FMTYieldModel()
        FMTYieldModel();
        // DocString: FMTYieldModel::FMTYieldModel()
        FMTYieldModel(const FMTYieldModel& rhs)=default;
        // DocString: FMTYieldModel::operator = (const FMTYieldModel& rhs)
        FMTYieldModel& operator = (const FMTYieldModel& rhs)=default;
        // DocString: FMTYieldModel::getModelName()
        const std::string& getModelName() const;
        // DocString: FMTYieldModelNn::getModelYields()
        const std::vector<std::string>& getModelYields() const;
        // DocString: FMTYieldModel::clone()
        virtual std::unique_ptr<FMTYieldModel>clone() const = 0;
        // DocString: FMTYieldModel::predict
        virtual const std::vector<double>predict(const Core::FMTYieldRequest& request) const = 0;
        // DocString: FMTYieldModel::preSolve
        virtual std::unique_ptr<FMTYieldModel> preSolve(const FMTMaskFilter& filter,
                const std::vector<FMTTheme>& newthemes) const;
        // DocString: FMTYieldModel::postSolve
        virtual std::unique_ptr<FMTYieldModel> postSolve(const FMTMaskFilter& filter,
            const std::vector<FMTTheme>& basethemes) const;
        // DocString: FMTYieldModel::std::string()
        virtual  operator std::string() const;
        // DocString: FMTYieldModel::getPeriodicValues
        virtual std::vector<std::vector<double>>getPeriodicValues() const;
        // DocString: FMTYieldModel::clearRandomYieldsCache
        virtual void clearRandomYieldsCache();
    protected:
        std::string m_modelName;
        std::vector<std::string> m_modelYields = {};
        const std::string m_JSON_PROP_MODEL_NAME = "modelFileName";
        Models::FMTModel* m_modelPtr=nullptr;
    private:
        friend class boost::serialization::access;
        // DocString: FMTYieldModel::serialize
        template<class Archive>
        void serialize(Archive& ar, const unsigned int version)
        {
            ar& boost::serialization::make_nvp("FMTobject", boost::serialization::base_object<FMTObject>(*this));
        }
    };
}
 
#endif