FMTOpAreaSchedulerTask.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 FMTopareaschedulertask_Hm_included
#define FMTopareaschedulertask_Hm_included
 
#include "FMTutility.h"
#include "FMTTask.h"
#include <vector>
#include <memory>
#include <string>
#include <chrono>
#include <boost/thread.hpp>
#include "FMTOutput.h"
 
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 int& 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 int& 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: FMTopareaschedulertask::passInLogger
        void passInLogger(const std::unique_ptr<Logging::FMTLogger>& logger) override;
        // DocString: FMTopareaschedulertask::SupportsMultiThreading()
        bool SupportsMultiThreading() const override;
 
    };
 
}
 
 
 
#endif