CLAM::PhantomBuffer< T > Class Template Reference

#include <PhantomBuffer.hxx>

List of all members.

Public Member Functions

 PhantomBuffer ()
T * Read (unsigned int pos, unsigned int size)
void Touch (unsigned int pos, unsigned int size)
 Updates the beginning or phantom zone corresponding with 'symetric' of the specifyed window /see UpdatePhantom.
void Write (unsigned int pos, unsigned int size, const T *data)
 Copies an array into the buffer and updates (touches) the 'repeated' data (beginning or phantom) /see Touch.
unsigned LogicalSize () const
unsigned int PhantomSize () const
void Resize (unsigned int size, unsigned int phantom, unsigned int insert_pos)
void FulfilsInvariant () const
 For debugging purposes.

Detailed Description

template<class T>
class CLAM::PhantomBuffer< T >

Definition at line 33 of file PhantomBuffer.hxx.


Constructor & Destructor Documentation

template<class T >
CLAM::PhantomBuffer< T >::PhantomBuffer (  )  [inline]

Definition at line 94 of file PhantomBuffer.hxx.


Member Function Documentation

template<class T >
void CLAM::PhantomBuffer< T >::FulfilsInvariant (  )  const [inline]

For debugging purposes.

Checks that: logical / phantom sizes are consistents and 'repeated' data is consistent /see Touch

Definition at line 202 of file PhantomBuffer.hxx.

References CLAM_ASSERT, and CLAM::PhantomBuffer< T >::PhantomSize().

template<class T>
unsigned CLAM::PhantomBuffer< T >::LogicalSize (  )  const [inline]

Definition at line 53 of file PhantomBuffer.hxx.

Referenced by CLAM::PhantomBuffer< T >::Resize().

template<class T>
unsigned int CLAM::PhantomBuffer< T >::PhantomSize (  )  const [inline]
template<class T >
T * CLAM::PhantomBuffer< T >::Read ( unsigned int  pos,
unsigned int  size 
) [inline]

Definition at line 152 of file PhantomBuffer.hxx.

References CLAM_DEBUG_ASSERT.

template<class T >
void CLAM::PhantomBuffer< T >::Resize ( unsigned int  size,
unsigned int  phantom,
unsigned int  insert_pos 
) [inline]
template<class T >
void CLAM::PhantomBuffer< T >::Touch ( unsigned int  pos,
unsigned int  size 
) [inline]

Updates the beginning or phantom zone corresponding with 'symetric' of the specifyed window /see UpdatePhantom.

Definition at line 161 of file PhantomBuffer.hxx.

References CLAM_DEBUG_ASSERT, and CLAM::PhantomBuffer< T >::PhantomSize().

Referenced by CLAM::PhantomBuffer< T >::Write().

template<class T>
void CLAM::PhantomBuffer< T >::Write ( unsigned int  pos,
unsigned int  size,
const T *  data 
) [inline]

Copies an array into the buffer and updates (touches) the 'repeated' data (beginning or phantom) /see Touch.

Definition at line 189 of file PhantomBuffer.hxx.

References CLAM_DEBUG_ASSERT, and CLAM::PhantomBuffer< T >::Touch().


The documentation for this class was generated from the following file:
Generated by  doxygen 1.6.3