vtkSubCommunicator Class Reference

#include <vtkSubCommunicator.h>

Inheritance diagram for vtkSubCommunicator:

Inheritance graph
[legend]
Collaboration diagram for vtkSubCommunicator:

Collaboration graph
[legend]

List of all members.


Detailed Description

Provides communication on a process group.

This class provides an implementation for communicating on process groups. In general, you should never use this class directly. Instead, use the vtkMultiProcessController::CreateSubController method.

Bug:
Because all communication is delegated to the original communicator, any error will report process ids with respect to the original communicator, not this communicator that was actually used.
See also:
vtkCommunicator, vtkMultiProcessController
Thanks:
This class was originally written by Kenneth Moreland (kmorel@sandia.gov) from Sandia National Laboratories.

Definition at line 52 of file vtkSubCommunicator.h.


Public Types

typedef vtkCommunicator Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
virtual void PrintSelf (ostream &os, vtkIndent indent)
virtual vtkProcessGroupGetGroup ()
virtual void SetGroup (vtkProcessGroup *group)
virtual int SendVoidArray (const void *data, vtkIdType length, int type, int remoteHandle, int tag)
virtual int ReceiveVoidArray (void *data, vtkIdType length, int type, int remoteHandle, int tag)

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkSubCommunicatorSafeDownCast (vtkObject *o)
static vtkSubCommunicatorNew ()

Protected Member Functions

 vtkSubCommunicator ()
virtual ~vtkSubCommunicator ()

Protected Attributes

vtkProcessGroupGroup

Member Typedef Documentation

Reimplemented from vtkCommunicator.

Definition at line 55 of file vtkSubCommunicator.h.


Constructor & Destructor Documentation

vtkSubCommunicator::vtkSubCommunicator (  )  [protected]

virtual vtkSubCommunicator::~vtkSubCommunicator (  )  [protected, virtual]


Member Function Documentation

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

Reimplemented from vtkCommunicator.

static int vtkSubCommunicator::IsTypeOf ( const char *  name  )  [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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkCommunicator.

virtual int vtkSubCommunicator::IsA ( const char *  name  )  [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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkCommunicator.

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

Reimplemented from vtkCommunicator.

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

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

Reimplemented from vtkObject.

virtual void vtkSubCommunicator::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 vtkCommunicator.

virtual vtkProcessGroup* vtkSubCommunicator::GetGroup (  )  [virtual]

Set/get the group on which communication will happen.

virtual void vtkSubCommunicator::SetGroup ( vtkProcessGroup group  )  [virtual]

Set/get the group on which communication will happen.

virtual int vtkSubCommunicator::SendVoidArray ( const void *  data,
vtkIdType  length,
int  type,
int  remoteHandle,
int  tag 
) [virtual]

Implementation for abstract supercalss.

Implements vtkCommunicator.

virtual int vtkSubCommunicator::ReceiveVoidArray ( void *  data,
vtkIdType  length,
int  type,
int  remoteHandle,
int  tag 
) [virtual]

Implementation for abstract supercalss.

Implements vtkCommunicator.


Member Data Documentation

Definition at line 77 of file vtkSubCommunicator.h.


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

Generated on Wed Aug 24 12:10:00 2011 for VTK by  doxygen 1.5.6