VTK
Public Member Functions | List of all members
vtkMultiProcessStream Class Reference

stream used to pass data across processes using vtkMultiProcessController. More...

#include <vtkMultiProcessStream.h>

Public Member Functions

 vtkMultiProcessStream ()
 
 vtkMultiProcessStream (const vtkMultiProcessStream &)
 
 ~vtkMultiProcessStream ()
 
vtkMultiProcessStream & operator= (const vtkMultiProcessStream &)
 
void Reset ()
 
int Size ()
 
bool Empty ()
 
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)
 
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)
 
int RawSize ()
 
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)
 

Detailed Description

stream used to pass data across processes using vtkMultiProcessController.

vtkMultiProcessStream is used to pass data across processes. Using vtkMultiProcessStream it is possible to send data whose length is not known at the receiving end.

Warning
Note, stream operators cannot be combined with the Push/Pop array operators. For example, if you push an array to the stream,
Tests:
vtkMultiProcessStream (Tests)

Definition at line 39 of file vtkMultiProcessStream.h.

Constructor & Destructor Documentation

vtkMultiProcessStream::vtkMultiProcessStream ( )
vtkMultiProcessStream::vtkMultiProcessStream ( const vtkMultiProcessStream &  )
vtkMultiProcessStream::~vtkMultiProcessStream ( )

Member Function Documentation

vtkMultiProcessStream& vtkMultiProcessStream::operator= ( const vtkMultiProcessStream &  )
vtkMultiProcessStream& vtkMultiProcessStream::operator<< ( double  value)

Add-to-stream operators. Adds to the end of the stream.

vtkMultiProcessStream& vtkMultiProcessStream::operator<< ( float  value)

Add-to-stream operators. Adds to the end of the stream.

vtkMultiProcessStream& vtkMultiProcessStream::operator<< ( int  value)

Add-to-stream operators. Adds to the end of the stream.

vtkMultiProcessStream& vtkMultiProcessStream::operator<< ( char  value)

Add-to-stream operators. Adds to the end of the stream.

vtkMultiProcessStream& vtkMultiProcessStream::operator<< ( bool  value)

Add-to-stream operators. Adds to the end of the stream.

vtkMultiProcessStream& vtkMultiProcessStream::operator<< ( unsigned int  value)

Add-to-stream operators. Adds to the end of the stream.

vtkMultiProcessStream& vtkMultiProcessStream::operator<< ( unsigned char  value)

Add-to-stream operators. Adds to the end of the stream.

vtkMultiProcessStream& vtkMultiProcessStream::operator<< ( vtkTypeInt64  value)

Add-to-stream operators. Adds to the end of the stream.

vtkMultiProcessStream& vtkMultiProcessStream::operator<< ( vtkTypeUInt64  value)

Add-to-stream operators. Adds to the end of the stream.

vtkMultiProcessStream& vtkMultiProcessStream::operator<< ( const std::string &  value)

Add-to-stream operators. Adds to the end of the stream.

vtkMultiProcessStream& vtkMultiProcessStream::operator<< ( const char *  value)

Add-to-stream operators. Adds to the end of the stream.

vtkMultiProcessStream& vtkMultiProcessStream::operator<< ( const vtkMultiProcessStream &  )

Add-to-stream operators. Adds to the end of the stream.

vtkMultiProcessStream& vtkMultiProcessStream::operator>> ( double &  value)

Remove-from-stream operators. Removes from the head of the stream.

vtkMultiProcessStream& vtkMultiProcessStream::operator>> ( float &  value)

Remove-from-stream operators. Removes from the head of the stream.

vtkMultiProcessStream& vtkMultiProcessStream::operator>> ( int &  value)

Remove-from-stream operators. Removes from the head of the stream.

vtkMultiProcessStream& vtkMultiProcessStream::operator>> ( char &  value)

Remove-from-stream operators. Removes from the head of the stream.

vtkMultiProcessStream& vtkMultiProcessStream::operator>> ( bool &  value)

Remove-from-stream operators. Removes from the head of the stream.

vtkMultiProcessStream& vtkMultiProcessStream::operator>> ( unsigned int &  value)

Remove-from-stream operators. Removes from the head of the stream.

vtkMultiProcessStream& vtkMultiProcessStream::operator>> ( unsigned char &  value)

Remove-from-stream operators. Removes from the head of the stream.

vtkMultiProcessStream& vtkMultiProcessStream::operator>> ( vtkTypeInt64 &  value)

Remove-from-stream operators. Removes from the head of the stream.

vtkMultiProcessStream& vtkMultiProcessStream::operator>> ( vtkTypeUInt64 &  value)

Remove-from-stream operators. Removes from the head of the stream.

vtkMultiProcessStream& vtkMultiProcessStream::operator>> ( std::string &  value)

Remove-from-stream operators. Removes from the head of the stream.

vtkMultiProcessStream& vtkMultiProcessStream::operator>> ( vtkMultiProcessStream &  )

Remove-from-stream operators. Removes from the head of the stream.

void vtkMultiProcessStream::Push ( double  array[],
unsigned int  size 
)

Add-array-to-stream methods. Adds to the end of the stream

void vtkMultiProcessStream::Push ( float  array[],
unsigned int  size 
)

