Dune Core Modules (unstable)

Dune::MessageBufferIF< MessageBufferImp > Class Template Reference

Communication message buffer interface. This class describes the interface for reading and writing data to the communication message buffer. As message buffers might be deeply implemented in various packages the message buffers implementations cannot be derived from this interface class. Therefore we just apply the engine concept to wrap the message buffer call and make sure that the interface is fulfilled. More...

#include <dune/grid/common/datahandleif.hh>

Public Member Functions

 MessageBufferIF (MessageBufferImp &buff)
 stores reference to original buffer buff
 
template<class T >
void write (const T &val)
 just wraps the call of the internal buffer method write which writes the data of type T from the buffer by using the assigment operator of T More...
 
template<class T >
void read (T &val)
 just wraps the call of the internal buffer method read which reads the data of type T from the buffer by using the assigment operator of T More...
 

Detailed Description

template<class MessageBufferImp>
class Dune::MessageBufferIF< MessageBufferImp >

Communication message buffer interface. This class describes the interface for reading and writing data to the communication message buffer. As message buffers might be deeply implemented in various packages the message buffers implementations cannot be derived from this interface class. Therefore we just apply the engine concept to wrap the message buffer call and make sure that the interface is fulfilled.

Template Parameters
MessageBufferImpImplementation of message buffer used by the grids' communication method

Member Function Documentation

◆ read()

template<class MessageBufferImp >
template<class T >
void Dune::MessageBufferIF< MessageBufferImp >::read ( T &  val)
inline

just wraps the call of the internal buffer method read which reads the data of type T from the buffer by using the assigment operator of T

Parameters
valreference to object that is read

The method is not const, because calling it advances the iterator to the current data of the MessageBufferImp member.

◆ write()

template<class MessageBufferImp >
template<class T >
void Dune::MessageBufferIF< MessageBufferImp >::write ( const T &  val)
inline

just wraps the call of the internal buffer method write which writes the data of type T from the buffer by using the assigment operator of T

Parameters
valreference to object that is written

The documentation for this class was generated from the following file:
Creative Commons License   |  Legal Statements / Impressum  |  generated with Hugo v0.69.0 (Mar 1, 23:27, 2021)