VTK
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
vtkMultiProcessStream.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkMultiProcessStream.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
31 #ifndef __vtkMultiProcessStream_h
32 #define __vtkMultiProcessStream_h
33 
34 #include "vtkParallelCoreModule.h" // For export macro
35 #include "vtkObject.h"
36 #include <vector> // needed for vector.
37 #include <string> // needed for string.
38 
39 class VTKPARALLELCORE_EXPORT vtkMultiProcessStream
40 {
41 public:
46 
48 
49  vtkMultiProcessStream& operator << (double value);
50  vtkMultiProcessStream& operator << (float value);
51  vtkMultiProcessStream& operator << (int value);
52  vtkMultiProcessStream& operator << (char value);
53  vtkMultiProcessStream& operator << (unsigned int value);
54  vtkMultiProcessStream& operator << (unsigned char value);
55  vtkMultiProcessStream& operator << (vtkTypeInt64 value);
56  vtkMultiProcessStream& operator << (vtkTypeUInt64 value);
57  vtkMultiProcessStream& operator << (const std::string& value);
58  vtkMultiProcessStream& operator << (const vtkMultiProcessStream&);
60 
62 
63  vtkMultiProcessStream& operator >> (double &value);
64  vtkMultiProcessStream& operator >> (float &value);
65  vtkMultiProcessStream& operator >> (int &value);
66  vtkMultiProcessStream& operator >> (char &value);
67  vtkMultiProcessStream& operator >> (unsigned int &value);
68  vtkMultiProcessStream& operator >> (unsigned char &value);
69  vtkMultiProcessStream& operator >> (vtkTypeInt64 &value);
70  vtkMultiProcessStream& operator >> (vtkTypeUInt64 &value);
71  vtkMultiProcessStream& operator >> (std::string &value);
74 
76 
77  void Push(double array[], unsigned int size);
78  void Push(float array[], unsigned int size);
79  void Push(int array[], unsigned int size);
80  void Push(char array[], unsigned int size);
81  void Push(unsigned int array[], unsigned int size );
82  void Push(unsigned char array[], unsigned int size );
83  void Push(vtkTypeInt64 array[], unsigned int size );
84  void Push(vtkTypeUInt64 array[], unsigned int size );
86 
88 
90  void Pop(double*& array, unsigned int& size);
91  void Pop(float*& array, unsigned int& size);
92  void Pop(int*& array, unsigned int& size);
93  void Pop(char*& array, unsigned int& size);
94  void Pop(unsigned int*& array, unsigned int& size );
95  void Pop(unsigned char*& array, unsigned int& size );
96  void Pop(vtkTypeInt64*& array, unsigned int& size );
97  void Pop(vtkTypeUInt64*& array, unsigned int& size );
99 
100 
102  void Reset();
103 
105  int Size();
106 
108  bool Empty();
109 
111 
114  void GetRawData(std::vector<unsigned char>& data) const;
115  void GetRawData( unsigned char*& data, unsigned int &size );
116  void SetRawData(const std::vector<unsigned char>& data);
117  void SetRawData(const unsigned char*, unsigned int size);
119 
120 private:
121  class vtkInternals;
122  vtkInternals* Internals;
123  unsigned char Endianness;
124  enum
125  {
126  BigEndian,
127  LittleEndian
128  };
129 };
130 
131 #endif
132 
133 
134 // VTK-HeaderTest-Exclude: vtkMultiProcessStream.h
stream used to pass data across processes using vtkMultiProcessController.