FMTsemodel.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
*/
 
#ifndef FMTSEM_H_INCLUDED
#define FMTSEM_H_INCLUDED
 
#include "FMTmodel.hpp"
#include "FMTspatialschedule.hpp"
#include <boost/serialization/vector.hpp>
#include <boost/serialization/serialization.hpp>
#include <boost/serialization/nvp.hpp>
#include <boost/serialization/export.hpp>
 
namespace Spatial
{
    template <typename T>
    class FMTlayer;
}
 
namespace Models
{
// DocString: FMTsemodel
class FMTEXPORT FMTsemodel : public FMTmodel
    {
    // DocString: FMTsemodel::Serialize
    friend class boost::serialization::access;
    template<class Archive>
    void serialize(Archive& ar, const unsigned int version)
        {
        ar & boost::serialization::make_nvp("model", boost::serialization::base_object<FMTmodel>(*this));
        ar & BOOST_SERIALIZATION_NVP(solution);
        }
    virtual void swap_ptr(const std::unique_ptr<FMTmodel>& rhs);
    protected:
        // DocString: FMTsemodel::spschedule
        Spatial::FMTspatialschedule solution;
    public:
        // DocString: FMTsemodel()
        FMTsemodel();
        // DocString: ~FMTsemodel()
        virtual ~FMTsemodel() = default;
        // DocString: FMTsemodel(const FMTsemodel)
        FMTsemodel(const FMTsemodel& rhs);
        // DocString: FMTsemodel(const FMTmodel, const FMTforest)
        FMTsemodel(const FMTmodel& rhs,const Spatial::FMTforest& forest);
        // DocString: FMTsemodel(const FMTmodel, const FMTforest)
        FMTsemodel(const FMTmodel& rhs);
        // DocString: FMTsemodel::operator=
        FMTsemodel& operator = (const FMTsemodel& rhs);
        // DocString: FMTsemodel(FMTsemodel&&)
        FMTsemodel(FMTsemodel&& rhs)=default;
        // DocString: FMTsemodel::operator=(FMTsemodel&& rhs) 
        FMTsemodel& operator =(FMTsemodel&& rhs) =default;
        // DocString: FMTsemodel::getmapping
        Spatial::FMTforest getmapping() const;
        // DocString: FMTsemodel::getspschedule
        inline Spatial::FMTspatialschedule getspschedule() const
        {
            return solution;
        }
        // DocString: FMTsemodel::getdisturbancestats
        std::string getdisturbancestats() const;
        // DocString: FMTsemodel::getschedule
        std::vector<Core::FMTschedule> getschedule(bool withlock=false) const;
        // DocString: FMTsemodel::setinitialmapping
        bool setinitialmapping(Spatial::FMTforest forest);
        // DocString: FMTsemodel::LogConstraintsInfeasibilities
        void LogConstraintsInfeasibilities() const;
        // DocString: FMTsemodel::LogConstraintsFactors
        void LogConstraintsFactors() const;
        // DocString: FMTsemodel::presolve
        virtual std::unique_ptr<FMTmodel>presolve(
            std::vector<Core::FMTactualdevelopment> optionaldevelopments = std::vector<Core::FMTactualdevelopment>()) const;
        // DocString: FMTsemodel::postsolve
        virtual void postsolve(const FMTmodel& originalbasemodel);
        // DocString: FMTsemodel::getoutput
        virtual std::map<std::string, double> getoutput(const Core::FMToutput& output,
            int period, Core::FMToutputlevel level = Core::FMToutputlevel::standard) const;
        // DocString: FMTsemodel::getoutput
        virtual Spatial::FMTlayer<double> getspatialoutput(const Core::FMToutput& output,int period) const;
        // DocString: FMTsemodel::getsolution
        virtual Core::FMTschedule getsolution(int period, bool withlock = false) const;
        // DocString: FMTsemodel::clone
        virtual std::unique_ptr<FMTmodel>clone() const;
        // DocString: FMTsemodel::getarea
        virtual std::vector<Core::FMTactualdevelopment>getarea(int period = 0, bool beforegrowanddeath = false) const;
        // DocString: FMTsemodel::getcopy
        virtual std::unique_ptr<FMTmodel> getcopy(int period = 0) const;
        // DocString: FMTmodel::getobjectivevalue
        virtual double getobjectivevalue() const;
    };
 
}
 
BOOST_CLASS_EXPORT_KEY(Models::FMTsemodel)
 
#endif // FMTSEM_H_INCLUDED