itk::ThreadJob Class Reference

#include <itkThreadJob.h>

Detailed Description

This class is used to submit jobs to the thread pool. The thread job maintains important information of the submitted job such as Job Id, information to identify if the job has finished executing. It holds the function pointer that the user sets to the function the user wants to be executed in parallel by the thread pool. Also holds the args pointer - it is passed to the executing function by the thread pool.

Definition at line 39 of file itkThreadJob.h.

Public Types
typedef int	JobIdType

Public Member Functions
	ThreadJob ()
	~ThreadJob ()

Public Attributes
bool	m_Assigned
bool	m_Executed
JobIdType	m_Id
void *	m_UserData
void *(*	m_ThreadFunction )(void *ptr)

Member Typedef Documentation

typedef int itk::ThreadJob::JobIdType

Definition at line 42 of file itkThreadJob.h.

Constructor & Destructor Documentation

itk::ThreadJob::ThreadJob ( )

inline

Definition at line 44 of file itkThreadJob.h.

itk::ThreadJob::~ThreadJob ( )

inline

Definition at line 53 of file itkThreadJob.h.

Member Data Documentation

bool itk::ThreadJob::m_Assigned

Set if the job is assigned to a thread

Definition at line 71 of file itkThreadJob.h.

bool itk::ThreadJob::m_Executed

set if job is finished

Definition at line 74 of file itkThreadJob.h.

JobIdType itk::ThreadJob::m_Id

This is the Job's id. If it is -1 it means the job hasn't been initialized

Definition at line 68 of file itkThreadJob.h.

void*(* itk::ThreadJob::m_ThreadFunction)(void *ptr)

Declaring function thatwill be called

Definition at line 62 of file itkThreadJob.h.

void* itk::ThreadJob::m_UserData

Stores the user's data that needs to be passed into the function

Definition at line 77 of file itkThreadJob.h.

---

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

• itkThreadJob.h