itk::MultiThreader::ThreadInfoStruct Struct Reference

#include <itkMultiThreader.h>

Collaboration diagram for itk::MultiThreader::ThreadInfoStruct:

List of all members.

Public Types
enum	{   SUCCESS,   ITK_EXCEPTION,   ITK_PROCESS_ABORTED_EXCEPTION,   STD_EXCEPTION,   UNKNOWN }

Public Attributes
int *	ActiveFlag
MutexLock::Pointer	ActiveFlagLock
int	NumberOfThreads
enum itk::MultiThreader::ThreadInfoStruct:: { ... }	ThreadExitCode
ThreadFunctionType	ThreadFunction
int	ThreadID
void *	UserData

---

Detailed Description

This is the structure that is passed to the thread that is created from the SingleMethodExecute, MultipleMethodExecute or the SpawnThread method. It is passed in as a void *, and it is up to the method to cast correctly and extract the information. The ThreadID is a number between 0 and NumberOfThreads-1 that indicates the id of this thread. The NumberOfThreads is this->NumberOfThreads for threads created from SingleMethodExecute or MultipleMethodExecute, and it is 1 for threads created from SpawnThread. The UserData is the (void *)arg passed into the SetSingleMethod, SetMultipleMethod, or SpawnThread method.

Definition at line 229 of file itkMultiThreader.h.

---

Member Enumeration Documentation

anonymous enum

Enumerator:

SUCCESS
ITK_EXCEPTION
ITK_PROCESS_ABORTED_EXCEPTION
STD_EXCEPTION
UNKNOWN

Definition at line 240 of file itkMultiThreader.h.

---

Member Data Documentation

int* itk::MultiThreader::ThreadInfoStruct::ActiveFlag

Definition at line 236 of file itkMultiThreader.h.

Referenced by itk::MultiThreader::MultiThreader(), itk::MultiThreader::SpawnThread(), itk::ThreadLogger::ThreadFunction(), and itk::LoggerThreadWrapper< SimpleLoggerType >::ThreadFunction().

MutexLock::Pointer itk::MultiThreader::ThreadInfoStruct::ActiveFlagLock

Definition at line 237 of file itkMultiThreader.h.

Referenced by itk::MultiThreader::MultiThreader(), itk::MultiThreader::SpawnThread(), itk::ThreadLogger::ThreadFunction(), and itk::LoggerThreadWrapper< SimpleLoggerType >::ThreadFunction().

int itk::MultiThreader::ThreadInfoStruct::NumberOfThreads

Definition at line 235 of file itkMultiThreader.h.

Referenced by itk::MultiThreader::MultipleMethodExecute(), itk::MultiThreader::SingleMethodExecute(), and itk::MultiThreader::SpawnThread().

enum { ... } itk::MultiThreader::ThreadInfoStruct::ThreadExitCode

Referenced by itk::MultiThreader::SingleMethodProxy().

ThreadFunctionType itk::MultiThreader::ThreadInfoStruct::ThreadFunction

Definition at line 239 of file itkMultiThreader.h.

Referenced by itk::MultiThreader::SingleMethodExecute(), and itk::MultiThreader::SingleMethodProxy().

int itk::MultiThreader::ThreadInfoStruct::ThreadID

Definition at line 234 of file itkMultiThreader.h.

Referenced by itk::MultiThreader::MultiThreader().

void* itk::MultiThreader::ThreadInfoStruct::UserData

Definition at line 238 of file itkMultiThreader.h.

Referenced by itk::MultiThreader::MultipleMethodExecute(), itk::MultiThreader::SingleMethodExecute(), itk::MultiThreader::SpawnThread(), itk::ThreadLogger::ThreadFunction(), itk::LoggerThreadWrapper< SimpleLoggerType >::ThreadFunction(), and otb::CoordinateToName::ThreadFunction().

---

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

• itkMultiThreader.h