Parallel]

vtkThreadedController uses a vtkMultiThreader to spawn threads. More...

#include <vtkThreadedController.h>

Inheritance diagram for vtkThreadedController:

[legend]Collaboration diagram for vtkThreadedController:


Public Member Functions
	vtkTypeRevisionMacro (vtkThreadedController, vtkMultiProcessController)
void	PrintSelf (ostream &os, vtkIndent indent)
	Print the state of this object.
virtual void	Initialize (int argc, char **argv, int)
	This method is for setting up the processes.
virtual void	Initialize (int argc, char **argv)
virtual void	Finalize ()
virtual void	Finalize (int)
	vtkGetMacro (LocalProcessId, int)
	This method returns an integer from 0 to (NumberOfProcesses-1) indicating which process we are in.
virtual void	SingleMethodExecute ()
	Execute the SingleMethod (as define by SetSingleMethod) using this->NumberOfProcesses processes.
virtual void	MultipleMethodExecute ()
	Execute the MultipleMethods (as define by calling SetMultipleMethod for each of the required this->NumberOfProcesses methods) using this->NumberOfProcesses processes.
virtual void	Barrier ()
	This method can be used to synchronize the threads.
virtual void	CreateOutputWindow ()
	This method can be used to tell the controller to create a special output window in which all messages are preceded by the process id.
Static Public Member Functions
static vtkThreadedController *	New ()
	Instantiate a new object of this type.
Protected Types
typedef pthread_t	ThreadIdType
Protected Member Functions
	vtkThreadedController ()
	Ctor.
	~vtkThreadedController ()
	Dtor.
void	CreateProcessControllers ()
void	Start (int threadIdx)
	First method called after threads are spawned.
void	ResetControllers ()
vtkMultiProcessController *	GetLocalController ()
	For static GetGlobalController.
Static Protected Member Functions
static VTK_THREAD_RETURN_TYPE	vtkThreadedControllerStart (void *arg)
static void	WaitForPreviousBarrierToEnd ()
static void	BarrierStarted ()
static void	BarrierEnded ()
static void	SignalNextThread ()
static void	InitializeBarrier ()
static void	WaitForNextThread ()
Protected Attributes
vtkThreadedController **	Controllers
	Each Process/Thread has its own controller.
ThreadIdType	ThreadId
int	LastNumberOfProcesses
vtkMultiThreader *	MultiThreader
int	MultipleMethodFlag
	Used internally to switch between multiple and single method execution.
Static Protected Attributes
static vtkSimpleCriticalSection	CounterLock
	Used in barrier.
static int	Counter
static int	IsBarrierInProgress
static vtkSimpleCriticalSection *	BarrierLock
static vtkSimpleCriticalSection *	BarrierInProgress

Detailed Description

vtkThreadedController uses a vtkMultiThreader to spawn threads.

The communication is accomplished using a vtkSharedMemoryCommunicator. The RMI communicator is identical to the user communicator. Note that each thread gets its own vtkThreadedController to accomplish thread safety.

See also:: vtkMultiProcessController vtkMultiThreader vtkSharedMemoryCommunicator vtkInputPort vtkOutputPort

Note:: This class has been depreciated as of VTK 5.2.

Definition at line 50 of file vtkThreadedController.h.

Member Typedef Documentation

typedef pthread_t vtkThreadedController::ThreadIdType [protected]

Definition at line 150 of file vtkThreadedController.h.

Constructor & Destructor Documentation

vtkThreadedController::vtkThreadedController ( ) [protected]

Ctor.

vtkThreadedController::~vtkThreadedController ( ) [protected]

Dtor.

Member Function Documentation

static vtkThreadedController* vtkThreadedController::New ( ) [static]

Instantiate a new object of this type.

This is the only method that objects of this type may be created.

Returns:: The new object.

Reimplemented from vtkObject.

vtkThreadedController::vtkTypeRevisionMacro	(	vtkThreadedController	,
		vtkMultiProcessController
	)

void vtkThreadedController::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)			`[virtual]`

Print the state of this object.

Parameters:

	os	The output stream.
	indent	The indentation level. Used for formating output.

Reimplemented from vtkMultiProcessController.

virtual void vtkThreadedController::Initialize	(	int *	argc,
		char ***	argv,
		int
	)			`[inline, virtual]`

This method is for setting up the processes.

Definition at line 75 of file vtkThreadedController.h.

References vtkMultiProcessController::Initialize().

virtual void vtkThreadedController::Initialize	(	int *	argc,
		char ***	argv
	)			`[virtual]`

virtual void vtkThreadedController::Finalize ( ) [virtual]

Implements vtkMultiProcessController.

virtual void vtkThreadedController::Finalize ( int ) [inline, virtual]

Implements vtkMultiProcessController.

Definition at line 79 of file vtkThreadedController.h.

References vtkMultiProcessController::Finalize().

vtkThreadedController::vtkGetMacro	(	LocalProcessId	,
		int
	)

This method returns an integer from 0 to (NumberOfProcesses-1) indicating which process we are in.

Note: The correct controller is passed as an argument to the initial function (SingleMethod/MultipleMethod). Calling this method on another controller may give wrong results.

virtual void vtkThreadedController::SingleMethodExecute ( ) [virtual]

Execute the SingleMethod (as define by SetSingleMethod) using this->NumberOfProcesses processes.

This will only return when all the processes finish executing their methods.

Implements vtkMultiProcessController.

virtual void vtkThreadedController::MultipleMethodExecute ( ) [virtual]

Execute the MultipleMethods (as define by calling SetMultipleMethod for each of the required this->NumberOfProcesses methods) using this->NumberOfProcesses processes.

Implements vtkMultiProcessController.

virtual void vtkThreadedController::Barrier ( ) [virtual]

This method can be used to synchronize the threads.

Implements vtkMultiProcessController.

virtual void vtkThreadedController::CreateOutputWindow ( ) [virtual]

This method can be used to tell the controller to create a special output window in which all messages are preceded by the process id.

Implements vtkMultiProcessController.

void vtkThreadedController::CreateProcessControllers ( ) [protected]