vtkMultiProcessStream.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkMultiProcessStream.h
 
  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
 
     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.
 
=========================================================================*/
#ifndef vtkMultiProcessStream_h
#define vtkMultiProcessStream_h
 
#include "vtkObject.h"
#include "vtkParallelCoreModule.h" // For export macro
#include <string>                  // needed for string.
#include <vector>                  // needed for vector.
 
class VTKPARALLELCORE_EXPORT vtkMultiProcessStream
{
public:
  vtkMultiProcessStream();
  vtkMultiProcessStream(const vtkMultiProcessStream&);
  ~vtkMultiProcessStream();
  vtkMultiProcessStream& operator=(const vtkMultiProcessStream&);
 
 
  vtkMultiProcessStream& operator<<(double value);
  vtkMultiProcessStream& operator<<(float value);
  vtkMultiProcessStream& operator<<(int value);
  vtkMultiProcessStream& operator<<(char value);
  vtkMultiProcessStream& operator<<(bool value);
  vtkMultiProcessStream& operator<<(unsigned int value);
  vtkMultiProcessStream& operator<<(unsigned char value);
  vtkMultiProcessStream& operator<<(vtkTypeInt64 value);
  vtkMultiProcessStream& operator<<(vtkTypeUInt64 value);
  vtkMultiProcessStream& operator<<(const std::string& value);
  // Without this operator, the compiler would convert
  // a char* to a bool instead of a std::string.
  vtkMultiProcessStream& operator<<(const char* value);
  vtkMultiProcessStream& operator<<(const vtkMultiProcessStream&);
 
 
  vtkMultiProcessStream& operator>>(double& value);
  vtkMultiProcessStream& operator>>(float& value);
  vtkMultiProcessStream& operator>>(int& value);
  vtkMultiProcessStream& operator>>(char& value);
  vtkMultiProcessStream& operator>>(bool& value);
  vtkMultiProcessStream& operator>>(unsigned int& value);
  vtkMultiProcessStream& operator>>(unsigned char& value);
  vtkMultiProcessStream& operator>>(vtkTypeInt64& value);
  vtkMultiProcessStream& operator>>(vtkTypeUInt64& value);
  vtkMultiProcessStream& operator>>(std::string& value);
  vtkMultiProcessStream& operator>>(vtkMultiProcessStream&);
 
 
  void Push(double array[], unsigned int size);
  void Push(float array[], unsigned int size);
  void Push(int array[], unsigned int size);
  void Push(char array[], unsigned int size);
  void Push(unsigned int array[], unsigned int size);
  void Push(unsigned char array[], unsigned int size);
  void Push(vtkTypeInt64 array[], unsigned int size);
  void Push(vtkTypeUInt64 array[], unsigned int size);
 
 
  void Pop(double*& array, unsigned int& size);
  void Pop(float*& array, unsigned int& size);
  void Pop(int*& array, unsigned int& size);
  void Pop(char*& array, unsigned int& size);
  void Pop(unsigned int*& array, unsigned int& size);
  void Pop(unsigned char*& array, unsigned int& size);
  void Pop(vtkTypeInt64*& array, unsigned int& size);
  void Pop(vtkTypeUInt64*& array, unsigned int& size);
 
  void Reset();
 
  int Size();
 
  int RawSize() { return (this->Size() + 1); }
 
  bool Empty();
 
 
  void GetRawData(std::vector<unsigned char>& data) const;
  void GetRawData(unsigned char*& data, unsigned int& size);
  void SetRawData(const std::vector<unsigned char>& data);
  void SetRawData(const unsigned char*, unsigned int size);
  std::vector<unsigned char> GetRawData() const;
 
private:
  class vtkInternals;
  vtkInternals* Internals;
  unsigned char Endianness;
  enum
  {
    BigEndian,
    LittleEndian
  };
};
 
#endif
 
// VTK-HeaderTest-Exclude: vtkMultiProcessStream.h