Parallel::FMTWorkerTask Class Reference

RAII wrapper running a FMTTask on its own boost thread and tracking its completion. More...

#include <FMTWorkerTask.h>

Public Member Functions
	FMTWorkerTask (std::unique_ptr< FMTTask > t)
	Construct a FMTWorkerTask from a task and start it on a worker thread.
	FMTWorkerTask (const FMTWorkerTask &)=delete
	Deleted copy constructor for FMTWorkerTask.
FMTWorkerTask &	operator= (const FMTWorkerTask &)=delete
	Deleted copy assignment operator for FMTWorkerTask.
	FMTWorkerTask (FMTWorkerTask &&)=delete
	Deleted move constructor for FMTWorkerTask.
FMTWorkerTask &	operator= (FMTWorkerTask &&)=delete
	Deleted move assignment operator for FMTWorkerTask.
	~FMTWorkerTask ()
	Destructor for FMTWorkerTask, joining the worker thread.
bool	isDone () const
	Return true if the task is done.
boost::thread &	getThread ()
	Return the worker thread.

Detailed Description

RAII wrapper running a FMTTask on its own boost thread and tracking its completion.

Constructor & Destructor Documentation

FMTWorkerTask() [1/3]

Parallel::FMTWorkerTask::FMTWorkerTask

(

std::unique_ptr< FMTTask >

t

)

Construct a FMTWorkerTask from a task and start it on a worker thread.

Parameters

[in]

t

the task to run.

FMTWorkerTask() [2/3]

Parallel::FMTWorkerTask::FMTWorkerTask ( const FMTWorkerTask &  )

delete

Deleted copy constructor for FMTWorkerTask.

FMTWorkerTask() [3/3]

Parallel::FMTWorkerTask::FMTWorkerTask ( FMTWorkerTask &&  )

delete

Deleted move constructor for FMTWorkerTask.

~FMTWorkerTask()

Parallel::FMTWorkerTask::~FMTWorkerTask

(

)

Destructor for FMTWorkerTask, joining the worker thread.

Member Function Documentation

getThread()

boost::thread & Parallel::FMTWorkerTask::getThread

(

)

Return the worker thread.

Returns

the worker thread.

isDone()

bool Parallel::FMTWorkerTask::isDone

(

)

const

Return true if the task is done.

Returns

true if the task is done else false.

operator=() [1/2]

FMTWorkerTask & Parallel::FMTWorkerTask::operator= ( const FMTWorkerTask &  )

delete

Deleted copy assignment operator for FMTWorkerTask.

operator=() [2/2]

FMTWorkerTask & Parallel::FMTWorkerTask::operator= ( FMTWorkerTask &&  )

delete

Deleted move assignment operator for FMTWorkerTask.

---

The documentation for this class was generated from the following file:

• D:/FMT/Include/FMTWorkerTask.h