List of all members | Public Member Functions
WriteBufferedTripleBuffer< T > Class Template Reference

Same as the TripleBuffer, but partial writes of the data structure are ok. The write operation may be a bit slower and memory consumption may be 1/3 higher. More...

#include <ArmarXCore/util/CPPUtility/TripleBuffer.h>

Public Member Functions

T & _getNonConstHiddenBuffer ()
 
T & _getNonConstHiddenWriteBuffer ()
 
T & _getNonConstReadBuffer ()
 
void commitWrite ()
 
const T & getReadBuffer () const
 
const T & getUpToDateReadBuffer () const
 
T & getWriteBuffer ()
 
const T & getWriteBuffer () const
 
void reinitAllBuffers (const T &init)
 
void setDebugMode (bool mode)
 
bool updateReadBuffer () const
 Swaps in the hidden buffer if it contains new data.
 
 WriteBufferedTripleBuffer ()
 
 WriteBufferedTripleBuffer (const T &init)
 

Detailed Description

template<typename T>
class armarx::WriteBufferedTripleBuffer< T >

Same as the TripleBuffer, but partial writes of the data structure are ok. The write operation may be a bit slower and memory consumption may be 1/3 higher.

See also
TripleBuffer

Constructor & Destructor Documentation

◆ WriteBufferedTripleBuffer() [1/2]

template<typename T>
WriteBufferedTripleBuffer ( )
inline

◆ WriteBufferedTripleBuffer() [2/2]

template<typename T>
WriteBufferedTripleBuffer ( const T & init)
inline

Member Function Documentation

◆ _getNonConstHiddenBuffer()

template<typename T>
T & _getNonConstHiddenBuffer ( )
inline
Returns
the current read buffer (sometimes required for more complex initialization)

◆ _getNonConstHiddenWriteBuffer()

template<typename T>
T & _getNonConstHiddenWriteBuffer ( )
inline
Returns
the current read buffer (sometimes required for more complex initialization)

◆ _getNonConstReadBuffer()

template<typename T>
T & _getNonConstReadBuffer ( )
inline
Returns
the current read buffer (sometimes required for more complex initialization)

◆ commitWrite()

template<typename T>
void commitWrite ( )
inline

◆ getReadBuffer()

template<typename T>
const T & getReadBuffer ( ) const
inline
Returns
the current read buffer

◆ getUpToDateReadBuffer()

template<typename T>
const T & getUpToDateReadBuffer ( ) const
inline
Returns
the most up to date read buffer

◆ getWriteBuffer() [1/2]

template<typename T>
T & getWriteBuffer ( )
inline
Returns
the write buffer

◆ getWriteBuffer() [2/2]

template<typename T>
const T & getWriteBuffer ( ) const
inline
Returns
the write buffer

◆ reinitAllBuffers()

template<typename T>
void reinitAllBuffers ( const T & init)
inline

◆ setDebugMode()

template<typename T>
void setDebugMode ( bool mode)
inline

◆ updateReadBuffer()

template<typename T>
bool updateReadBuffer ( ) const
inline

Swaps in the hidden buffer if it contains new data.

Returns
True if new data is available
The documentation for this class was generated from the following file: