VTK
Public Member Functions
vtkMultiProcessStream Class Reference

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

#include <vtkMultiProcessStream.h>

List of all members.

Public Member Functions

 vtkMultiProcessStream ()
 vtkMultiProcessStream (const vtkMultiProcessStream &)
 ~vtkMultiProcessStream ()
vtkMultiProcessStreamoperator= (const vtkMultiProcessStream &)
void Reset ()
int Size ()
bool Empty ()
vtkMultiProcessStreamoperator<< (double value)
vtkMultiProcessStreamoperator<< (float value)
vtkMultiProcessStreamoperator<< (int value)
vtkMultiProcessStreamoperator<< (char value)
vtkMultiProcessStreamoperator<< (unsigned int value)
vtkMultiProcessStreamoperator<< (unsigned char value)
vtkMultiProcessStreamoperator<< (vtkTypeInt64 value)
vtkMultiProcessStreamoperator<< (vtkTypeUInt64 value)
vtkMultiProcessStreamoperator<< (const std::string &value)
vtkMultiProcessStreamoperator<< (const vtkMultiProcessStream &)
vtkMultiProcessStreamoperator>> (double &value)
vtkMultiProcessStreamoperator>> (float &value)
vtkMultiProcessStreamoperator>> (int &value)
vtkMultiProcessStreamoperator>> (char &value)
vtkMultiProcessStreamoperator>> (unsigned int &value)
vtkMultiProcessStreamoperator>> (unsigned char &value)
vtkMultiProcessStreamoperator>> (vtkTypeInt64 &value)
vtkMultiProcessStreamoperator>> (vtkTypeUInt64 &value)
vtkMultiProcessStreamoperator>> (std::string &value)
vtkMultiProcessStreamoperator>> (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 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


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<< ( 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 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>> ( 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: the user must call delete on the array after processing it.

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

Remove-array-to-stream methods. Removes from the head of the stream. Note: the user must call delete on the array after processing it.

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

Remove-array-to-stream methods. Removes from the head of the stream. Note: the user must call delete on the array after processing it.

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

Remove-array-to-stream methods. Removes from the head of the stream. Note: the user must call delete on the array after processing it.

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

Remove-array-to-stream methods. Removes from the head of the stream. Note: the user must call delete on the array after processing it.

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

Remove-array-to-stream methods. Removes from the head of the stream. Note: the user must call delete on the array after processing it.

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

Remove-array-to-stream methods. Removes from the head of the stream. Note: the user must call delete on the array after processing it.

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

Remove-array-to-stream methods. Removes from the head of the stream. Note: the user must call delete on the array after processing it.

Clears everything in the stream.

Returns the size of the stream.

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: