ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkProcessGroup Class Reference
Inheritance diagram for Kitware.VTK.vtkProcessGroup:
[legend]
Collaboration diagram for Kitware.VTK.vtkProcessGroup:
[legend]

List of all members.

Public Member Functions

 vtkProcessGroup (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkProcessGroup ()
 Undocumented Block.
int 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.
void Copy (vtkProcessGroup group)
 Copies the given group's communicator and process ids.
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. For example, if this group contains {6, 2, 8, 1}, then FindProcessId(2) will return 1 and FindProcessId(3) will return -1.
virtual vtkCommunicator GetCommunicator ()
 Get the communicator on which this group is based on.
int 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.
virtual int GetNumberOfProcessIds ()
 Returns the size of this group (the number of processes defined in it).
int GetProcessId (int pos)
 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.
void 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 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.
override int IsA (string type)
 Undocumented Block.
new vtkProcessGroup NewInstance ()
 Undocumented Block.
void RemoveAllProcessIds ()
 Removes all the processes ids from the group, leaving the group empty.
int 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 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.

Static Public Member Functions

static new vtkProcessGroup New ()
 Undocumented Block.
static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkProcessGroup SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkProcessGroup"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "15vtkProcessGroup"
 Automatically generated type registration mechanics.

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Private Member Functions

static internal IntPtr vtkProcessGroup_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkProcessGroup_AddProcessId_01 (HandleRef pThis, int processId)
static internal void vtkProcessGroup_Copy_02 (HandleRef pThis, HandleRef group)
static internal int vtkProcessGroup_FindProcessId_03 (HandleRef pThis, int processId)
static internal IntPtr vtkProcessGroup_GetCommunicator_04 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkProcessGroup_GetLocalProcessId_05 (HandleRef pThis)
static internal int vtkProcessGroup_GetNumberOfProcessIds_06 (HandleRef pThis)
static internal int vtkProcessGroup_GetProcessId_07 (HandleRef pThis, int pos)
static internal void vtkProcessGroup_Initialize_08 (HandleRef pThis, HandleRef controller)
static internal void vtkProcessGroup_Initialize_09 (HandleRef pThis, HandleRef communicator)
static internal int vtkProcessGroup_IsA_10 (HandleRef pThis, string type)
static internal int vtkProcessGroup_IsTypeOf_11 (string type)
static internal IntPtr vtkProcessGroup_NewInstance_13 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkProcessGroup_RemoveAllProcessIds_14 (HandleRef pThis)
static internal int vtkProcessGroup_RemoveProcessId_15 (HandleRef pThis, int processId)
static internal IntPtr vtkProcessGroup_SafeDownCast_16 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkProcessGroup_SetCommunicator_17 (HandleRef pThis, HandleRef communicator)

Static Private Member Functions

static vtkProcessGroup ()
 Automatically generated type registration mechanics.

Detailed Description

-*- c++ -*-


Constructor & Destructor Documentation

static Kitware.VTK.vtkProcessGroup.vtkProcessGroup ( ) [static, private]

Automatically generated type registration mechanics.

Kitware.VTK.vtkProcessGroup.vtkProcessGroup ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.

Undocumented Block.


Member Function Documentation

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.

Copies the given group's communicator and process ids.

override void Kitware.VTK.vtkProcessGroup.Dispose ( bool  disposing) [protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkObject.

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.

Get the communicator on which this group is based on.

Here is the call graph for this function:

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.

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

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.

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

override int Kitware.VTK.vtkProcessGroup.IsA ( string  type) [virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

static new int Kitware.VTK.vtkProcessGroup.IsTypeOf ( string  type) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

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

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.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Here is the call graph for this function:

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.

static internal int Kitware.VTK.vtkProcessGroup.vtkProcessGroup_AddProcessId_01 ( HandleRef  pThis,
int  processId 
) [private]
static internal void Kitware.VTK.vtkProcessGroup.vtkProcessGroup_Copy_02 ( HandleRef  pThis,
HandleRef  group 
) [private]
static internal int Kitware.VTK.vtkProcessGroup.vtkProcessGroup_FindProcessId_03 ( HandleRef  pThis,
int  processId 
) [private]
static internal IntPtr Kitware.VTK.vtkProcessGroup.vtkProcessGroup_GetCommunicator_04 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkProcessGroup.vtkProcessGroup_GetLocalProcessId_05 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkProcessGroup.vtkProcessGroup_GetNumberOfProcessIds_06 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkProcessGroup.vtkProcessGroup_GetProcessId_07 ( HandleRef  pThis,
int  pos 
) [private]
static internal void Kitware.VTK.vtkProcessGroup.vtkProcessGroup_Initialize_08 ( HandleRef  pThis,
HandleRef  controller 
) [private]
static internal void Kitware.VTK.vtkProcessGroup.vtkProcessGroup_Initialize_09 ( HandleRef  pThis,
HandleRef  communicator 
) [private]
static internal int Kitware.VTK.vtkProcessGroup.vtkProcessGroup_IsA_10 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkProcessGroup.vtkProcessGroup_IsTypeOf_11 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkProcessGroup.vtkProcessGroup_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkProcessGroup.vtkProcessGroup_NewInstance_13 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkProcessGroup.vtkProcessGroup_RemoveAllProcessIds_14 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkProcessGroup.vtkProcessGroup_RemoveProcessId_15 ( HandleRef  pThis,
int  processId 
) [private]
static internal IntPtr Kitware.VTK.vtkProcessGroup.vtkProcessGroup_SafeDownCast_16 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkProcessGroup.vtkProcessGroup_SetCommunicator_17 ( HandleRef  pThis,
HandleRef  communicator 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkProcessGroup.MRClassNameKey = "15vtkProcessGroup" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.

new const string Kitware.VTK.vtkProcessGroup.MRFullTypeName = "Kitware.VTK.vtkProcessGroup"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.


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