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 ()
 
vtkMultiProcessStreamoperator= (const vtkMultiProcessStream &)
 
vtkMultiProcessStreamoperator<< (double value)
 Add-to-stream operators. More...
 
vtkMultiProcessStreamoperator<< (float value)
 
vtkMultiProcessStreamoperator<< (int value)
 
vtkMultiProcessStreamoperator<< (char value)
 
vtkMultiProcessStreamoperator<< (bool value)
 
vtkMultiProcessStreamoperator<< (unsigned int value)
 
vtkMultiProcessStreamoperator<< (unsigned char value)
 
vtkMultiProcessStreamoperator<< (vtkTypeInt64 value)
 
vtkMultiProcessStreamoperator<< (vtkTypeUInt64 value)
 
vtkMultiProcessStreamoperator<< (const std::string &value)
 
vtkMultiProcessStreamoperator<< (const char *value)
 
vtkMultiProcessStreamoperator<< (const vtkMultiProcessStream &)
 
vtkMultiProcessStreamoperator>> (double &value)
 Remove-from-stream operators. More...
 
vtkMultiProcessStreamoperator>> (float &value)
 
vtkMultiProcessStreamoperator>> (int &value)
 
vtkMultiProcessStreamoperator>> (char &value)
 
vtkMultiProcessStreamoperator>> (bool &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)
 Add-array-to-stream methods. More...
 
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)
 Remove-array-to-stream methods. More...
 
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 ()
 Clears everything in the stream. More...
 
int Size ()
 Returns the size of the stream. More...
 
int RawSize ()
 Returns the size of the raw data returned by GetRawData. More...
 
bool Empty ()
 Returns true iff the stream is empty. More...
 
void GetRawData (std::vector< unsigned char > &data) const
 Serialization methods used to save/restore the stream to/from raw data. More...
 
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
 

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,

Definition at line 37 of file vtkMultiProcessStream.h.

Constructor & Destructor Documentation

◆ vtkMultiProcessStream() [1/2]

vtkMultiProcessStream::vtkMultiProcessStream ( )

◆ vtkMultiProcessStream() [2/2]

vtkMultiProcessStream::vtkMultiProcessStream ( const vtkMultiProcessStream )

◆ ~vtkMultiProcessStream()

vtkMultiProcessStream::~vtkMultiProcessStream ( )

Member Function Documentation

◆ operator=()

vtkMultiProcessStream& vtkMultiProcessStream::operator= ( const vtkMultiProcessStream )

◆ operator<<() [1/12]

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

Add-to-stream operators.

Adds to the end of the stream.

◆ operator<<() [2/12]

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

◆ operator<<() [3/12]

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

◆ operator<<() [4/12]

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

◆ operator<<() [5/12]

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

◆ operator<<() [6/12]

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

◆ operator<<() [7/12]

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

◆ operator<<() [8/12]

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

◆ operator<<() [9/12]

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

◆ operator<<() [10/12]

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

◆ operator<<() [11/12]

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

◆ operator<<() [12/12]

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

◆ operator>>() [1/11]

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

Remove-from-stream operators.

Removes from the head of the stream.

◆ operator>>() [2/11]

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

◆ operator>>() [3/11]

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

◆ operator>>() [4/11]

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

◆ operator>>() [5/11]

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

◆ operator>>() [6/11]

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

◆ operator>>() [7/11]

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

◆ operator>>() [8/11]

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

◆ operator>>() [9/11]

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

◆ operator>>() [10/11]

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

◆ operator>>() [11/11]

vtkMultiProcessStream& vtkMultiProcessStream::operator>> ( vtkMultiProcessStream )

◆ Push() [1/8]

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

Add-array-to-stream methods.

Adds to the end of the stream

◆ Push() [2/8]

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

◆ Push() [3/8]

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

◆ Push() [4/8]

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

◆ Push() [5/8]

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

◆ Push() [6/8]

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

◆ Push() [7/8]

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

◆ Push() [8/8]

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

◆ Pop() [1/8]

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 nullptr, the array will be allocated internally and the calling application is responsible for properly de-allocating it. If the input array is not nullptr, it is expected to match the size of the data internally, and this method would just fill in the data.

◆ Pop() [2/8]

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

◆ Pop() [3/8]

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

◆ Pop() [4/8]

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

◆ Pop() [5/8]

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

◆ Pop() [6/8]

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

◆ Pop() [7/8]

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

◆ Pop() [8/8]

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

◆ Reset()

void vtkMultiProcessStream::Reset ( )

Clears everything in the stream.

◆ Size()

int vtkMultiProcessStream::Size ( )

Returns the size of the stream.

◆ RawSize()

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 128 of file vtkMultiProcessStream.h.

◆ Empty()

bool vtkMultiProcessStream::Empty ( )

Returns true iff the stream is empty.

◆ GetRawData() [1/3]

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.

◆ GetRawData() [2/3]

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

◆ SetRawData() [1/2]

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

◆ SetRawData() [2/2]

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

◆ GetRawData() [3/3]

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

The documentation for this class was generated from the following file: