stk::CommBuffer Class Reference

List of all members.

Detailed Description

Definition at line 62 of file ParallelComm.hpp.

Public Member Functions

template<typename T>
CommBufferpack (const T &value)
 Pack a value to be sent: buf.pack<type>( value ).
template<typename T>
CommBufferpack (const T *value, size_t number)
 Pack an array of values to be sent: buf.pack<type>( ptr , num ).
template<typename T>
CommBufferunpack (T &value)
 Unpack a received value: buf.unpack<type>( value ).
template<typename T>
CommBufferunpack (T *value, size_t number)
 Unpack an array of received values: buf.unpack<type>( ptr , num ).
template<typename T>
CommBufferpeek (T &value)
 Peek at a received value (don't advance buffer): buf.peek<type>(value).
template<typename T>
CommBufferpeek (T *value, size_t number)
 Peek at an array of received values: buf.peek<type>( ptr , num ).
template<typename T>
CommBufferskip (size_t number)
 Skip buffer ahead by a number of values.
void reset ()
 Reset the buffer to the beginning so that size() == 0.
size_t capacity () const
 Size, in bytes, of the buffer.
size_t size () const
 Size, in bytes, of the buffer that has been processed.
ptrdiff_t remaining () const
 Size, in bytes, of the buffer remaining to be processed.
void * buffer () const
 Pointer to base of buffer.
 ~CommBuffer ()
 CommBuffer ()

Friends

class CommAll
class CommGather
class CommBroadcast


Member Function Documentation

size_t stk::CommBuffer::capacity (  )  const [inline]

Size, in bytes, of the buffer.

If the buffer is not yet allocated this is zero.

Definition at line 427 of file ParallelComm.hpp.

size_t stk::CommBuffer::size (  )  const [inline]

Size, in bytes, of the buffer that has been processed.

If the buffer is not yet allocated then this is the number of bytes that has been attempted to pack.

Definition at line 431 of file ParallelComm.hpp.

ptrdiff_t stk::CommBuffer::remaining (  )  const [inline]

Size, in bytes, of the buffer remaining to be processed.

Equal to 'capacity() - size()'. A negative result indicates either the buffer is not allocated or an overflow has occured. An overflow will have thrown an exception.

Definition at line 435 of file ParallelComm.hpp.


The documentation for this class was generated from the following files:
Generated on Tue Jul 13 09:27:33 2010 for Sierra Toolkit by  doxygen 1.4.7