FMTreplanningtask.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 FMTreplanningtask_H_INCLUDED
#define FMTreplanningtask_H_INCLUDED
 
#include "FMTtask.hpp"
#include "FMTactualdevelopment.hpp"
#include "FMTschedule.hpp"
#include <vector>
#include <queue>
#include <memory>
#include <string>
#include "FMTutility.hpp"
 
 
namespace Models
{
    class FMTmodel;
}
 
namespace Core
{
    class FMToutput;
}
 
 
 
namespace Parallel
{
    class FMTparallelwriter;
    // DocString: FMTreplanningtask
    class FMTEXPORT FMTreplanningtask : public FMTtask
    {
        // DocString: FMTreplanningtask::resultswriter
        std::shared_ptr<FMTparallelwriter>resultswriter;
        // DocString: FMTreplanningtask::baseschedule
        std::shared_ptr<Core::FMTschedule>baseschedule;
        // DocString: FMTreplanningtask::global
        std::shared_ptr<Models::FMTmodel>global;//base area is in here.
        // DocString: FMTreplanningtask::stochastic
        std::shared_ptr<Models::FMTmodel>stochastic;
        // DocString: FMTreplanningtask::local
        std::shared_ptr<Models::FMTmodel>local;
        // DocString: FMTreplanningtask::replicateids
        std::queue<int>replicateids;
        // DocString: FMTreplanningtask::dynamicarea
        std::vector<Core::FMTactualdevelopment>dynamicarea;
        // DocString: FMTreplanningtask::iterationglobalschedule
        Core::FMTschedule iterationglobalschedule;
        // DocString: FMTreplanningtask::dynamicconstraints
        std::vector<Core::FMTconstraint>dynamicconstraints;
        // DocString: FMTreplanningtask::replanningperiods
        int replanningperiods;
        // DocString: FMTreplanningtask::copysharedmodel
        std::unique_ptr<Models::FMTmodel>copysharedmodel(const std::shared_ptr<Models::FMTmodel>model);
        // DocString: FMTreplanningtask::domodelplanning
        std::unique_ptr<Models::FMTmodel>domodelplanning(
            const std::shared_ptr<Models::FMTmodel>model,
            const int& replanningperiod,
            bool getsolutionandlocal = false,
            bool applyscheduleweight = false,
            bool setdynamicconstraints=true);
        // DocString: FMTreplanningtask::writeresults
        void writeresults(const std::string& modelname,const int& modellength,
            const std::unique_ptr<Models::FMTmodel>& modelptr, const int& replanningperiod,bool onlyfirstperiod = false);
        // DocString: FMTreplanningtask::getiteration
        const int getiteration() const;
        // DocString: FMTreplanningtask::setreignore
        void setreignore(std::unique_ptr<Models::FMTmodel>& modelcpy, const int& replanningperiod) const;
        // DocString: FMTreplanningtask::setreplicate
        void setreplicate(std::unique_ptr<Models::FMTmodel>& modelcpy, const int& replanningperiod) const;
    public:
        // DocString: FMTreplanningtask::FMTreplanningtask()
        FMTreplanningtask() = default;
        // DocString: FMTreplanningtask::FMTreplanningtask(const FMTreplanningtask&)
        FMTreplanningtask(const FMTreplanningtask& rhs) = default;
        // DocString: FMTreplanningtask::operator=(const FMTreplanningtask&)
        FMTreplanningtask& operator = (const FMTreplanningtask& rhs) = default;
        // DocString: FMTreplanningtask::~FMTreplanningtask()
        virtual ~FMTreplanningtask() = default;
        // DocString: FMTreplanningtask::clone
        std::unique_ptr<FMTtask>clone() const;
        // DocString: FMTreplanningtask::FMTreplanningtask(...)
        FMTreplanningtask(const Models::FMTmodel& globalm,
                        const Models::FMTmodel& stochasticm,
                        const Models::FMTmodel& localm,
                        const std::vector<Core::FMToutput>& outputs,
                        const std::string& outputlocation,
                        const std::string& gdaldriver,
                        const std::vector<std::string>& creationoptions,
                        const int& replicates,
                        const int& replanningperiodssize,
                        const double& minimaldrift,
                        Core::FMToutputlevel outputlevel);
        // DocString: FMTreplanningtask::FMTreplanningtask(const Models::FMTmodel&,const Models::FMTmodel&,const Models::FMTmodel&)
        FMTreplanningtask(const Models::FMTmodel& globalm,
            const Models::FMTmodel& stochasticm,
            const Models::FMTmodel& localm,
            const std::string& outputlocation,
            const std::string& gdaldriver,
            const std::vector<std::string>& creationoptions,
            Core::FMToutputlevel outputlevel);
        // DocString: FMTreplanningtask::setreplicates
        void setreplicates(const int& replicatesnumber);
        // DocString: FMTreplanningtask::setreplanningperiods
        void setreplanningperiods(const int& periodsnumber);
        // DocString: FMTreplanningtask::split
        virtual std::vector<std::unique_ptr<FMTtask>>split(const unsigned int& numberoftasks) const;
        // DocString: FMTreplanningtask::spwan
        virtual std::unique_ptr<FMTtask>spawn();
        // DocString: FMTreplanningtask::work
        virtual void work();
        // DocString: FMTreplanningtask::finalize
        virtual void finalize();
        // DocString: FMTreplanningtask::passinlogger
        void passinlogger(const std::shared_ptr<Logging::FMTlogger>& logger) override;
 
    };
 
}
 
 
 
#endif