VTK  9.1.0
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 Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkProcessGroupNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void SetCommunicator (vtkCommunicator *communicator)
 Set the communicator.
 
int GetProcessId (int pos)
 Given a position in the group, returns the id of the process in the communicator this group is based on.
 
int GetLocalProcessId ()
 Get the process id for the local process (as defined by the group's communicator).
 
int 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.
 
int AddProcessId (int processId)
 Add a process id to the end of the group (if it is not already in the group).
 
int RemoveProcessId (int processId)
 Remove the given process id from the group (assuming it is in the group).
 
void RemoveAllProcessIds ()
 Removes all the processes ids from the group, leaving the group empty.
 
void Copy (vtkProcessGroup *group)
 Copies the given group's communicator and process ids.
 
void Initialize (vtkMultiProcessController *controller)
 Initialize the group to the given controller or communicator.
 
void Initialize (vtkCommunicator *communicator)
 Initialize the group to the given controller or communicator.
 
virtual vtkCommunicatorGetCommunicator ()
 Get the communicator on which this group is based on.
 
virtual int GetNumberOfProcessIds ()
 Returns the size of this group (the number of processes defined in it).
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on.
 
virtual void DebugOff ()
 Turn debugging output off.
 
bool GetDebug ()
 Get the value of the debug flag.
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag.
 
virtual void Modified ()
 Update the modification time for this object.
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method.
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
virtual void Delete ()
 Delete a VTK object.
 
virtual void FastDelete ()
 Delete a reference to this object.
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream.
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object).
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object).
 
int GetReferenceCount ()
 Return the current reference count of this object.
 
void SetReferenceCount (int)
 Sets the reference count.
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space.
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkProcessGroupSafeDownCast (vtkObjectBase *o)
 
static vtkProcessGroupNew ()
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class.
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkProcessGroup ()
 
 ~vtkProcessGroup () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events.
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events.
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

int * ProcessIds
 
int NumberOfProcessIds
 
vtkCommunicatorCommunicator
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

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 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.

Definition at line 54 of file vtkProcessGroup.h.

Member Typedef Documentation

◆ Superclass

Definition at line 57 of file vtkProcessGroup.h.

Constructor & Destructor Documentation

◆ vtkProcessGroup()

vtkProcessGroup::vtkProcessGroup ( )
protected

◆ ~vtkProcessGroup()

vtkProcessGroup::~vtkProcessGroup ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkProcessGroup::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool 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 vtkObjectBase.

◆ SafeDownCast()

static vtkProcessGroup * vtkProcessGroup::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkProcessGroup::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkProcessGroup * vtkProcessGroup::NewInstance ( ) const

◆ New()

static vtkProcessGroup * vtkProcessGroup::New ( )
static

◆ PrintSelf()

void vtkProcessGroup::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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.

◆ Initialize() [1/2]

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.

◆ Initialize() [2/2]

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.

◆ GetCommunicator()

virtual vtkCommunicator * vtkProcessGroup::GetCommunicator ( )
virtual

Get the communicator on which this group is based on.

◆ SetCommunicator()

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.

◆ GetNumberOfProcessIds()

virtual int vtkProcessGroup::GetNumberOfProcessIds ( )
virtual

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

◆ GetProcessId()

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 100 of file vtkProcessGroup.h.

◆ GetLocalProcessId()

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.

◆ FindProcessId()

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.

◆ AddProcessId()

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.

◆ RemoveProcessId()

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.

◆ RemoveAllProcessIds()

void vtkProcessGroup::RemoveAllProcessIds ( )

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

◆ Copy()

void vtkProcessGroup::Copy ( vtkProcessGroup group)

Copies the given group's communicator and process ids.

Member Data Documentation

◆ ProcessIds

int* vtkProcessGroup::ProcessIds
protected

Definition at line 144 of file vtkProcessGroup.h.

◆ NumberOfProcessIds

int vtkProcessGroup::NumberOfProcessIds
protected

Definition at line 145 of file vtkProcessGroup.h.

◆ Communicator

vtkCommunicator* vtkProcessGroup::Communicator
protected

Definition at line 147 of file vtkProcessGroup.h.


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