ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Static Private Member Functions
Kitware.VTK.vtkSocketCommunicator Class Reference

vtkSocketCommunicator - Process communication using Sockets More...

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

List of all members.

Public Member Functions

 vtkSocketCommunicator (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkSocketCommunicator ()
 *Undocumented Block
override int AllGatherVVoidArray (IntPtr sendBuffer, IntPtr recvBuffer, int sendLength, IntPtr recvLengths, IntPtr offsets, int type)
 This class foolishly breaks the conventions of the superclass, so the default implementations of these methods do not work. These just give errors instead.
override int AllGatherVoidArray (IntPtr sendBuffer, IntPtr recvBuffer, int length, int type)
 This class foolishly breaks the conventions of the superclass, so the default implementations of these methods do not work. These just give errors instead.
override int AllReduceVoidArray (IntPtr sendBuffer, IntPtr recvBuffer, int length, int type, int operation)
 This class foolishly breaks the conventions of the superclass, so the default implementations of these methods do not work. These just give errors instead.
override void Barrier ()
 This class foolishly breaks the conventions of the superclass, so this overload fixes the method.
override int BroadcastVoidArray (IntPtr data, int length, int type, int srcProcessId)
 This class foolishly breaks the conventions of the superclass, so the default implementations of these methods do not work. These just give errors instead.
int ClientSideHandshake ()
 Performs ClientSide handshake. One should preferably use Handshake() which calls ServerSideHandshake or ClientSideHandshake as required.
virtual void CloseConnection ()
 Close a connection.
virtual int ConnectTo (string hostName, int port)
 Open a connection to host.
override int GatherVVoidArray (IntPtr sendBuffer, IntPtr recvBuffer, int sendLength, IntPtr recvLengths, IntPtr offsets, int type, int destProcessId)
 This class foolishly breaks the conventions of the superclass, so the default implementations of these methods do not work. These just give errors instead.
override int GatherVoidArray (IntPtr sendBuffer, IntPtr recvBuffer, int length, int type, int destProcessId)
 This class foolishly breaks the conventions of the superclass, so the default implementations of these methods do not work. These just give errors instead.
int GetIsConnected ()
 Is the communicator connected?.
virtual int GetIsServer ()
 Returns true if this side of the socket is the server. The result is invalid if the socket is not connected.
virtual int GetPerformHandshake ()
 Set or get the PerformHandshake ivar. If it is on, the communicator will try to perform a handshake when connected. It is on by default.
virtual int GetPerformHandshakeMaxValue ()
 Set or get the PerformHandshake ivar. If it is on, the communicator will try to perform a handshake when connected. It is on by default.
virtual int GetPerformHandshakeMinValue ()
 Set or get the PerformHandshake ivar. If it is on, the communicator will try to perform a handshake when connected. It is on by default.
virtual int GetReportErrors ()
 If ReportErrors if false, all vtkErrorMacros are suppressed.
virtual vtkClientSocket GetSocket ()
 Get/Set the actual socket used for communication.
virtual int GetSwapBytesInReceivedData ()
 Returns 1 if bytes must be swapped in received ints, floats, etc.
int Handshake ()
 Performs handshake. This uses vtkClientSocket::ConnectingSide to decide whether to perform ServerSideHandshake or ClientSideHandshake.
override int IsA (string type)
 *Undocumented Block
virtual int LogToFile (string name)
 Log messages to the given file. The file is truncated unless the second argument is non-zero (default is to truncate). If the file name is empty or NULL, logging is disabled. Returns 0 if the file failed to open, and 1 otherwise.
virtual int LogToFile (string name, int append)
 Log messages to the given file. The file is truncated unless the second argument is non-zero (default is to truncate). If the file name is empty or NULL, logging is disabled. Returns 0 if the file failed to open, and 1 otherwise.
new vtkSocketCommunicator NewInstance ()
 *Undocumented Block
virtual void PerformHandshakeOff ()
 Set or get the PerformHandshake ivar. If it is on, the communicator will try to perform a handshake when connected. It is on by default.
virtual void PerformHandshakeOn ()
 Set or get the PerformHandshake ivar. If it is on, the communicator will try to perform a handshake when connected. It is on by default.
override int ReceiveVoidArray (IntPtr data, int length, int type, int remoteHandle, int tag)
 Performs the actual communication. You will usually use the convenience Send functions defined in the superclass.
override int ReduceVoidArray (IntPtr sendBuffer, IntPtr recvBuffer, int length, int type, int operation, int destProcessId)
 This class foolishly breaks the conventions of the superclass, so the default implementations of these methods do not work. These just give errors instead.
override int ScatterVVoidArray (IntPtr sendBuffer, IntPtr recvBuffer, IntPtr sendLengths, IntPtr offsets, int recvLength, int type, int srcProcessId)
 This class foolishly breaks the conventions of the superclass, so the default implementations of these methods do not work. These just give errors instead.
override int ScatterVoidArray (IntPtr sendBuffer, IntPtr recvBuffer, int length, int type, int srcProcessId)
 This class foolishly breaks the conventions of the superclass, so the default implementations of these methods do not work. These just give errors instead.
override int SendVoidArray (IntPtr data, int length, int type, int remoteHandle, int tag)
 Performs the actual communication. You will usually use the convenience Send functions defined in the superclass.
int ServerSideHandshake ()
 Performs ServerSide handshake. One should preferably use Handshake() which calls ServerSideHandshake or ClientSideHandshake as required.
override void SetNumberOfProcesses (int num)
 Set the number of processes you will be using.
virtual void SetPerformHandshake (int _arg)
 Set or get the PerformHandshake ivar. If it is on, the communicator will try to perform a handshake when connected. It is on by default.
virtual void SetReportErrors (int _arg)
 If ReportErrors if false, all vtkErrorMacros are suppressed.
void SetSocket (vtkClientSocket arg0)
 Get/Set the actual socket used for communication.
virtual int WaitForConnection (int port)
 Wait for connection on a given port. These methods return 1 on success, 0 on error.
virtual int WaitForConnection (vtkServerSocket socket, uint msec)
 Wait for connection on a given port. These methods return 1 on success, 0 on error.
- Public Member Functions inherited from Kitware.VTK.vtkCommunicator
 vtkCommunicator (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
int AllGather (IntPtr sendBuffer, IntPtr recvBuffer, int 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 AllGather (string sendBuffer, string recvBuffer, int length)
 Same as gather except that the result ends up on all processes.
int AllGatherV (IntPtr sendBuffer, IntPtr recvBuffer, int sendLength, IntPtr recvLengths, IntPtr offsets)
 Same as GatherV except that the result is placed in all processes.
int AllGatherV (string sendBuffer, string recvBuffer, int 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.
int AllReduce (IntPtr sendBuffer, IntPtr recvBuffer, int length, int operation)
 Same as Reduce except that the result is placed in all of the processes.
int AllReduce (string sendBuffer, string recvBuffer, int 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.
int Broadcast (IntPtr data, int 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, int 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.
int Gather (IntPtr sendBuffer, IntPtr recvBuffer, int 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, int 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, int 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, int 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 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.
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, int maxlength, int remoteHandle, int tag)
 Convenience methods for receiving data arrays.
int Receive (string data, int 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.
int Reduce (IntPtr sendBuffer, IntPtr recvBuffer, int 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, int 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.
int Scatter (IntPtr sendBuffer, IntPtr recvBuffer, int 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, int 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, int 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, int 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 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, int length, int remoteHandle, int tag)
 Convenience methods for sending data arrays.
int Send (string data, int length, int remoteHandle, int tag)
 Convenience methods for sending data arrays.
- 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 new vtkSocketCommunicator New ()
 *Undocumented Block
static new int IsTypeOf (string type)
 *Undocumented Block
static new vtkSocketCommunicator SafeDownCast (vtkObjectBase o)
 *Undocumented Block
- Static Public Member Functions inherited from Kitware.VTK.vtkCommunicator
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 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 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 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.vtkSocketCommunicator"
 Automatically generated type registration mechanics.
- Public Attributes inherited from Kitware.VTK.vtkCommunicator
- Public Attributes inherited from Kitware.VTK.vtkObject
- Public Attributes inherited from Kitware.VTK.vtkObjectBase
- 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 = "21vtkSocketCommunicator"
 Automatically generated type registration mechanics.
- Static Public Attributes inherited from Kitware.VTK.vtkCommunicator
- Static Public Attributes inherited from Kitware.VTK.vtkObject
- Static Public Attributes inherited from Kitware.VTK.vtkObjectBase

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 vtkSocketCommunicator ()
 Automatically generated type registration mechanics.

Additional Inherited Members

- Public Types inherited from Kitware.VTK.vtkCommunicator
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...

Detailed Description

vtkSocketCommunicator - Process communication using Sockets

Description This is a concrete implementation of vtkCommunicator which supports interprocess communication using BSD style sockets. It supports byte swapping for the communication of machines with different endianness.


Constructor & Destructor Documentation

static Kitware.VTK.vtkSocketCommunicator.vtkSocketCommunicator ( )
staticprivate

Automatically generated type registration mechanics.

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

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

Kitware.VTK.vtkSocketCommunicator.vtkSocketCommunicator ( )

*Undocumented Block


Member Function Documentation

override int Kitware.VTK.vtkSocketCommunicator.AllGatherVoidArray ( IntPtr  sendBuffer,
IntPtr  recvBuffer,
int  length,
int  type 
)
virtual

This class foolishly breaks the conventions of the superclass, so the default implementations of these methods do not work. These just give errors instead.

Reimplemented from Kitware.VTK.vtkCommunicator.

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

This class foolishly breaks the conventions of the superclass, so the default implementations of these methods do not work. These just give errors instead.

Reimplemented from Kitware.VTK.vtkCommunicator.

override int Kitware.VTK.vtkSocketCommunicator.AllReduceVoidArray ( IntPtr  sendBuffer,
IntPtr  recvBuffer,
int  length,
int  type,
int  operation 
)
virtual

This class foolishly breaks the conventions of the superclass, so the default implementations of these methods do not work. These just give errors instead.

Reimplemented from Kitware.VTK.vtkCommunicator.

override void Kitware.VTK.vtkSocketCommunicator.Barrier ( )
virtual

This class foolishly breaks the conventions of the superclass, so this overload fixes the method.

Reimplemented from Kitware.VTK.vtkCommunicator.

override int Kitware.VTK.vtkSocketCommunicator.BroadcastVoidArray ( IntPtr  data,
int  length,
int  type,
int  srcProcessId 
)
virtual

This class foolishly breaks the conventions of the superclass, so the default implementations of these methods do not work. These just give errors instead.

Reimplemented from Kitware.VTK.vtkCommunicator.

int Kitware.VTK.vtkSocketCommunicator.ClientSideHandshake ( )

Performs ClientSide handshake. One should preferably use Handshake() which calls ServerSideHandshake or ClientSideHandshake as required.

virtual void Kitware.VTK.vtkSocketCommunicator.CloseConnection ( )
virtual

Close a connection.

virtual int Kitware.VTK.vtkSocketCommunicator.ConnectTo ( string  hostName,
int  port 
)
virtual

Open a connection to host.

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

override int Kitware.VTK.vtkSocketCommunicator.GatherVoidArray ( IntPtr  sendBuffer,
IntPtr  recvBuffer,
int  length,
int  type,
int  destProcessId 
)
virtual

This class foolishly breaks the conventions of the superclass, so the default implementations of these methods do not work. These just give errors instead.

Reimplemented from Kitware.VTK.vtkCommunicator.

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

This class foolishly breaks the conventions of the superclass, so the default implementations of these methods do not work. These just give errors instead.

Reimplemented from Kitware.VTK.vtkCommunicator.

int Kitware.VTK.vtkSocketCommunicator.GetIsConnected ( )

Is the communicator connected?.

virtual int Kitware.VTK.vtkSocketCommunicator.GetIsServer ( )
virtual

Returns true if this side of the socket is the server. The result is invalid if the socket is not connected.

virtual int Kitware.VTK.vtkSocketCommunicator.GetPerformHandshake ( )
virtual

Set or get the PerformHandshake ivar. If it is on, the communicator will try to perform a handshake when connected. It is on by default.

virtual int Kitware.VTK.vtkSocketCommunicator.GetPerformHandshakeMaxValue ( )
virtual

Set or get the PerformHandshake ivar. If it is on, the communicator will try to perform a handshake when connected. It is on by default.

virtual int Kitware.VTK.vtkSocketCommunicator.GetPerformHandshakeMinValue ( )
virtual

Set or get the PerformHandshake ivar. If it is on, the communicator will try to perform a handshake when connected. It is on by default.

virtual int Kitware.VTK.vtkSocketCommunicator.GetReportErrors ( )
virtual

If ReportErrors if false, all vtkErrorMacros are suppressed.

virtual vtkClientSocket Kitware.VTK.vtkSocketCommunicator.GetSocket ( )
virtual

Get/Set the actual socket used for communication.

Here is the call graph for this function:

virtual int Kitware.VTK.vtkSocketCommunicator.GetSwapBytesInReceivedData ( )
virtual

Returns 1 if bytes must be swapped in received ints, floats, etc.

int Kitware.VTK.vtkSocketCommunicator.Handshake ( )

Performs handshake. This uses vtkClientSocket::ConnectingSide to decide whether to perform ServerSideHandshake or ClientSideHandshake.

override int Kitware.VTK.vtkSocketCommunicator.IsA ( string  type)
virtual

*Undocumented Block

Reimplemented from Kitware.VTK.vtkCommunicator.

static new int Kitware.VTK.vtkSocketCommunicator.IsTypeOf ( string  type)
static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkCommunicator.

virtual int Kitware.VTK.vtkSocketCommunicator.LogToFile ( string  name)
virtual

Log messages to the given file. The file is truncated unless the second argument is non-zero (default is to truncate). If the file name is empty or NULL, logging is disabled. Returns 0 if the file failed to open, and 1 otherwise.

virtual int Kitware.VTK.vtkSocketCommunicator.LogToFile ( string  name,
int  append 
)
virtual

Log messages to the given file. The file is truncated unless the second argument is non-zero (default is to truncate). If the file name is empty or NULL, logging is disabled. Returns 0 if the file failed to open, and 1 otherwise.

static new vtkSocketCommunicator Kitware.VTK.vtkSocketCommunicator.New ( )
static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkObject.

new vtkSocketCommunicator Kitware.VTK.vtkSocketCommunicator.NewInstance ( )

*Undocumented Block

Reimplemented from Kitware.VTK.vtkCommunicator.

virtual void Kitware.VTK.vtkSocketCommunicator.PerformHandshakeOff ( )
virtual

Set or get the PerformHandshake ivar. If it is on, the communicator will try to perform a handshake when connected. It is on by default.

virtual void Kitware.VTK.vtkSocketCommunicator.PerformHandshakeOn ( )
virtual

Set or get the PerformHandshake ivar. If it is on, the communicator will try to perform a handshake when connected. It is on by default.

override int Kitware.VTK.vtkSocketCommunicator.ReceiveVoidArray ( IntPtr  data,
int  length,
int  type,
int  remoteHandle,
int  tag 
)
virtual

Performs the actual communication. You will usually use the convenience Send functions defined in the superclass.

Reimplemented from Kitware.VTK.vtkCommunicator.

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

This class foolishly breaks the conventions of the superclass, so the default implementations of these methods do not work. These just give errors instead.

Reimplemented from Kitware.VTK.vtkCommunicator.

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

*Undocumented Block

Reimplemented from Kitware.VTK.vtkCommunicator.

Here is the call graph for this function:

override int Kitware.VTK.vtkSocketCommunicator.ScatterVoidArray ( IntPtr  sendBuffer,
IntPtr  recvBuffer,
int  length,
int  type,
int  srcProcessId 
)
virtual

This class foolishly breaks the conventions of the superclass, so the default implementations of these methods do not work. These just give errors instead.

Reimplemented from Kitware.VTK.vtkCommunicator.

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

This class foolishly breaks the conventions of the superclass, so the default implementations of these methods do not work. These just give errors instead.

Reimplemented from Kitware.VTK.vtkCommunicator.

override int Kitware.VTK.vtkSocketCommunicator.SendVoidArray ( IntPtr  data,
int  length,
int  type,
int  remoteHandle,
int  tag 
)
virtual

Performs the actual communication. You will usually use the convenience Send functions defined in the superclass.

Reimplemented from Kitware.VTK.vtkCommunicator.

int Kitware.VTK.vtkSocketCommunicator.ServerSideHandshake ( )

Performs ServerSide handshake. One should preferably use Handshake() which calls ServerSideHandshake or ClientSideHandshake as required.

override void Kitware.VTK.vtkSocketCommunicator.SetNumberOfProcesses ( int  num)
virtual

Set the number of processes you will be using.

Reimplemented from Kitware.VTK.vtkCommunicator.

virtual void Kitware.VTK.vtkSocketCommunicator.SetPerformHandshake ( int  _arg)
virtual

Set or get the PerformHandshake ivar. If it is on, the communicator will try to perform a handshake when connected. It is on by default.

virtual void Kitware.VTK.vtkSocketCommunicator.SetReportErrors ( int  _arg)
virtual

If ReportErrors if false, all vtkErrorMacros are suppressed.

void Kitware.VTK.vtkSocketCommunicator.SetSocket ( vtkClientSocket  arg0)

Get/Set the actual socket used for communication.

virtual int Kitware.VTK.vtkSocketCommunicator.WaitForConnection ( int  port)
virtual

Wait for connection on a given port. These methods return 1 on success, 0 on error.

virtual int Kitware.VTK.vtkSocketCommunicator.WaitForConnection ( vtkServerSocket  socket,
uint  msec 
)
virtual

Wait for connection on a given port. These methods return 1 on success, 0 on error.


Member Data Documentation

new readonly string Kitware.VTK.vtkSocketCommunicator.MRClassNameKey = "21vtkSocketCommunicator"
static

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkCommunicator.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkCommunicator.


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