FMTTaskHandler.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 FMTTASKHANDLER_Hm_included
#define FMTTASKHANDLER_Hm_included
#include <memory>
#include "FMTObject.h"
 
namespace boost
    {
    class thread;
    }
 
namespace Parallel
{
    class FMTTask;
    // DocString: FMTTaskHandler
    class FMTEXPORT FMTTaskHandler : public Core::FMTObject
    {
    
    public:
        // DocString: FMTTaskHandler::FMTTaskHandler(const std::unique_ptr<FMTTask>&,unsigned int)
        FMTTaskHandler(const std::unique_ptr<FMTTask>& maintask,
                        unsigned int maxthread = 0);
        // DocString: ~FMTTaskHandler()
        ~FMTTaskHandler()=default;
        // DocString: FMTTaskHandler::FMTTaskHandler(const Parallel::FMTTask&,unsigned int)
        FMTTaskHandler(const FMTTask& maintask,
            unsigned int maxthread = 0);
        // DocString: FMTTaskHandler::FMTTaskHandler()
        FMTTaskHandler() = default;
        // DocString: FMTTaskHandler::FMTTaskHandler(const FMTTaskHandler)
        FMTTaskHandler(const FMTTaskHandler& rhs);
        // DocString: FMTTaskHandler::operator=
        FMTTaskHandler& operator =(const FMTTaskHandler& rhs);
        // DocString: FMTTaskHandler::getTasks
        const std::vector<std::unique_ptr<FMTTask>>& getTasks() const;
        // DocString: FMTTaskHandler::getTasksFromDynamicCast
        template<class ptrtype>
        const std::vector<const ptrtype*> getTasksFromDynamicCast() const
        {
            std::vector<const ptrtype*>castedptr;
            for (const std::unique_ptr<FMTTask>& task : m_alltasks)
            {
                castedptr.push_back(dynamic_cast<const ptrtype*>(task.get()));
            }
            return castedptr;
        }
        // DocString: FMTTaskHandler::conccurentRun
        void conccurentRun();
        // DocString: FMTTaskHandler::onDemandRun
        void onDemandRun();
        // DocString: FMTTaskHandler::passInLogger
        void passInLogger(const std::unique_ptr<Logging::FMTLogger>& logger) override;
    private:
        // DocString: FMTTaskHandler::m_maxnumberofthread
        unsigned int m_maxnumberofthread;
        // DocString: FMTTaskHandler::m_alltasks
        std::vector<std::unique_ptr<FMTTask>>m_alltasks;
        // DocString: FMTTaskHandler::_splitTasks
        void _splitTasks();
        // DocString: FMTTaskHandler::_finalize
        void _finalize(std::unique_ptr<FMTTask>& lasttask);
        // DocString: FMTTaskHandler::_logTaskTime
        void _logTaskTime(const std::chrono::time_point<std::chrono::high_resolution_clock>& startime) const;
        // DocString: FMTTaskHandler::_interruptWork
        static void _interruptWork(boost::thread& p_thread);
        // DocString: FMTTaskHandler::_setMaximumNumberOfThreads
        void _setMaximumNumberOfThreads(const FMTTask& p_MainTask,
                                                unsigned int p_UserDecision);
 
    };
 
}
 
#endif