vtkThreadMessager Class Reference

#include <vtkThreadMessager.h>

Inheritance diagram for vtkThreadMessager:

[legend]Collaboration diagram for vtkThreadMessager:

[legend]List of all members.

---

Detailed Description

A class for performing inter-thread messaging.

vtkMultithreader is a class that provides support for messaging between threads multithreaded using pthreads or Windows messaging.

Definition at line 31 of file vtkThreadMessager.h.

Public Types
typedef vtkObject	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	WaitForMessage ()
void	SendWakeMessage ()
void	EnableWaitForReceiver ()
void	DisableWaitForReceiver ()
void	WaitForReceiver ()
void	SendMessage ()
Static Public Member Functions
static vtkThreadMessager *	New ()
static int	IsTypeOf (const char *type)
static vtkThreadMessager *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkThreadMessager ()
	~vtkThreadMessager ()

---

Member Typedef Documentation

typedef vtkObject vtkThreadMessager::Superclass

Reimplemented from vtkObject. Definition at line 36 of file vtkThreadMessager.h.

---

Constructor & Destructor Documentation

vtkThreadMessager::vtkThreadMessager (   )  [protected]

vtkThreadMessager::~vtkThreadMessager (   )  [protected]

---

Member Function Documentation

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

Create an object with Debug turned off, modified time initialized to zero, and reference counting on. Reimplemented from vtkObject.

virtual const char* vtkThreadMessager::GetClassName (   )  [virtual]

Reimplemented from vtkObject.

static int vtkThreadMessager::IsTypeOf (  const char *  type  )  [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h. Reimplemented from vtkObject.

virtual int vtkThreadMessager::IsA (  const char *  type  )  [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h. Reimplemented from vtkObject.

static vtkThreadMessager* vtkThreadMessager::SafeDownCast (  vtkObject *  o  )  [static]

Reimplemented from vtkObject.

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

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes. Reimplemented from vtkObject.

void vtkThreadMessager::WaitForMessage (   )

Wait (block, non-busy) until another thread sends a message.

void vtkThreadMessager::SendWakeMessage (   )

Send a message to all threads who are waiting via WaitForMessage().

void vtkThreadMessager::EnableWaitForReceiver (   )

pthreads only. If the wait is enabled, the thread who is to call WaitForMessage() will block until a receiver thread is ready to receive.

void vtkThreadMessager::DisableWaitForReceiver (   )

pthreads only. If the wait is enabled, the thread who is to call WaitForMessage() will block until a receiver thread is ready to receive.

void vtkThreadMessager::WaitForReceiver (   )

pthreads only. If wait is enable, this will block until one thread is ready to receive a message.

void vtkThreadMessager::SendMessage (   )

Deprecated: Replaced by vtkThreadMessager::SendWakeMessage() as of VTK 5.0.

---

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

• dox/Common/vtkThreadMessager.h

---