FMTtask.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 FMTTASK_H_INCLUDED
#define FMTTASK_H_INCLUDED
#include <memory>
#include "FMTobject.hpp"
#include <boost/thread/recursive_mutex.hpp>
 
/*namespace Logging
{
    class FMTlogger;
}*/
 
 
namespace Parallel
{
    // DocString: FMTtask
    class FMTEXPORT FMTtask : public Core::FMTobject
    {
        // DocString: FMTtaskhandler::done
        bool done;
        protected:
        // DocString: FMTtaskhandler::mutex
        static boost::recursive_mutex taskmutex;
        // DocString: FMTtaskhandler::tasklogger
        std::unique_ptr<Logging::FMTlogger>tasklogger;
        // DocString: FMTreplanningtask::setstatus()
        void setstatus(bool status);
        // DocString: FMTreplanningtask::split()
        std::vector<size_t>splitwork(int numberoftasks,const int& totalworksize) const;
    public:
        // DocString: FMTreplanningtask::FMTtask()
        FMTtask();
        // DocString: ~FMTtask()
        virtual ~FMTtask() = default;
        // DocString: FMTreplanningtask::FMTtask(const FMTtask&)
        FMTtask(const FMTtask& rhs);
        // DocString: FMTreplanningtask::operator=(const FMTtask&)
        FMTtask& operator = (const FMTtask& rhs);
        // DocString: FMTreplanningtask::clone()
        virtual std::unique_ptr<FMTtask>clone() const;
        // DocString: FMTreplanningtask::split()
        virtual std::vector<std::unique_ptr<FMTtask>>split(const unsigned int& numberoftasks) const;
        // DocString: FMTreplanningtask::spawn()
        virtual std::unique_ptr<FMTtask>spawn();
        // DocString: FMTreplanningtask::work
        virtual void work();
        // DocString: FMTreplanningtask::finalize
        virtual void finalize();
        // DocString: FMTreplanningtask::isdone()
        bool isdone() const;
        // DocString: FMTreplanningtask::getthreadid()
        std::string getthreadid() const;
        
    };
 
}
 
 
 
#endif