VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkProcessGroup Class Reference

A subgroup of processes from a communicator. More...

#include <vtkProcessGroup.h>

Inheritance diagram for vtkProcessGroup:
[legend]
Collaboration diagram for vtkProcessGroup:
[legend]

Public Types

typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkProcessGroupNewInstance () const
 
virtual void PrintSelf (ostream &os, vtkIndent indent)
 
void SetCommunicator (vtkCommunicator *communicator)
 
int GetProcessId (int pos)
 
int GetLocalProcessId ()
 
int FindProcessId (int processId)
 
int AddProcessId (int processId)
 
int RemoveProcessId (int processId)
 
void RemoveAllProcessIds ()
 
void Copy (vtkProcessGroup *group)
 
void Initialize (vtkMultiProcessController *controller)
 
void Initialize (vtkCommunicator *communicator)
 
virtual vtkCommunicatorGetCommunicator ()
 
virtual int GetNumberOfProcessIds ()
 
- Public Member Functions inherited from vtkObject
vtkObjectNewInstance () const
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual unsigned long GetMTime ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkProcessGroupSafeDownCast (vtkObjectBase *o)
 
static vtkProcessGroupNew ()
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObjectBase *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkProcessGroup ()
 
virtual ~vtkProcessGroup ()
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

intProcessIds
 
int NumberOfProcessIds
 
vtkCommunicatorCommunicator
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

A subgroup of processes from a communicator.

This class is used for creating groups of processes. A vtkProcessGroup is initialized by passing the controller or communicator on which the group is based off of. You can then use the group to subset and reorder the the processes. Eventually, you can pass the group object to the CreateSubController method of vtkMultiProcessController to create a controller for the defined group of processes. You must use the same controller (or attached communicator) from which this group was initialized with.

See also
vtkMultiProcessController, vtkCommunicator
Thanks:
This class was originally written by Kenneth Moreland (kmore.nosp@m.l@sa.nosp@m.ndia..nosp@m.gov) from Sandia National Laboratories.
Tests:
vtkProcessGroup (Tests)

Definition at line 56 of file vtkProcessGroup.h.

Member Typedef Documentation

Definition at line 59 of file vtkProcessGroup.h.

Constructor & Destructor Documentation

vtkProcessGroup::vtkProcessGroup ( )
protected
virtual vtkProcessGroup::~vtkProcessGroup ( )
protectedvirtual

Member Function Documentation

static int vtkProcessGroup::IsTypeOf ( const char *  type)
static
virtual int vtkProcessGroup::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 vtkObject.

static vtkProcessGroup* vtkProcessGroup::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkProcessGroup::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkObject.

vtkProcessGroup* vtkProcessGroup::NewInstance ( ) const
static vtkProcessGroup* vtkProcessGroup::New ( )
static
virtual void vtkProcessGroup::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 vtkProcessGroup::Initialize ( vtkMultiProcessController controller)

Initialize the group to the given controller or communicator. The group will be set to contain all of the processes in the controller/communicator in the same order.

void vtkProcessGroup::Initialize ( vtkCommunicator communicator)

Initialize the group to the given controller or communicator. The group will be set to contain all of the processes in the controller/communicator in the same order.

virtual vtkCommunicator* vtkProcessGroup::GetCommunicator ( )
virtual

Get the communicator on which this group is based on.

void vtkProcessGroup::SetCommunicator ( vtkCommunicator communicator)

Set the communicator. This has the same effect as Initialize except that the contents of the group will not be modified (although they may be truncated if the new communicator is smaller than the current group). Note that this can lead to an invalid group if there are values in the group that are not valid in the new communicator.

virtual int vtkProcessGroup::GetNumberOfProcessIds ( )
virtual

Returns the size of this group (the number of processes defined in it).

int vtkProcessGroup::GetProcessId ( int  pos)
inline

Given a position in the group, returns the id of the process in the communicator this group is based on. For example, if this group contains {6, 2, 8, 1}, then GetProcessId(2) will return 8 and GetProcessId(3) will return 1.

Definition at line 93 of file vtkProcessGroup.h.

int vtkProcessGroup::GetLocalProcessId ( )

Get the process id for the local process (as defined by the group's communicator). Returns -1 if the local process is not in the group.

int vtkProcessGroup::FindProcessId ( int  processId)

Given a process id in the communicator, this method returns its location in the group or -1 if it is not in the group. For example, if this group contains {6, 2, 8, 1}, then FindProcessId(2) will return 1 and FindProcessId(3) will return -1.

int vtkProcessGroup::AddProcessId ( int  processId)

Add a process id to the end of the group (if it is not already in the group). Returns the location where the id was stored.

int vtkProcessGroup::RemoveProcessId ( int  processId)

Remove the given process id from the group (assuming it is in the group). All ids to the "right" of the removed id are shifted over. Returns 1 if the process id was removed, 0 if the process id was not in the group in the first place.

void vtkProcessGroup::RemoveAllProcessIds ( )

Removes all the processes ids from the group, leaving the group empty.

void vtkProcessGroup::Copy ( vtkProcessGroup group)

Copies the given group's communicator and process ids.

Member Data Documentation

int* vtkProcessGroup::ProcessIds
protected

Definition at line 126 of file vtkProcessGroup.h.

int vtkProcessGroup::NumberOfProcessIds
protected

Definition at line 127 of file vtkProcessGroup.h.

vtkCommunicator* vtkProcessGroup::Communicator
protected

Definition at line 129 of file vtkProcessGroup.h.


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