VTK  9.3.0
vtkMultiProcessStream.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
20 #ifndef vtkMultiProcessStream_h
21 #define vtkMultiProcessStream_h
22 
23 #include "vtkObject.h"
24 #include "vtkParallelCoreModule.h" // For export macro
25 #include <string> // needed for string.
26 #include <vector> // needed for vector.
27 
28 VTK_ABI_NAMESPACE_BEGIN
29 class VTKPARALLELCORE_EXPORT vtkMultiProcessStream
30 {
31 public:
36 
38 
51  // Without this operator, the compiler would convert
52  // a char* to a bool instead of a std::string.
56 
58 
73 
75 
78  void Push(double array[], unsigned int size);
79  void Push(float array[], unsigned int size);
80  void Push(int array[], unsigned int size);
81  void Push(char array[], unsigned int size);
82  void Push(unsigned int array[], unsigned int size);
83  void Push(unsigned char array[], unsigned int size);
84  void Push(vtkTypeInt64 array[], unsigned int size);
85  void Push(vtkTypeUInt64 array[], unsigned int size);
87 
89 
96  void Pop(double*& array, unsigned int& size);
97  void Pop(float*& array, unsigned int& size);
98  void Pop(int*& array, unsigned int& size);
99  void Pop(char*& array, unsigned int& size);
100  void Pop(unsigned int*& array, unsigned int& size);
101  void Pop(unsigned char*& array, unsigned int& size);
102  void Pop(vtkTypeInt64*& array, unsigned int& size);
103  void Pop(vtkTypeUInt64*& array, unsigned int& size);
105 
109  void Reset();
110 
114  int Size();
115 
120  int RawSize() { return (this->Size() + 1); }
121 
125  bool Empty();
126 
128 
132  void GetRawData(std::vector<unsigned char>& data) const;
133  void GetRawData(unsigned char*& data, unsigned int& size);
134  void SetRawData(const std::vector<unsigned char>& data);
135  void SetRawData(const unsigned char*, unsigned int size);
136  std::vector<unsigned char> GetRawData() const;
138 
139 private:
140  class vtkInternals;
141  vtkInternals* Internals;
142  unsigned char Endianness;
143  enum
144  {
145  BigEndian,
146  LittleEndian
147  };
148 };
149 
150 VTK_ABI_NAMESPACE_END
151 #endif
152 
153 // VTK-HeaderTest-Exclude: vtkMultiProcessStream.h
stream used to pass data across processes using vtkMultiProcessController.
void Pop(vtkTypeUInt64 *&array, unsigned int &size)
Remove-array-to-stream methods.
void SetRawData(const unsigned char *, unsigned int size)
Serialization methods used to save/restore the stream to/from raw data.
vtkMultiProcessStream & operator<<(char value)
Add-to-stream operators.
vtkMultiProcessStream & operator>>(bool &value)
Remove-from-stream operators.
vtkMultiProcessStream & operator>>(std::string &value)
Remove-from-stream operators.
void Pop(double *&array, unsigned int &size)
Remove-array-to-stream methods.
vtkMultiProcessStream & operator<<(unsigned char value)
Add-to-stream operators.
void SetRawData(const std::vector< unsigned char > &data)
Serialization methods used to save/restore the stream to/from raw data.
vtkMultiProcessStream & operator>>(vtkTypeInt64 &value)
Remove-from-stream operators.
vtkMultiProcessStream & operator>>(char &value)
Remove-from-stream operators.
bool Empty()
Returns true iff the stream is empty.
vtkMultiProcessStream & operator>>(unsigned int &value)
Remove-from-stream operators.
void Push(float array[], unsigned int size)
Add-array-to-stream methods.
vtkMultiProcessStream & operator>>(float &value)
Remove-from-stream operators.
void GetRawData(std::vector< unsigned char > &data) const
Serialization methods used to save/restore the stream to/from raw data.
vtkMultiProcessStream & operator<<(int value)
Add-to-stream operators.
void Pop(char *&array, unsigned int &size)
Remove-array-to-stream methods.
vtkMultiProcessStream & operator>>(vtkTypeUInt64 &value)
Remove-from-stream operators.
void Push(unsigned int array[], unsigned int size)
Add-array-to-stream methods.
vtkMultiProcessStream & operator>>(int &value)
Remove-from-stream operators.
void Pop(unsigned char *&array, unsigned int &size)
Remove-array-to-stream methods.
void Push(int array[], unsigned int size)
Add-array-to-stream methods.
vtkMultiProcessStream & operator<<(float value)
Add-to-stream operators.
vtkMultiProcessStream & operator<<(vtkTypeUInt64 value)
Add-to-stream operators.
void Push(char array[], unsigned int size)
Add-array-to-stream methods.
vtkMultiProcessStream & operator>>(double &value)
Remove-from-stream operators.
vtkMultiProcessStream & operator<<(const vtkMultiProcessStream &)
Add-to-stream operators.
void Reset()
Clears everything in the stream.
void Push(double array[], unsigned int size)
Add-array-to-stream methods.
vtkMultiProcessStream & operator<<(double value)
Add-to-stream operators.
void Push(vtkTypeInt64 array[], unsigned int size)
Add-array-to-stream methods.
vtkMultiProcessStream & operator<<(unsigned int value)
Add-to-stream operators.
void Pop(float *&array, unsigned int &size)
Remove-array-to-stream methods.
void Pop(int *&array, unsigned int &size)
Remove-array-to-stream methods.
void Pop(unsigned int *&array, unsigned int &size)
Remove-array-to-stream methods.
vtkMultiProcessStream & operator<<(const char *value)
Add-to-stream operators.
vtkMultiProcessStream & operator>>(unsigned char &value)
Remove-from-stream operators.
void Push(vtkTypeUInt64 array[], unsigned int size)
Add-array-to-stream methods.
vtkMultiProcessStream & operator=(const vtkMultiProcessStream &)
void Pop(vtkTypeInt64 *&array, unsigned int &size)
Remove-array-to-stream methods.
vtkMultiProcessStream & operator<<(const std::string &value)
Add-to-stream operators.
void GetRawData(unsigned char *&data, unsigned int &size)
Serialization methods used to save/restore the stream to/from raw data.
vtkMultiProcessStream & operator>>(vtkMultiProcessStream &)
Remove-from-stream operators.
std::vector< unsigned char > GetRawData() const
Serialization methods used to save/restore the stream to/from raw data.
vtkMultiProcessStream & operator<<(vtkTypeInt64 value)
Add-to-stream operators.
void Push(unsigned char array[], unsigned int size)
Add-array-to-stream methods.
vtkMultiProcessStream & operator<<(bool value)
Add-to-stream operators.
int Size()
Returns the size of the stream.
int RawSize()
Returns the size of the raw data returned by GetRawData.
vtkMultiProcessStream(const vtkMultiProcessStream &)
@ value
Definition: vtkX3D.h:220
@ size
Definition: vtkX3D.h:253
@ data
Definition: vtkX3D.h:315
@ string
Definition: vtkX3D.h:490