FMTopareaschedulertask.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 FMTopareaschedulertask_H_INCLUDED
#define FMTopareaschedulertask_H_INCLUDED
 
#include "FMTutility.hpp"
#include "FMTtask.hpp"
#include <vector>
#include <memory>
#include <string>
#include <chrono>
#include <boost/thread.hpp>
#include "FMToutput.hpp"
 
namespace Core
{
    class FMToutputnode;
    class FMTconstraint;
}
 
 
namespace Models
{
    class FMTlpmodel;
}
 
namespace Heuristics
{
    class FMToperatingareascheme;
    class FMToperatingareascheduler;
}
 
namespace Parallel
{
    // DocString: FMTopareaschedulertask
    class FMTEXPORT FMTopareaschedulertask : public FMTtask
    {
        // DocString: FMTopareaschedulertask::generalmutex
        static boost::mutex generalmutex;
        // DocString: FMTopareaschedulertask::bestscheduler;
        std::shared_ptr<Heuristics::FMToperatingareascheduler>bestscheduler;
        // DocString: FMTopareaschedulertask::actualscheduler
        std::unique_ptr<Heuristics::FMToperatingareascheduler>actualscheduler;
        // DocString: FMTopareaschedulertask::solutionlocation
        static std::string solutionlocation;
        // DocString: FMTopareaschedulertask::iterations
        static unsigned int iterations;
        // DocString: FMTopareaschedulertask::stoptime
        static std::chrono::time_point<std::chrono::high_resolution_clock>stoptime;
        // DocString: FMTopareaschedulertask::irelax_objective
        static double relax_objective;
        // DocString: FMTopareaschedulertask::outyldname
        static std::string outyldname;
        // DocString: FMTopareaschedulertask::basemodel
        static std::unique_ptr<Models::FMTlpmodel>basemodel;
        // DocString: FMTopareaschedulertask::lastspawned
        int lastspawned;
        // DocString: FMTopareaschedulertask::solveinitialmodel
        double solveinitialmodel(Models::FMTlpmodel& model) const;
        // DocString: FMTopareaschedulertask::setinitialscheduler
        void setinitialscheduler(Models::FMTlpmodel& model,
            const std::vector<Heuristics::FMToperatingareascheme>& opareas,const Core::FMToutputnode& node);
        // DocString: FMTopareaschedulertask::getstoppoint
        std::chrono::time_point<std::chrono::high_resolution_clock>getstoppoint(const double& timegap) const;
        // DocString: FMTopareaschedulertask::getconstraintssolution
        void getconstraintssolution(std::vector<Core::FMToutput>& outputs,std::vector<Core::FMTconstraint>& constraints) const;
        // DocString: FMTopareaschedulertask::writefinalmodel
        void writefinalmodel() const;
        // DocString: FMTopareaschedulertask::writesolution
        void writesolution() const;
        // DocString: FMTopareaschedulertask::gotinitialsolution
        bool gotinitialsolution() const;
        // DocString: FMTopareaschedulertask::evaluateandcopy
        void evaluateandcopy();
        // DocString: FMTopareaschedulertask::goodtogo
        bool goodtogo() const;
        // DocString: FMTopareaschedulertask::getreturntimefromoutput
        std::vector<Heuristics::FMToperatingareascheme> getreturntimefromoutput(Models::FMTlpmodel& model,
            const std::vector<Heuristics::FMToperatingareascheme>& opareas,
            const Core::FMToutput& output) const;
    public:
        // DocString: FMTopareaschedulertask::FMTopareaschedulertask()
        FMTopareaschedulertask() = default;
        // DocString: FMTopareaschedulertask::FMTopareaschedulertask(const FMTopareaschedulertask&)
        FMTopareaschedulertask(const FMTopareaschedulertask& rhs);
        // DocString: FMTopareaschedulertask::operator=(const FMTopareaschedulertask&)
        FMTopareaschedulertask& operator = (const FMTopareaschedulertask& rhs);
        // DocString: FMTopareaschedulertask::~FMTopareaschedulertask()
        virtual ~FMTopareaschedulertask()=default;
        // DocString: FMTopareaschedulertask::clone
        std::unique_ptr<FMTtask>clone() const;
        // DocString: FMTopareaschedulertask::FMTopareaschedulertask(...)
        FMTopareaschedulertask(const Models::FMTlpmodel& model,
            const std::vector<Heuristics::FMToperatingareascheme>& opareas,
            const Core::FMToutputnode& node,
            const std::string& outputlocation,
            const std::string& outputyieldname,
            const unsigned int& maxiterations,
            const double& maxtime,
            Core::FMToutput returntime_output = Core::FMToutput());
        // DocString: FMTopareaschedulertask::split
        virtual std::vector<std::unique_ptr<FMTtask>>split(const unsigned int& numberoftasks) const;
        // DocString: FMTopareaschedulertask::spawn
        virtual std::unique_ptr<FMTtask>spawn();
        // DocString: FMTopareaschedulertask::work
        virtual void work();
        // DocString: FMTopareaschedulertask::finalize
        virtual void finalize();
        // DocString: FMTopareaschedulertaskk::passinlogger
        void passinlogger(const std::shared_ptr<Logging::FMTlogger>& logger) override;
 
    };
 
}
 
 
 
#endif