FMTTask.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 FMTTASK_Hm_included
#define FMTTASK_Hm_included
#include <memory>
#include "FMTObject.h"
#include <boost/thread/recursive_mutex.hpp>
#include <boost/thread/condition_variable.hpp>
#if defined _MSC_VER
    #include "FMTScopedSeTranslator.h"
#endif
 
 
namespace Parallel
{
    // DocString: FMTTask
    class FMTEXPORT FMTTask : public Core::FMTObject
    {
    public:
        // DocString: FMTTask::FMTTask()
        FMTTask();
        // DocString: ~FMTTask()
        virtual ~FMTTask() = default;
        // DocString: FMTTask::FMTTask(const FMTTask&)
        FMTTask(const FMTTask& rhs);
        // DocString: FMTTask::operator=(const FMTTask&)
        FMTTask& operator = (const FMTTask& rhs);
        // DocString: FMTTask::clone()
        virtual std::unique_ptr<FMTTask>clone() const;
        // DocString: FMTTask::split()
        virtual std::vector<std::unique_ptr<FMTTask>>split(const unsigned int& numberoftasks) const;
        // DocString: FMTTask::spawn()
        virtual std::unique_ptr<FMTTask>spawn();
        // DocString: FMTTask::work
        virtual void work();
        // DocString: FMTTask::run
        virtual void run();
        // DocString: FMTTask::finalize
        virtual void finalize();
        // DocString: FMTTask::isDone()
        //bool isDone() const;
        // DocString: FMTTask::getThreadId()
        static std::string getThreadId();
        // DocString: FMTTask::setTotalThreads()
        static void setTotalThreads(const size_t& p_threads);
        // DocString: FMTTask::SupportsMultiThreading()
        virtual bool SupportsMultiThreading() const;
        // DocString: FMTTaskHandler::done
        bool done;
    protected:
        // DocString: FMTTask::mutex
        static boost::recursive_mutex m_taskmutex;
        // DocString: FMTTask::m_tasklogger
        std::unique_ptr<Logging::FMTLogger>m_tasklogger;
        // DocString: FMTTask::setStatus()
        //void setStatus(bool status);
        // DocString: FMTTask::_splitWork
        std::vector<size_t>_splitWork(int numberoftasks,const int& totalworksize) const;
        // DocString: FMTTask::_decrementWorkingThread()
        void _decrementWorkingThread();
        // DocString: FMTTask::_checkpoint()
        void _checkpoint();
        // DocString: FMTTask::_setCrashHandlers
        void _setCrashHandlers();
    private:
        // DocString: FMTTask::m_workingThreads
        static size_t m_workingThreads;
        // DocString: FMTTask::m_allThreads
        static size_t m_allThreads;
        // DocString: FMTTask::m_checkpoint
        static boost::condition_variable m_checkpoint;
        // DocString: FMTTask::m_checkpointMutex
        static boost::mutex m_checkpointMutex;
        #if defined _MSC_VER
        // DocString: FMTTask::m_SeTranslator
        Exception::FMTScopedSeTranslator m_SeTranslator;
        #endif
    
        
    };
 
}
 
#endif