FMTyieldmodel.hpp

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.hpp"
#include <boost/serialization/serialization.hpp>
#include <boost/serialization/nvp.hpp>
 
 
#ifndef FMTYIELDMODEL_H_INCLUDED
#define FMTYIELDMODEL_H_INCLUDED
 
namespace Graph
{
    class FMTpredictor;
}
 
 
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
    {
        friend class boost::serialization::access;
        template<class Archive>
        void serialize(Archive& ar, const unsigned int version)
        {
            ar & boost::serialization::make_nvp("FMTobject", boost::serialization::base_object<FMTobject>(*this));
        }
    protected:
        std::string modelName;
        std::vector<std::string> modelYields = {};
        const std::string JSON_PROP_MODEL_NAME = "modelFileName";
    public:
        // 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=0;
        // DocString: FMTyieldmodel::getperiodicvalues
        virtual std::vector<std::vector<double>>getperiodicvalues() const;
    };
}
 
#endif