Fennel: CircularBufferIter< T > Class Template Reference (original) (raw)

Iterator over a circular buffer. More...

#include <[CircularBuffer.h](CircularBuffer%5F8h-source.html)>

List of all members.

Public Member Functions
CircularBufferIter (CircularBuffer< T > *pCircularBufferInit)
void reset ()
Resets the iterator to the initial starting position.
void operator++ ()
Increments the iterator position.
T & operator * ()
**Returns:**reference to the entry at the current iterator position
bool end ()
**Returns:**true if the the iterator is positioned past the end of the buffer
bool done ()
**Returns:**true if all possible entries in the underlying buffer have been iterated over
uint getCurrPos ()
**Returns:**current position within the iterator
void setCurrPos (uint pos)
Sets the current position of the iterator.
void removeFront ()
Removes the first entry from the underlying circular buffer.
Private Attributes
CircularBuffer< T > * pCircularBuffer
Underlying circular buffer object.
uint currPos
Current position of this iterator within the underlying circular buffer.

Detailed Description

template

class CircularBufferIter< T >

Iterator over a circular buffer.

The iterator starts at the 0th position in the underlying circular buffer and always increases, even as positions in the underlying circular buffer are recycled.

Incrementing this iterator has not affect on the contents of the underlying buffer.

Definition at line 237 of file CircularBuffer.h.

Constructor & Destructor Documentation

Member Function Documentation

Returns:

reference to the entry at the current iterator position

Definition at line 278 of file CircularBuffer.h.

Member Data Documentation

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

Generated on Mon Jun 22 04:00:28 2009 for Fennel by doxygen 1.5.1