Add-array-to-stream methods. Adds to the end of the stream

void vtkMultiProcessStream::Push ( int  array[],
unsigned int  size 
)

Add-array-to-stream methods. Adds to the end of the stream

void vtkMultiProcessStream::Push ( char  array[],
unsigned int  size 
)

Add-array-to-stream methods. Adds to the end of the stream

void vtkMultiProcessStream::Push ( unsigned int  array[],
unsigned int  size 
)

Add-array-to-stream methods. Adds to the end of the stream

void vtkMultiProcessStream::Push ( unsigned char  array[],
unsigned int  size 
)

Add-array-to-stream methods. Adds to the end of the stream

void vtkMultiProcessStream::Push ( vtkTypeInt64  array[],
unsigned int  size 
)

Add-array-to-stream methods. Adds to the end of the stream

void vtkMultiProcessStream::Push ( vtkTypeUInt64  array[],
unsigned int  size 
)

Add-array-to-stream methods. Adds to the end of the stream

void vtkMultiProcessStream::Pop ( double *&  array,
unsigned int &  size 
)

Remove-array-to-stream methods. Removes from the head of the stream. Note: If the input array is NULL, the array will be allocated internally and the calling application is responsible for properly de-allocating it. If the input array is not NULL, it is expected to match the size of the data internally, and this method would just fill in the data.

void vtkMultiProcessStream::Pop ( float *&  array,
unsigned int &  size 
)

Remove-array-to-stream methods. Removes from the head of the stream. Note: If the input array is NULL, the array will be allocated internally and the calling application is responsible for properly de-allocating it. If the input array is not NULL, it is expected to match the size of the data internally, and this method would just fill in the data.

void vtkMultiProcessStream::Pop ( int *&  array,
unsigned int &  size 
)

Remove-array-to-stream methods. Removes from the head of the stream. Note: If the input array is NULL, the array will be allocated internally and the calling application is responsible for properly de-allocating it. If the input array is not NULL, it is expected to match the size of the data internally, and this method would just fill in the data.

void vtkMultiProcessStream::Pop ( char *&  array,
unsigned int &  size 
)

Remove-array-to-stream methods. Removes from the head of the stream. Note: If the input array is NULL, the array will be allocated internally and the calling application is responsible for properly de-allocating it. If the input array is not NULL, it is expected to match the size of the data internally, and this method would just fill in the data.

void vtkMultiProcessStream::Pop ( unsigned int *&  array,
unsigned int &  size 
)

Remove-array-to-stream methods. Removes from the head of the stream. Note: If the input array is NULL, the array will be allocated internally and the calling application is responsible for properly de-allocating it. If the input array is not NULL, it is expected to match the size of the data internally, and this method would just fill in the data.

void vtkMultiProcessStream::Pop ( unsigned char *&  array,
unsigned int &  size 
)

Remove-array-to-stream methods. Removes from the head of the stream. Note: If the input array is NULL, the array will be allocated internally and the calling application is responsible for properly de-allocating it. If the input array is not NULL, it is expected to match the size of the data internally, and this method would just fill in the data.

void vtkMultiProcessStream::Pop ( vtkTypeInt64 *&  array,
unsigned int &  size 
)

Remove-array-to-stream methods. Removes from the head of the stream. Note: If the input array is NULL, the array will be allocated internally and the calling application is responsible for properly de-allocating it. If the input array is not NULL, it is expected to match the size of the data internally, and this method would just fill in the data.

void vtkMultiProcessStream::Pop ( vtkTypeUInt64 *&  array,
unsigned int &  size 
)

Remove-array-to-stream methods. Removes from the head of the stream. Note: If the input array is NULL, the array will be allocated internally and the calling application is responsible for properly de-allocating it. If the input array is not NULL, it is expected to match the size of the data internally, and this method would just fill in the data.

void vtkMultiProcessStream::Reset ( )

Clears everything in the stream.

int vtkMultiProcessStream::Size ( )

Returns the size of the stream.

int vtkMultiProcessStream::RawSize ( )
inline

Returns the size of the raw data returned by GetRawData. This includes 1 byte to store the endian type.

Definition at line 119 of file vtkMultiProcessStream.h.

bool vtkMultiProcessStream::Empty ( )

Returns true iff the stream is empty.

void vtkMultiProcessStream::GetRawData ( std::vector< unsigned char > &  data) const

Serialization methods used to save/restore the stream to/from raw data. Note: The 1st byte of the raw data buffer consists of the endian type.

void vtkMultiProcessStream::GetRawData ( unsigned char *&  data,
unsigned int &  size 
)

Serialization methods used to save/restore the stream to/from raw data. Note: The 1st byte of the raw data buffer consists of the endian type.

void vtkMultiProcessStream::SetRawData ( const std::vector< unsigned char > &  data)

Serialization methods used to save/restore the stream to/from raw data. Note: The 1st byte of the raw data buffer consists of the endian type.

void vtkMultiProcessStream::SetRawData ( const unsigned char *  ,
unsigned int  size 
)

Serialization methods used to save/restore the stream to/from raw data. Note: The 1st byte of the raw data buffer consists of the endian type.

The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.9.1