FMTSesModel.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 FMTSESM_Hm_included
#define FMTSESM_Hm_included
 
#include "FMTSeModel.h"
#include <boost/serialization/vector.hpp>
#include <boost/serialization/serialization.hpp>
#include <boost/serialization/nvp.hpp>
#include <boost/serialization/export.hpp>
 
namespace Models
{
// DocString: FMTSesModel
class FMTEXPORT FMTSesModel final: public FMTSeModel
    {
    // DocString: FMTSesModel::Serialize
    friend class boost::serialization::access;
    template<class Archive>
    void serialize(Archive& ar, const unsigned int version)
        {
        ar & boost::serialization::make_nvp("semodel", boost::serialization::base_object<FMTSeModel>(*this));
        }
    // DocString: FMTSesModel::swapPtr
    virtual void swapPtr(std::unique_ptr<FMTModel>& rhs);
    // DocString: FMTSesModel()
    FMTSesModel(const FMTSeModel& rhs);
    public:
        // DocString: FMTSesModel()
        FMTSesModel() = default;
        // DocString: ~FMTSesModel()
        ~FMTSesModel() = default;
        // DocString: FMTSesModel(const FMTSesModel)
        FMTSesModel(const FMTSesModel& rhs)=default;
        // DocString: FMTSesModel(const FMTModel)
        FMTSesModel(const FMTModel& rhs);
        // DocString: FMTSesModel(const FMTModel)
        FMTSesModel(const FMTModel& rhs, const Spatial::FMTForest& forest);
        // DocString: FMTSesModel::operator=
        FMTSesModel& operator = (const FMTSesModel& rhs)=default;
        // DocString: FMTSesModel(FMTSesModel&&)
        FMTSesModel(FMTSesModel&& rhs)=default;
        // DocString: FMTSesModel::operator=(FMTSesModel&& rhs) 
        FMTSesModel& operator =(FMTSesModel&& rhs) =default;
        // DocString: FMTSesModel::getDisturbanceStats
        std::string getDisturbanceStats() const;
        // DocString: FMTSesModel::greedyReferenceBuild
        std::map<std::string, double> greedyReferenceBuild(
            const Core::FMTSchedule& p_schedule,
            size_t p_randomIterations,
            int p_seed = 0,
            double p_tolerance = FMT_DBL_TOLERANCE);
        // DocString: FMTSesModel::clone
        virtual std::unique_ptr<FMTModel>clone() const;
        // DocString: FMTSesModel::build
        virtual bool build(std::vector<Core::FMTSchedule> schedules=std::vector<Core::FMTSchedule>());
        // DocString: FMTSesModel::solve
        virtual bool solve()
        {
            return true;
        }
        // DocString: FMTSesModel::preSolve
        virtual std::unique_ptr<FMTModel>preSolve(std::vector<Core::FMTActualDevelopment> optionaldevelopments = std::vector<Core::FMTActualDevelopment>()) const;
        // DocString: FMTSesModel::getCopy
        virtual std::unique_ptr<FMTModel> getCopy(int period = 0) const;
    };
 
}
 
BOOST_CLASS_EXPORT_KEY(Models::FMTSesModel)
 
#endif // FMTSESM_Hm_included