ActiViz .NET  5.8.0
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Static Private Member Functions | List of all members
Kitware.VTK.vtkCommunicator Class Reference

vtkCommunicator - Used to send/receive messages in a multiprocess environment. More...

Inheritance diagram for Kitware.VTK.vtkCommunicator:
[legend]
Collaboration diagram for Kitware.VTK.vtkCommunicator:
[legend]

Public Types

enum  StandardOperations {
  BITWISE_AND_OP = 5, BITWISE_OR_OP = 7, BITWISE_XOR_OP = 9, LOGICAL_AND_OP = 4,
  LOGICAL_OR_OP = 6, LOGICAL_XOR_OP = 8, MAX_OP = 0, MIN_OP = 1,
  PRODUCT_OP = 3, SUM_OP = 2
}
 Tells you which process [0, NumProcess) you are in. More...
enum  Tags {
  BARRIER_TAG = 16, BROADCAST_TAG = 10, GATHERV_TAG = 12, GATHER_TAG = 11,
  REDUCE_TAG = 15, SCATTERV_TAG = 14, SCATTER_TAG = 13
}
 Tells you which process [0, NumProcess) you are in. More...

Public Member Functions

 vtkCommunicator (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
int AllGather (IntPtr sendBuffer, IntPtr recvBuffer, long length)
 Same as gather except that the result ends up on all processes.
int AllGather (string sendBuffer, string recvBuffer, long length)
 Same as gather except that the result ends up on all processes.
int AllGather (vtkDataArray sendBuffer, vtkDataArray recvBuffer)
 Same as gather except that the result ends up on all processes.
int AllGatherV (IntPtr sendBuffer, IntPtr recvBuffer, long sendLength, IntPtr recvLengths, IntPtr offsets)
 Same as GatherV except that the result is placed in all processes.
int AllGatherV (string sendBuffer, string recvBuffer, long sendLength, IntPtr recvLengths, IntPtr offsets)
 Same as GatherV except that the result is placed in all processes.
int AllGatherV (vtkDataArray sendBuffer, vtkDataArray recvBuffer, IntPtr recvLengths, IntPtr offsets)
 Same as GatherV except that the result is placed in all processes.
int AllGatherV (vtkDataArray sendBuffer, vtkDataArray recvBuffer)
 Same as GatherV except that the result is placed in all processes.
virtual int AllGatherVVoidArray (IntPtr sendBuffer, IntPtr recvBuffer, long sendLength, IntPtr recvLengths, IntPtr offsets, int type)
 Subclasses should reimplement these if they have a more efficient implementation.
virtual int AllGatherVoidArray (IntPtr sendBuffer, IntPtr recvBuffer, long length, int type)
 Subclasses should reimplement these if they have a more efficient implementation.
int AllReduce (IntPtr sendBuffer, IntPtr recvBuffer, long length, int operation)
 Same as Reduce except that the result is placed in all of the processes.
int AllReduce (string sendBuffer, string recvBuffer, long length, int operation)
 Same as Reduce except that the result is placed in all of the processes.
int AllReduce (vtkDataArray sendBuffer, vtkDataArray recvBuffer, int operation)
 Same as Reduce except that the result is placed in all of the processes.
virtual int AllReduceVoidArray (IntPtr sendBuffer, IntPtr recvBuffer, long length, int type, int operation)
 Subclasses should reimplement these if they have a more efficient implementation.
virtual void Barrier ()
 Will block the processes until all other processes reach the Barrier function.
int Broadcast (IntPtr data, long length, int srcProcessId)
 Broadcast sends the array in the process with id srcProcessId to all of the other processes. All processes must call these method with the same arguments in order for it to complete.
int Broadcast (string data, long length, int srcProcessId)
 Broadcast sends the array in the process with id srcProcessId to all of the other processes. All processes must call these method with the same arguments in order for it to complete.
int Broadcast (vtkDataObject data, int srcProcessId)
 Broadcast sends the array in the process with id srcProcessId to all of the other processes. All processes must call these method with the same arguments in order for it to complete.
int Broadcast (vtkDataArray data, int srcProcessId)
 Broadcast sends the array in the process with id srcProcessId to all of the other processes. All processes must call these method with the same arguments in order for it to complete.
virtual int BroadcastVoidArray (IntPtr data, long length, int type, int srcProcessId)
 Subclasses should reimplement these if they have a more efficient implementation.
int Gather (IntPtr sendBuffer, IntPtr recvBuffer, long length, int destProcessId)
 Gather collects arrays in the process with id destProcessId. Each process (including the destination) sends the contents of its send buffer to the destination process. The destination process receives the messages and stores them in rank order. The length argument (which must be the same on all processes) is the length of the sendBuffers. The recvBuffer (on te destination process) must be of length length*numProcesses. Gather is the inverse operation of Scatter.
int Gather (string sendBuffer, string recvBuffer, long length, int destProcessId)
 Gather collects arrays in the process with id destProcessId. Each process (including the destination) sends the contents of its send buffer to the destination process. The destination process receives the messages and stores them in rank order. The length argument (which must be the same on all processes) is the length of the sendBuffers. The recvBuffer (on te destination process) must be of length length*numProcesses. Gather is the inverse operation of Scatter.
int Gather (vtkDataArray sendBuffer, vtkDataArray recvBuffer, int destProcessId)
 Gather collects arrays in the process with id destProcessId. Each process (including the destination) sends the contents of its send buffer to the destination process. The destination process receives the messages and stores them in rank order. The length argument (which must be the same on all processes) is the length of the sendBuffers. The recvBuffer (on te destination process) must be of length length*numProcesses. Gather is the inverse operation of Scatter.
int GatherV (IntPtr sendBuffer, IntPtr recvBuffer, long sendLength, IntPtr recvLengths, IntPtr offsets, int destProcessId)
 GatherV is the vector variant of Gather. It extends the functionality of Gather by allowing a varying count of data from each process. GatherV collects arrays in the process with id destProcessId. Each process (including the destination) sends the contents of its send buffer to the destination process. The destination process receives the messages and stores them in rank order. The sendLength argument defines how much the local process sends to destProcessId and recvLengths is an array containing the amount destProcessId receives from each process, in rank order.
int GatherV (string sendBuffer, string recvBuffer, long sendLength, IntPtr recvLengths, IntPtr offsets, int destProcessId)
 GatherV is the vector variant of Gather. It extends the functionality of Gather by allowing a varying count of data from each process. GatherV collects arrays in the process with id destProcessId. Each process (including the destination) sends the contents of its send buffer to the destination process. The destination process receives the messages and stores them in rank order. The sendLength argument defines how much the local process sends to destProcessId and recvLengths is an array containing the amount destProcessId receives from each process, in rank order.
int GatherV (vtkDataArray sendBuffer, vtkDataArray recvBuffer, IntPtr recvLengths, IntPtr offsets, int destProcessId)
 GatherV is the vector variant of Gather. It extends the functionality of Gather by allowing a varying count of data from each process. GatherV collects arrays in the process with id destProcessId. Each process (including the destination) sends the contents of its send buffer to the destination process. The destination process receives the messages and stores them in rank order. The sendLength argument defines how much the local process sends to destProcessId and recvLengths is an array containing the amount destProcessId receives from each process, in rank order.
int GatherV (vtkDataArray sendBuffer, vtkDataArray recvBuffer, int destProcessId)
 GatherV is the vector variant of Gather. It extends the functionality of Gather by allowing a varying count of data from each process. GatherV collects arrays in the process with id destProcessId. Each process (including the destination) sends the contents of its send buffer to the destination process. The destination process receives the messages and stores them in rank order. The sendLength argument defines how much the local process sends to destProcessId and recvLengths is an array containing the amount destProcessId receives from each process, in rank order.
virtual int GatherVVoidArray (IntPtr sendBuffer, IntPtr recvBuffer, long sendLength, IntPtr recvLengths, IntPtr offsets, int type, int destProcessId)
 Subclasses should reimplement these if they have a more efficient implementation.
virtual int GatherVoidArray (IntPtr sendBuffer, IntPtr recvBuffer, long length, int type, int destProcessId)
 Subclasses should reimplement these if they have a more efficient implementation.
virtual long GetCount ()
 Returns the number of words received by the most recent Receive(). Note that this is not the number of bytes received, but the number of items of the data-type received by the most recent Receive() eg. if Receive(int*,..) was used, then this returns the number of ints received; if Receive(double*,..) was used, then this returns the number of doubles received etc. The return value is valid only after a successful Receive().
virtual int GetLocalProcessId ()
 Tells you which process [0, NumProcess) you are in.
virtual int GetNumberOfProcesses ()
 Set the number of processes you will be using. This defaults to the maximum number available. If you set this to a value higher than the default, you will get an error.
override int IsA (string type)
 Undocumented Block
new vtkCommunicator NewInstance ()
 Undocumented Block
int Receive (vtkDataObject data, int remoteHandle, int tag)
 This method receives a data object from a corresponding send. It blocks until the receive is finished.
int Receive (vtkDataArray data, int remoteHandle, int tag)
 This method receives a data array from a corresponding send. It blocks until the receive is finished.
int Receive (IntPtr data, long maxlength, int remoteHandle, int tag)
 Convenience methods for receiving data arrays.
int Receive (string data, long maxlength, int remoteHandle, int tag)
 Convenience methods for receiving data arrays.
vtkDataObject ReceiveDataObject (int remoteHandle, int tag)
 The caller does not have to know the data type before this call is made. It returns the newly created object.
virtual int ReceiveVoidArray (IntPtr data, long maxlength, int type, int remoteHandle, int tag)
 Subclasses have to supply this method to receive various arrays of data. The type arg is one of the VTK type constants recognized by the vtkTemplateMacro (VTK_FLOAT, VTK_INT, etc.). maxlength is measured in number of values (as opposed to number of bytes) and is the maxmum length of the data to receive. If the maxlength is less than the length of the message sent by the sender, an error will be flagged. Once a message is received, use the GetCount() method to determine the actual size of the data received.
int Reduce (IntPtr sendBuffer, IntPtr recvBuffer, long length, int operation, int destProcessId)
 Reduce an array to the given destination process. This version of Reduce takes an identifier defined in the vtkCommunicator::StandardOperations enum to define the operation.
int Reduce (string sendBuffer, string recvBuffer, long length, int operation, int destProcessId)
 Reduce an array to the given destination process. This version of Reduce takes an identifier defined in the vtkCommunicator::StandardOperations enum to define the operation.
int Reduce (vtkDataArray sendBuffer, vtkDataArray recvBuffer, int operation, int destProcessId)
 Reduce an array to the given destination process. This version of Reduce takes an identifier defined in the vtkCommunicator::StandardOperations enum to define the operation.
virtual int ReduceVoidArray (IntPtr sendBuffer, IntPtr recvBuffer, long length, int type, int operation, int destProcessId)
 Subclasses should reimplement these if they have a more efficient implementation.
int Scatter (IntPtr sendBuffer, IntPtr recvBuffer, long length, int srcProcessId)
 Scatter takes an array in the process with id srcProcessId and distributes it. Each process (including the source) receives a portion of the send buffer. Process 0 receives the first length values, process 1 receives the second length values, and so on. Scatter is the inverse operation of Gather.
int Scatter (string sendBuffer, string recvBuffer, long length, int srcProcessId)
 Scatter takes an array in the process with id srcProcessId and distributes it. Each process (including the source) receives a portion of the send buffer. Process 0 receives the first length values, process 1 receives the second length values, and so on. Scatter is the inverse operation of Gather.
int Scatter (vtkDataArray sendBuffer, vtkDataArray recvBuffer, int srcProcessId)
 Scatter takes an array in the process with id srcProcessId and distributes it. Each process (including the source) receives a portion of the send buffer. Process 0 receives the first length values, process 1 receives the second length values, and so on. Scatter is the inverse operation of Gather.
int ScatterV (IntPtr sendBuffer, IntPtr recvBuffer, IntPtr sendLengths, IntPtr offsets, long recvLength, int srcProcessId)
 ScatterV is the vector variant of Scatter. It extends the functionality of Scatter by allowing a varying count of data to each process. ScatterV takes an array in the process with id srcProcessId and distributes it. Each process (including the source) receives a portion of the send buffer defined by the sendLengths and offsets arrays.
int ScatterV (string sendBuffer, string recvBuffer, IntPtr sendLengths, IntPtr offsets, long recvLength, int srcProcessId)
 ScatterV is the vector variant of Scatter. It extends the functionality of Scatter by allowing a varying count of data to each process. ScatterV takes an array in the process with id srcProcessId and distributes it. Each process (including the source) receives a portion of the send buffer defined by the sendLengths and offsets arrays.
virtual int ScatterVVoidArray (IntPtr sendBuffer, IntPtr recvBuffer, IntPtr sendLengths, IntPtr offsets, long recvLength, int type, int srcProcessId)
 Subclasses should reimplement these if they have a more efficient implementation.
virtual int ScatterVoidArray (IntPtr sendBuffer, IntPtr recvBuffer, long length, int type, int srcProcessId)
 Subclasses should reimplement these if they have a more efficient implementation.
int Send (vtkDataObject data, int remoteHandle, int tag)
 This method sends a data object to a destination. Tag eliminates ambiguity and is used to match sends to receives.
int Send (vtkDataArray data, int remoteHandle, int tag)
 This method sends a data array to a destination. Tag eliminates ambiguity and is used to match sends to receives.
int Send (IntPtr data, long length, int remoteHandle, int tag)
 Convenience methods for sending data arrays.
int Send (string data, long length, int remoteHandle, int tag)
 Convenience methods for sending data arrays.
virtual int SendVoidArray (IntPtr data, long length, int type, int remoteHandle, int tag)
 Subclasses have to supply this method to send various arrays of data. The type arg is one of the VTK type constants recognized by the vtkTemplateMacro (VTK_FLOAT, VTK_INT, etc.). length is measured in number of values (as opposed to number of bytes).
virtual void SetNumberOfProcesses (int num)
 Set the number of processes you will be using. This defaults to the maximum number available. If you set this to a value higher than the default, you will get an error.
- Public Member Functions inherited from Kitware.VTK.vtkObject
 vtkObject (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkObject ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
uint AddObserver (uint arg0, vtkCommand arg1, float priority)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
uint AddObserver (string arg0, vtkCommand arg1, float priority)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void DebugOff ()
 Turn debugging output off.
virtual void DebugOn ()
 Turn debugging output on.
vtkCommand GetCommand (uint tag)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
byte GetDebug ()
 Get the value of the debug flag.
virtual uint GetMTime ()
 Return this object's modified time.
int HasObserver (uint arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (string arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (uint arg0, IntPtr callData)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (string arg0, IntPtr callData)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void Modified ()
 Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. The modification time is a unique monotonically increasing unsigned long integer.
void RemoveAllObservers ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObserver (vtkCommand arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObserver (uint tag)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (uint arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (string arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void SetDebug (byte debugFlag)
 Set the value of the debug flag. A non-zero value turns debugging on.
override string ToString ()
 Returns the result of calling vtkObject::Print as a C# string.
delegate void vtkObjectEventHandler (vtkObject sender, vtkObjectEventArgs e)
 Generic signature for all vtkObject events.
void RemoveAllHandlersForAllEvents ()
 Call RemoveAllHandlers on each non-null vtkObjectEventRelay. TODO: This method needs to get called by the generated Dispose. Make that happen...
- Public Member Functions inherited from Kitware.VTK.vtkObjectBase
 vtkObjectBase (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkObjectBase ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
virtual void Register (vtkObjectBase o)
 Increase the reference count (mark as used by another object).
virtual void FastDelete ()
 Delete a reference to this object. This version will not invoke garbage collection and can potentially leak the object if it is part of a reference loop. Use this method only when it is known that the object has another reference and would not be collected if a full garbage collection check were done.
string GetClassName ()
 Return the class name as a string. This method is defined in all subclasses of vtkObjectBase with the vtkTypeMacro found in vtkSetGet.h.
int GetReferenceCount ()
 Return the current reference count of this object.
void SetReferenceCount (int arg0)
 Sets the reference count. (This is very dangerous, use with care.)

Static Public Member Functions

static int GetLeftChildProcessor (int pid)
 Some helper functions when dealing with heap tree - based algorthims - we don't need a function for getting the right processor since it is 1 + theLeftProcessor
static int GetParentProcessor (int pid)
 Some helper functions when dealing with heap tree - based algorthims - we don't need a function for getting the right processor since it is 1 + theLeftProcessor
static new int IsTypeOf (string type)
 Undocumented Block
static int MarshalDataObject (vtkDataObject arg0, vtkCharArray buffer)
 Convert a data object into a string that can be transmitted and vice versa. Returns 1 for success and 0 for failure. WARNING: This will only work for types that have a vtkDataWriter class.
static new vtkCommunicator SafeDownCast (vtkObjectBase o)
 Undocumented Block
static void SetUseCopy (int useCopy)
 Subclasses should reimplement these if they have a more efficient implementation.
static int UnMarshalDataObject (vtkCharArray buffer, vtkDataObject arg1)
 Convert a data object into a string that can be transmitted and vice versa. Returns 1 for success and 0 for failure. WARNING: This will only work for types that have a vtkDataWriter class.
- Static Public Member Functions inherited from Kitware.VTK.vtkObject
static new vtkObject New ()
 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. It allows the debugger to break on error.
static int GetGlobalWarningDisplay ()
 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 void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkCommunicator"
 Automatically generated type registration mechanics.
- Public Attributes inherited from Kitware.VTK.vtkObject
new const string MRFullTypeName = "Kitware.VTK.vtkObject"
 Automatically generated type registration mechanics.
- Public Attributes inherited from Kitware.VTK.vtkObjectBase
new const string MRFullTypeName = "Kitware.VTK.vtkObjectBase"
 Automatically generated type registration mechanics.
- Public Attributes inherited from Kitware.VTK.WrappedObject
const string vtkChartsEL_dll = "libKitware.VTK.vtkCharts.Unmanaged.so"
 Export layer functions for 'vtkCharts' are exported from the DLL named by the value of this variable.
const string vtkCommonEL_dll = "libKitware.VTK.vtkCommon.Unmanaged.so"
 Export layer functions for 'vtkCommon' are exported from the DLL named by the value of this variable.
const string vtkFilteringEL_dll = "libKitware.VTK.vtkFiltering.Unmanaged.so"
 Export layer functions for 'vtkFiltering' are exported from the DLL named by the value of this variable.
const string vtkGenericFilteringEL_dll = "libKitware.VTK.vtkGenericFiltering.Unmanaged.so"
 Export layer functions for 'vtkGenericFiltering' are exported from the DLL named by the value of this variable.
const string vtkGeovisEL_dll = "libKitware.VTK.vtkGeovis.Unmanaged.so"
 Export layer functions for 'vtkGeovis' are exported from the DLL named by the value of this variable.
const string vtkGraphicsEL_dll = "libKitware.VTK.vtkGraphics.Unmanaged.so"
 Export layer functions for 'vtkGraphics' are exported from the DLL named by the value of this variable.
const string vtkHybridEL_dll = "libKitware.VTK.vtkHybrid.Unmanaged.so"
 Export layer functions for 'vtkHybrid' are exported from the DLL named by the value of this variable.
const string vtkIOEL_dll = "libKitware.VTK.vtkIO.Unmanaged.so"
 Export layer functions for 'vtkIO' are exported from the DLL named by the value of this variable.
const string vtkImagingEL_dll = "libKitware.VTK.vtkImaging.Unmanaged.so"
 Export layer functions for 'vtkImaging' are exported from the DLL named by the value of this variable.
const string vtkInfovisEL_dll = "libKitware.VTK.vtkInfovis.Unmanaged.so"
 Export layer functions for 'vtkInfovis' are exported from the DLL named by the value of this variable.
const string vtkParallelEL_dll = "libKitware.VTK.vtkParallel.Unmanaged.so"
 Export layer functions for 'vtkParallel' are exported from the DLL named by the value of this variable.
const string vtkRenderingEL_dll = "libKitware.VTK.vtkRendering.Unmanaged.so"
 Export layer functions for 'vtkRendering' are exported from the DLL named by the value of this variable.
const string vtkViewsEL_dll = "libKitware.VTK.vtkViews.Unmanaged.so"
 Export layer functions for 'vtkViews' are exported from the DLL named by the value of this variable.
const string vtkVolumeRenderingEL_dll = "libKitware.VTK.vtkVolumeRendering.Unmanaged.so"
 Export layer functions for 'vtkVolumeRendering' are exported from the DLL named by the value of this variable.
const string vtkWidgetsEL_dll = "libKitware.VTK.vtkWidgets.Unmanaged.so"
 Export layer functions for 'vtkWidgets' are exported from the DLL named by the value of this variable.

Static Public Attributes

static new readonly string MRClassNameKey = "15vtkCommunicator"
 Automatically generated type registration mechanics.
- Static Public Attributes inherited from Kitware.VTK.vtkObject
static new readonly string MRClassNameKey = "9vtkObject"
 Automatically generated type registration mechanics.
- Static Public Attributes inherited from Kitware.VTK.vtkObjectBase
static new readonly string MRClassNameKey = "13vtkObjectBase"
 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.

Static Private Member Functions

static vtkCommunicator ()
 Automatically generated type registration mechanics.

Additional Inherited Members

- Properties inherited from Kitware.VTK.vtkObject
Kitware.VTK.vtkObject.vtkObjectEventHandler AbortCheckEvt
 The AbortCheckEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.AbortCheckEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler AnimationCueTickEvt
 The AnimationCueTickEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.AnimationCueTickEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler AnyEvt
 The AnyEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.AnyEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler CharEvt
 The CharEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.CharEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler ConfigureEvt
 The ConfigureEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.ConfigureEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler ConnectionClosedEvt
 The ConnectionClosedEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.ConnectionClosedEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler ConnectionCreatedEvt
 The ConnectionCreatedEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.ConnectionCreatedEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler CreateTimerEvt
 The CreateTimerEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.CreateTimerEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler CursorChangedEvt
 The CursorChangedEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.CursorChangedEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler DeleteEvt
 The DeleteEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.DeleteEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler DestroyTimerEvt
 The DestroyTimerEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.DestroyTimerEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler DisableEvt
 The DisableEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.DisableEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler DomainModifiedEvt
 The DomainModifiedEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.DomainModifiedEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler EnableEvt
 The EnableEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.EnableEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler EndAnimationCueEvt
 The EndAnimationCueEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.EndAnimationCueEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler EndEvt
 The EndEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.EndEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler EndInteractionEvt
 The EndInteractionEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.EndInteractionEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler EndPickEvt
 The EndPickEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.EndPickEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler EndWindowLevelEvt
 The EndWindowLevelEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.EndWindowLevelEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler EnterEvt
 The EnterEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.EnterEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler ErrorEvt
 The ErrorEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.ErrorEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler ExecuteInformationEvt
 The ExecuteInformationEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.ExecuteInformationEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler ExitEvt
 The ExitEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.ExitEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler ExposeEvt
 The ExposeEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.ExposeEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler InteractionEvt
 The InteractionEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.InteractionEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler KeyPressEvt
 The KeyPressEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.KeyPressEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler KeyReleaseEvt
 The KeyReleaseEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.KeyReleaseEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler LeaveEvt
 The LeaveEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.LeaveEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler LeftButtonPressEvt
 The LeftButtonPressEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.LeftButtonPressEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler LeftButtonReleaseEvt
 The LeftButtonReleaseEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.LeftButtonReleaseEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler MiddleButtonPressEvt
 The MiddleButtonPressEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.MiddleButtonPressEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler MiddleButtonReleaseEvt
 The MiddleButtonReleaseEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.MiddleButtonReleaseEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler ModifiedEvt
 The ModifiedEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.ModifiedEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler MouseMoveEvt
 The MouseMoveEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.MouseMoveEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler MouseWheelBackwardEvt
 The MouseWheelBackwardEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.MouseWheelBackwardEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler MouseWheelForwardEvt
 The MouseWheelForwardEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.MouseWheelForwardEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler PickEvt
 The PickEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.PickEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler PlacePointEvt
 The PlacePointEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.PlacePointEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler PlaceWidgetEvt
 The PlaceWidgetEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.PlaceWidgetEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler ProgressEvt
 The ProgressEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.ProgressEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler PropertyModifiedEvt
 The PropertyModifiedEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.PropertyModifiedEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler RegisterEvt
 The RegisterEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.RegisterEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler RenderEvt
 The RenderEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.RenderEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler RenderWindowMessageEvt
 The RenderWindowMessageEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.RenderWindowMessageEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler ResetCameraClippingRangeEvt
 The ResetCameraClippingRangeEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.ResetCameraClippingRangeEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler ResetCameraEvt
 The ResetCameraEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.ResetCameraEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler ResetWindowLevelEvt
 The ResetWindowLevelEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.ResetWindowLevelEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler RightButtonPressEvt
 The RightButtonPressEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.RightButtonPressEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler RightButtonReleaseEvt
 The RightButtonReleaseEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.RightButtonReleaseEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler SelectionChangedEvt
 The SelectionChangedEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.SelectionChangedEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler SetOutputEvt
 The SetOutputEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.SetOutputEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler StartAnimationCueEvt
 The StartAnimationCueEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.StartAnimationCueEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler StartEvt
 The StartEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.StartEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler StartInteractionEvt
 The StartInteractionEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.StartInteractionEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler StartPickEvt
 The StartPickEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.StartPickEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler StartWindowLevelEvt
 The StartWindowLevelEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.StartWindowLevelEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler TimerEvt
 The TimerEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.TimerEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler UnRegisterEvt
 The UnRegisterEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.UnRegisterEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler UpdateEvt
 The UpdateEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.UpdateEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler UpdateInformationEvt
 The UpdateInformationEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.UpdateInformationEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler UpdatePropertyEvt
 The UpdatePropertyEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.UpdatePropertyEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler VolumeMapperComputeGradientsEndEvt
 The VolumeMapperComputeGradientsEndEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.VolumeMapperComputeGradientsEndEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler VolumeMapperComputeGradientsProgressEvt
 The VolumeMapperComputeGradientsProgressEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.VolumeMapperComputeGradientsProgressEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler VolumeMapperComputeGradientsStartEvt
 The VolumeMapperComputeGradientsStartEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.VolumeMapperComputeGradientsStartEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler VolumeMapperRenderEndEvt
 The VolumeMapperRenderEndEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.VolumeMapperRenderEndEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler VolumeMapperRenderProgressEvt
 The VolumeMapperRenderProgressEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.VolumeMapperRenderProgressEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler VolumeMapperRenderStartEvt
 The VolumeMapperRenderStartEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.VolumeMapperRenderStartEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler WarningEvt
 The WarningEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.WarningEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler WidgetActivateEvt
 The WidgetActivateEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.WidgetActivateEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler WidgetModifiedEvt
 The WidgetModifiedEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.WidgetModifiedEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler WidgetValueChangedEvt
 The WidgetValueChangedEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.WidgetValueChangedEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler WindowLevelEvt
 The WindowLevelEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.WindowLevelEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler WrongTagEvt
 The WrongTagEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.WrongTagEvent as the eventId parameter.

Detailed Description

vtkCommunicator - Used to send/receive messages in a multiprocess environment.

Description This is an abstact class which contains functionality for sending and receiving inter-process messages. It contains methods for marshaling an object into a string (currently used by the MPI communicator but not the shared memory communicator).

Member Enumeration Documentation

Tells you which process [0, NumProcess) you are in.

Enumerator:
BITWISE_AND_OP 

enum member

BITWISE_OR_OP 

enum member

BITWISE_XOR_OP 

enum member

LOGICAL_AND_OP 

enum member

LOGICAL_OR_OP 

enum member

LOGICAL_XOR_OP 

enum member

MAX_OP 

enum member

MIN_OP 

enum member

PRODUCT_OP 

enum member

SUM_OP 

enum member

Tells you which process [0, NumProcess) you are in.

Enumerator:
BARRIER_TAG 

enum member

BROADCAST_TAG 

enum member

GATHERV_TAG 

enum member

GATHER_TAG 

enum member

REDUCE_TAG 

enum member

SCATTERV_TAG 

enum member

SCATTER_TAG 

enum member

Constructor & Destructor Documentation

static Kitware.VTK.vtkCommunicator.vtkCommunicator ( )
staticprivate

Automatically generated type registration mechanics.

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

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

Member Function Documentation

int Kitware.VTK.vtkCommunicator.AllGather ( IntPtr  sendBuffer,
IntPtr  recvBuffer,
long  length 
)

Same as gather except that the result ends up on all processes.

int Kitware.VTK.vtkCommunicator.AllGather ( string  sendBuffer,
string  recvBuffer,
long  length 
)

Same as gather except that the result ends up on all processes.

int Kitware.VTK.vtkCommunicator.AllGather ( vtkDataArray  sendBuffer,
vtkDataArray  recvBuffer 
)

Same as gather except that the result ends up on all processes.

int Kitware.VTK.vtkCommunicator.AllGatherV ( IntPtr  sendBuffer,
IntPtr  recvBuffer,
long  sendLength,
IntPtr  recvLengths,
IntPtr  offsets 
)

Same as GatherV except that the result is placed in all processes.

int Kitware.VTK.vtkCommunicator.AllGatherV ( string  sendBuffer,
string  recvBuffer,
long  sendLength,
IntPtr  recvLengths,
IntPtr  offsets 
)

Same as GatherV except that the result is placed in all processes.

int Kitware.VTK.vtkCommunicator.AllGatherV ( vtkDataArray  sendBuffer,
vtkDataArray  recvBuffer,
IntPtr  recvLengths,
IntPtr  offsets 
)

Same as GatherV except that the result is placed in all processes.

int Kitware.VTK.vtkCommunicator.AllGatherV ( vtkDataArray  sendBuffer,
vtkDataArray  recvBuffer 
)

Same as GatherV except that the result is placed in all processes.

virtual int Kitware.VTK.vtkCommunicator.AllGatherVoidArray ( IntPtr  sendBuffer,
IntPtr  recvBuffer,
long  length,
int  type 
)
virtual

Subclasses should reimplement these if they have a more efficient implementation.

Reimplemented in Kitware.VTK.vtkSocketCommunicator.

virtual int Kitware.VTK.vtkCommunicator.AllGatherVVoidArray ( IntPtr  sendBuffer,
IntPtr  recvBuffer,
long  sendLength,
IntPtr  recvLengths,
IntPtr  offsets,
int  type 
)
virtual

Subclasses should reimplement these if they have a more efficient implementation.

Reimplemented in Kitware.VTK.vtkSocketCommunicator.

int Kitware.VTK.vtkCommunicator.AllReduce ( IntPtr  sendBuffer,
IntPtr  recvBuffer,
long  length,
int  operation 
)

Same as Reduce except that the result is placed in all of the processes.

int Kitware.VTK.vtkCommunicator.AllReduce ( string  sendBuffer,
string  recvBuffer,
long  length,
int  operation 
)

Same as Reduce except that the result is placed in all of the processes.

int Kitware.VTK.vtkCommunicator.AllReduce ( vtkDataArray  sendBuffer,
vtkDataArray  recvBuffer,
int  operation 
)

Same as Reduce except that the result is placed in all of the processes.

virtual int Kitware.VTK.vtkCommunicator.AllReduceVoidArray ( IntPtr  sendBuffer,
IntPtr  recvBuffer,
long  length,
int  type,
int  operation 
)
virtual

Subclasses should reimplement these if they have a more efficient implementation.

Reimplemented in Kitware.VTK.vtkSocketCommunicator.

virtual void Kitware.VTK.vtkCommunicator.Barrier ( )
virtual

Will block the processes until all other processes reach the Barrier function.

Reimplemented in Kitware.VTK.vtkSocketCommunicator.

int Kitware.VTK.vtkCommunicator.Broadcast ( IntPtr  data,
long  length,
int  srcProcessId 
)

Broadcast sends the array in the process with id srcProcessId to all of the other processes. All processes must call these method with the same arguments in order for it to complete.

int Kitware.VTK.vtkCommunicator.Broadcast ( string  data,
long  length,
int  srcProcessId 
)

Broadcast sends the array in the process with id srcProcessId to all of the other processes. All processes must call these method with the same arguments in order for it to complete.

int Kitware.VTK.vtkCommunicator.Broadcast ( vtkDataObject  data,
int  srcProcessId 
)

Broadcast sends the array in the process with id srcProcessId to all of the other processes. All processes must call these method with the same arguments in order for it to complete.

int Kitware.VTK.vtkCommunicator.Broadcast ( vtkDataArray  data,
int  srcProcessId 
)

Broadcast sends the array in the process with id srcProcessId to all of the other processes. All processes must call these method with the same arguments in order for it to complete.

virtual int Kitware.VTK.vtkCommunicator.BroadcastVoidArray ( IntPtr  data,
long  length,
int  type,
int  srcProcessId 
)
virtual

Subclasses should reimplement these if they have a more efficient implementation.

Reimplemented in Kitware.VTK.vtkSocketCommunicator.

override void Kitware.VTK.vtkCommunicator.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.

Reimplemented in Kitware.VTK.vtkDummyCommunicator, Kitware.VTK.vtkSocketCommunicator, and Kitware.VTK.vtkSubCommunicator.

int Kitware.VTK.vtkCommunicator.Gather ( IntPtr  sendBuffer,
IntPtr  recvBuffer,
long  length,
int  destProcessId 
)

Gather collects arrays in the process with id destProcessId. Each process (including the destination) sends the contents of its send buffer to the destination process. The destination process receives the messages and stores them in rank order. The length argument (which must be the same on all processes) is the length of the sendBuffers. The recvBuffer (on te destination process) must be of length length*numProcesses. Gather is the inverse operation of Scatter.

int Kitware.VTK.vtkCommunicator.Gather ( string  sendBuffer,
string  recvBuffer,
long  length,
int  destProcessId 
)

Gather collects arrays in the process with id destProcessId. Each process (including the destination) sends the contents of its send buffer to the destination process. The destination process receives the messages and stores them in rank order. The length argument (which must be the same on all processes) is the length of the sendBuffers. The recvBuffer (on te destination process) must be of length length*numProcesses. Gather is the inverse operation of Scatter.

int Kitware.VTK.vtkCommunicator.Gather ( vtkDataArray  sendBuffer,
vtkDataArray  recvBuffer,
int  destProcessId 
)

Gather collects arrays in the process with id destProcessId. Each process (including the destination) sends the contents of its send buffer to the destination process. The destination process receives the messages and stores them in rank order. The length argument (which must be the same on all processes) is the length of the sendBuffers. The recvBuffer (on te destination process) must be of length length*numProcesses. Gather is the inverse operation of Scatter.

int Kitware.VTK.vtkCommunicator.GatherV ( IntPtr  sendBuffer,
IntPtr  recvBuffer,
long  sendLength,
IntPtr  recvLengths,
IntPtr  offsets,
int  destProcessId 
)

GatherV is the vector variant of Gather. It extends the functionality of Gather by allowing a varying count of data from each process. GatherV collects arrays in the process with id destProcessId. Each process (including the destination) sends the contents of its send buffer to the destination process. The destination process receives the messages and stores them in rank order. The sendLength argument defines how much the local process sends to destProcessId and recvLengths is an array containing the amount destProcessId receives from each process, in rank order.

int Kitware.VTK.vtkCommunicator.GatherV ( string  sendBuffer,
string  recvBuffer,
long  sendLength,
IntPtr  recvLengths,
IntPtr  offsets,
int  destProcessId 
)

GatherV is the vector variant of Gather. It extends the functionality of Gather by allowing a varying count of data from each process. GatherV collects arrays in the process with id destProcessId. Each process (including the destination) sends the contents of its send buffer to the destination process. The destination process receives the messages and stores them in rank order. The sendLength argument defines how much the local process sends to destProcessId and recvLengths is an array containing the amount destProcessId receives from each process, in rank order.

int Kitware.VTK.vtkCommunicator.GatherV ( vtkDataArray  sendBuffer,
vtkDataArray  recvBuffer,
IntPtr  recvLengths,
IntPtr  offsets,
int  destProcessId 
)

GatherV is the vector variant of Gather. It extends the functionality of Gather by allowing a varying count of data from each process. GatherV collects arrays in the process with id destProcessId. Each process (including the destination) sends the contents of its send buffer to the destination process. The destination process receives the messages and stores them in rank order. The sendLength argument defines how much the local process sends to destProcessId and recvLengths is an array containing the amount destProcessId receives from each process, in rank order.

int Kitware.VTK.vtkCommunicator.GatherV ( vtkDataArray  sendBuffer,
vtkDataArray  recvBuffer,
int  destProcessId 
)

GatherV is the vector variant of Gather. It extends the functionality of Gather by allowing a varying count of data from each process. GatherV collects arrays in the process with id destProcessId. Each process (including the destination) sends the contents of its send buffer to the destination process. The destination process receives the messages and stores them in rank order. The sendLength argument defines how much the local process sends to destProcessId and recvLengths is an array containing the amount destProcessId receives from each process, in rank order.

virtual int Kitware.VTK.vtkCommunicator.GatherVoidArray ( IntPtr  sendBuffer,
IntPtr  recvBuffer,
long  length,
int  type,
int  destProcessId 
)
virtual

Subclasses should reimplement these if they have a more efficient implementation.

Reimplemented in Kitware.VTK.vtkSocketCommunicator.

virtual int Kitware.VTK.vtkCommunicator.GatherVVoidArray ( IntPtr  sendBuffer,
IntPtr  recvBuffer,
long  sendLength,
IntPtr  recvLengths,
IntPtr  offsets,
int  type,
int  destProcessId 
)
virtual

Subclasses should reimplement these if they have a more efficient implementation.

Reimplemented in Kitware.VTK.vtkSocketCommunicator.

virtual long Kitware.VTK.vtkCommunicator.GetCount ( )
virtual

Returns the number of words received by the most recent Receive(). Note that this is not the number of bytes received, but the number of items of the data-type received by the most recent Receive() eg. if Receive(int*,..) was used, then this returns the number of ints received; if Receive(double*,..) was used, then this returns the number of doubles received etc. The return value is valid only after a successful Receive().

static int Kitware.VTK.vtkCommunicator.GetLeftChildProcessor ( int  pid)
static

Some helper functions when dealing with heap tree - based algorthims - we don't need a function for getting the right processor since it is 1 + theLeftProcessor

virtual int Kitware.VTK.vtkCommunicator.GetLocalProcessId ( )
virtual

Tells you which process [0, NumProcess) you are in.

virtual int Kitware.VTK.vtkCommunicator.GetNumberOfProcesses ( )
virtual

Set the number of processes you will be using. This defaults to the maximum number available. If you set this to a value higher than the default, you will get an error.

static int Kitware.VTK.vtkCommunicator.GetParentProcessor ( int  pid)
static

Some helper functions when dealing with heap tree - based algorthims - we don't need a function for getting the right processor since it is 1 + theLeftProcessor

override int Kitware.VTK.vtkCommunicator.IsA ( string  type)
virtual
static new int Kitware.VTK.vtkCommunicator.IsTypeOf ( string  type)
static
static int Kitware.VTK.vtkCommunicator.MarshalDataObject ( vtkDataObject  arg0,
vtkCharArray  buffer 
)
static

Convert a data object into a string that can be transmitted and vice versa. Returns 1 for success and 0 for failure. WARNING: This will only work for types that have a vtkDataWriter class.

new vtkCommunicator Kitware.VTK.vtkCommunicator.NewInstance ( )
int Kitware.VTK.vtkCommunicator.Receive ( vtkDataObject  data,
int  remoteHandle,
int  tag 
)

This method receives a data object from a corresponding send. It blocks until the receive is finished.

int Kitware.VTK.vtkCommunicator.Receive ( vtkDataArray  data,
int  remoteHandle,
int  tag 
)

This method receives a data array from a corresponding send. It blocks until the receive is finished.

int Kitware.VTK.vtkCommunicator.Receive ( IntPtr  data,
long  maxlength,
int  remoteHandle,
int  tag 
)

Convenience methods for receiving data arrays.

int Kitware.VTK.vtkCommunicator.Receive ( string  data,
long  maxlength,
int  remoteHandle,
int  tag 
)

Convenience methods for receiving data arrays.

vtkDataObject Kitware.VTK.vtkCommunicator.ReceiveDataObject ( int  remoteHandle,
int  tag 
)

The caller does not have to know the data type before this call is made. It returns the newly created object.

Here is the call graph for this function:

virtual int Kitware.VTK.vtkCommunicator.ReceiveVoidArray ( IntPtr  data,
long  maxlength,
int  type,
int  remoteHandle,
int  tag 
)
virtual

Subclasses have to supply this method to receive various arrays of data. The type arg is one of the VTK type constants recognized by the vtkTemplateMacro (VTK_FLOAT, VTK_INT, etc.). maxlength is measured in number of values (as opposed to number of bytes) and is the maxmum length of the data to receive. If the maxlength is less than the length of the message sent by the sender, an error will be flagged. Once a message is received, use the GetCount() method to determine the actual size of the data received.

Reimplemented in Kitware.VTK.vtkSocketCommunicator, Kitware.VTK.vtkSubCommunicator, and Kitware.VTK.vtkDummyCommunicator.

int Kitware.VTK.vtkCommunicator.Reduce ( IntPtr  sendBuffer,
IntPtr  recvBuffer,
long  length,
int  operation,
int  destProcessId 
)

Reduce an array to the given destination process. This version of Reduce takes an identifier defined in the vtkCommunicator::StandardOperations enum to define the operation.

int Kitware.VTK.vtkCommunicator.Reduce ( string  sendBuffer,
string  recvBuffer,
long  length,
int  operation,
int  destProcessId 
)

Reduce an array to the given destination process. This version of Reduce takes an identifier defined in the vtkCommunicator::StandardOperations enum to define the operation.

int Kitware.VTK.vtkCommunicator.Reduce ( vtkDataArray  sendBuffer,
vtkDataArray  recvBuffer,
int  operation,
int  destProcessId 
)

Reduce an array to the given destination process. This version of Reduce takes an identifier defined in the vtkCommunicator::StandardOperations enum to define the operation.

virtual int Kitware.VTK.vtkCommunicator.ReduceVoidArray ( IntPtr  sendBuffer,
IntPtr  recvBuffer,
long  length,
int  type,
int  operation,
int  destProcessId 
)
virtual

Subclasses should reimplement these if they have a more efficient implementation.

Reimplemented in Kitware.VTK.vtkSocketCommunicator.

static new vtkCommunicator Kitware.VTK.vtkCommunicator.SafeDownCast ( vtkObjectBase  o)
static

Undocumented Block

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkSocketCommunicator, Kitware.VTK.vtkSubCommunicator, and Kitware.VTK.vtkDummyCommunicator.

Here is the call graph for this function:

int Kitware.VTK.vtkCommunicator.Scatter ( IntPtr  sendBuffer,
IntPtr  recvBuffer,
long  length,
int  srcProcessId 
)

Scatter takes an array in the process with id srcProcessId and distributes it. Each process (including the source) receives a portion of the send buffer. Process 0 receives the first length values, process 1 receives the second length values, and so on. Scatter is the inverse operation of Gather.

int Kitware.VTK.vtkCommunicator.Scatter ( string  sendBuffer,
string  recvBuffer,
long  length,
int  srcProcessId 
)

Scatter takes an array in the process with id srcProcessId and distributes it. Each process (including the source) receives a portion of the send buffer. Process 0 receives the first length values, process 1 receives the second length values, and so on. Scatter is the inverse operation of Gather.

int Kitware.VTK.vtkCommunicator.Scatter ( vtkDataArray  sendBuffer,
vtkDataArray  recvBuffer,
int  srcProcessId 
)

Scatter takes an array in the process with id srcProcessId and distributes it. Each process (including the source) receives a portion of the send buffer. Process 0 receives the first length values, process 1 receives the second length values, and so on. Scatter is the inverse operation of Gather.

int Kitware.VTK.vtkCommunicator.ScatterV ( IntPtr  sendBuffer,
IntPtr  recvBuffer,
IntPtr  sendLengths,
IntPtr  offsets,
long  recvLength,
int  srcProcessId 
)

ScatterV is the vector variant of Scatter. It extends the functionality of Scatter by allowing a varying count of data to each process. ScatterV takes an array in the process with id srcProcessId and distributes it. Each process (including the source) receives a portion of the send buffer defined by the sendLengths and offsets arrays.

int Kitware.VTK.vtkCommunicator.ScatterV ( string  sendBuffer,
string  recvBuffer,
IntPtr  sendLengths,
IntPtr  offsets,
long  recvLength,
int  srcProcessId 
)

ScatterV is the vector variant of Scatter. It extends the functionality of Scatter by allowing a varying count of data to each process. ScatterV takes an array in the process with id srcProcessId and distributes it. Each process (including the source) receives a portion of the send buffer defined by the sendLengths and offsets arrays.

virtual int Kitware.VTK.vtkCommunicator.ScatterVoidArray ( IntPtr  sendBuffer,
IntPtr  recvBuffer,
long  length,
int  type,
int  srcProcessId 
)
virtual

Subclasses should reimplement these if they have a more efficient implementation.

Reimplemented in Kitware.VTK.vtkSocketCommunicator.

virtual int Kitware.VTK.vtkCommunicator.ScatterVVoidArray ( IntPtr  sendBuffer,
IntPtr  recvBuffer,
IntPtr  sendLengths,
IntPtr  offsets,
long  recvLength,
int  type,
int  srcProcessId 
)
virtual

Subclasses should reimplement these if they have a more efficient implementation.

Reimplemented in Kitware.VTK.vtkSocketCommunicator.

int Kitware.VTK.vtkCommunicator.Send ( vtkDataObject  data,
int  remoteHandle,
int  tag 
)

This method sends a data object to a destination. Tag eliminates ambiguity and is used to match sends to receives.

int Kitware.VTK.vtkCommunicator.Send ( vtkDataArray  data,
int  remoteHandle,
int  tag 
)

This method sends a data array to a destination. Tag eliminates ambiguity and is used to match sends to receives.

int Kitware.VTK.vtkCommunicator.Send ( IntPtr  data,
long  length,
int  remoteHandle,
int  tag 
)

Convenience methods for sending data arrays.

int Kitware.VTK.vtkCommunicator.Send ( string  data,
long  length,
int  remoteHandle,
int  tag 
)

Convenience methods for sending data arrays.

virtual int Kitware.VTK.vtkCommunicator.SendVoidArray ( IntPtr  data,
long  length,
int  type,
int  remoteHandle,
int  tag 
)
virtual

Subclasses have to supply this method to send various arrays of data. The type arg is one of the VTK type constants recognized by the vtkTemplateMacro (VTK_FLOAT, VTK_INT, etc.). length is measured in number of values (as opposed to number of bytes).

Reimplemented in Kitware.VTK.vtkSocketCommunicator, Kitware.VTK.vtkSubCommunicator, and Kitware.VTK.vtkDummyCommunicator.

virtual void Kitware.VTK.vtkCommunicator.SetNumberOfProcesses ( int  num)
virtual

Set the number of processes you will be using. This defaults to the maximum number available. If you set this to a value higher than the default, you will get an error.

Reimplemented in Kitware.VTK.vtkSocketCommunicator.

static void Kitware.VTK.vtkCommunicator.SetUseCopy ( int  useCopy)
static

Subclasses should reimplement these if they have a more efficient implementation.

static int Kitware.VTK.vtkCommunicator.UnMarshalDataObject ( vtkCharArray  buffer,
vtkDataObject  arg1 
)
static

Convert a data object into a string that can be transmitted and vice versa. Returns 1 for success and 0 for failure. WARNING: This will only work for types that have a vtkDataWriter class.

Member Data Documentation

new readonly string Kitware.VTK.vtkCommunicator.MRClassNameKey = "15vtkCommunicator"
static

Automatically generated type registration mechanics.

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

Automatically generated type registration mechanics.


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