Parallel/vtkCommunicator.h Source File

00001 /*=========================================================================
00002   
00003   Program:   Visualization Toolkit
00004   Module:    $RCSfile: vtkCommunicator.h,v $
00005   Language:  C++
00006   
00007 Copyright (c) 1993-2001 Ken Martin, Will Schroeder, Bill Lorensen 
00008 All rights reserved.
00009 
00010 Redistribution and use in source and binary forms, with or without
00011 modification, are permitted provided that the following conditions are met:
00012 
00013  * Redistributions of source code must retain the above copyright notice,
00014    this list of conditions and the following disclaimer.
00015 
00016  * Redistributions in binary form must reproduce the above copyright notice,
00017    this list of conditions and the following disclaimer in the documentation
00018    and/or other materials provided with the distribution.
00019 
00020  * Neither name of Ken Martin, Will Schroeder, or Bill Lorensen nor the names
00021    of any contributors may be used to endorse or promote products derived
00022    from this software without specific prior written permission.
00023 
00024  * Modified source versions must be plainly marked as such, and must not be
00025    misrepresented as being the original software.
00026 
00027 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
00028 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00029 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00030 ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE FOR
00031 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00032 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
00033 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00034 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00035 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00036 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00037 
00038 =========================================================================*/
00061 #ifndef __vtkCommunicator_h
00062 #define __vtkCommunicator_h
00063 
00064 #include "vtkObject.h"
00065 #include "vtkDataObject.h"
00066 #include "vtkDataArray.h"
00067 
00068 class vtkDataSet;
00069 class vtkImageData;
00070 
00071 class VTK_PARALLEL_EXPORT vtkCommunicator : public vtkObject
00072 {
00073 
00074 public:
00075 
00076   vtkTypeMacro(vtkCommunicator, vtkObject);
00077   void PrintSelf(ostream& os, vtkIndent indent);
00078 
00081   virtual int Send(vtkDataObject* data, int remoteHandle, int tag);
00082 
00085   virtual int Send(vtkDataArray* data, int remoteHandle, int tag);
00086   
00088 
00089   virtual int Send(int* data, int length, int remoteHandle, int tag) = 0;
00090   virtual int Send(unsigned long* data, int length, int remoteHandle, 
00091                    int tag) = 0;
00092   virtual int Send(unsigned char* data, int length, int remoteHandle, 
00093                    int tag) = 0;
00094   virtual int Send(char* data, int length, int remoteHandle, 
00095                    int tag) = 0;
00096   virtual int Send(float* data, int length, int remoteHandle, 
00097                    int tag) = 0;
00098   virtual int Send(double* data, int length, int remoteHandle, 
00099                    int tag) = 0;
00100 #ifdef VTK_USE_64BIT_IDS
00101   virtual int Send(vtkIdType* data, int length, int remoteHandle, 
00102                    int tag) = 0;
00104 #endif
00105 
00106 
00109   virtual int Receive(vtkDataObject* data, int remoteHandle, int tag);
00110 
00113   virtual int Receive(vtkDataArray* data, int remoteHandle, int tag);
00114 
00116 
00118   virtual int Receive(int* data, int length, int remoteHandle, 
00119                       int tag) = 0;
00120   virtual int Receive(unsigned long* data, int length, int remoteHandle,
00121                       int tag) = 0;
00122   virtual int Receive(unsigned char* data, int length, int remoteHandle, 
00123                       int tag) = 0;
00124   virtual int Receive(char* data, int length, int remoteHandle, 
00125                       int tag) = 0;
00126   virtual int Receive(float* data, int length, int remoteHandle, 
00127                       int tag) = 0;
00128   virtual int Receive(double* data, int length, int remoteHandle, 
00129                       int tag) = 0;
00130 #ifdef VTK_USE_64BIT_IDS
00131   virtual int Receive(vtkIdType* data, int length, int remoteHandle, 
00132                       int tag) = 0;
00134 #endif
00135 
00136 protected:
00137 
00138   void DeleteAndSetMarshalString(char *str, int strLength);
00139 
00140   // Write and read from marshal string
00141   // return 1 success, 0 fail
00142   int WriteObject(vtkDataObject *object);
00143   int ReadObject(vtkDataObject *object);
00144   
00145   int WriteDataSet(vtkDataSet *object);
00146   int ReadDataSet(vtkDataSet *object);
00147 
00148   int WriteImageData(vtkImageData *object);
00149   int ReadImageData(vtkImageData *object);
00150 
00151   int WriteDataArray(vtkDataArray *object);
00152   int ReadDataArray(vtkDataArray *object);
00153 
00154   vtkCommunicator();
00155   ~vtkCommunicator();
00156 
00157   char *MarshalString;
00158   int MarshalStringLength;
00159   // The data may not take up all of the string.
00160   int MarshalDataLength;
00161 
00162 private:
00163   vtkCommunicator(const vtkCommunicator&);  // Not implemented.
00164   void operator=(const vtkCommunicator&);  // Not implemented.
00165 };
00166 
00167 #endif // __vtkCommunicator_h
00168 
00169