Main Page | Directories | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

vtkThreadMessager Class Reference

#include <vtkThreadMessager.h>

Inheritance diagram for vtkThreadMessager:

Inheritance graph
[legend]
Collaboration diagram for vtkThreadMessager:

Collaboration graph
[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.

Created by:
  • Geveci, Berk
CVS contributions (if > 5%):
  • Geveci, Berk (100%)
CVS logs (CVSweb):
  • .cxx (/Common/vtkThreadMessager.cxx)
  • .h (/Common/vtkThreadMessager.h)

Definition at line 41 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 SendMessage ()
void EnableWaitForReceiver ()
void DisableWaitForReceiver ()
void WaitForReceiver ()

Static Public Member Functions

vtkThreadMessagerNew ()
int IsTypeOf (const char *type)
vtkThreadMessagerSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkThreadMessager ()
 ~vtkThreadMessager ()


Member Typedef Documentation

typedef vtkObject vtkThreadMessager::Superclass
 

Reimplemented from vtkObject.

Definition at line 46 of file vtkThreadMessager.h.


Constructor & Destructor Documentation

vtkThreadMessager::vtkThreadMessager  )  [protected]
 

vtkThreadMessager::~vtkThreadMessager  )  [protected]
 


Member Function Documentation

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.

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.

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::SendMessage  ) 
 

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.


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