Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members

CircularBuffer Class Reference

#include <CircularBuffer.h>

Inherits IFIFOBuffer.

Inheritance diagram for CircularBuffer:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 CircularBuffer (unsigned long inBufferSize)
virtual ~CircularBuffer (void)
virtual unsigned long read (unsigned char *outData, unsigned long inBytesToRead)
virtual unsigned long write (const unsigned char *inData, unsigned long inBytesToWrite)
virtual unsigned long numBytesAvail ()
virtual unsigned long spaceLeft ()
virtual void reset ()

Protected Member Functions

void bufASSERT (bool inBool)

Protected Attributes

unsigned long mBufferSize
unsigned long mReadPtr
unsigned long mWritePtr
unsigned char * mBuffer

Private Member Functions

CircularBufferoperator= (const CircularBuffer &other)
 CircularBuffer (const CircularBuffer &other)

Constructor & Destructor Documentation

CircularBuffer::CircularBuffer unsigned long  inBufferSize  ) 
 

CircularBuffer::~CircularBuffer void   )  [virtual]
 

CircularBuffer::CircularBuffer const CircularBuffer other  )  [private]
 


Member Function Documentation

void CircularBuffer::bufASSERT bool  inBool  )  [inline, protected]
 

unsigned long CircularBuffer::numBytesAvail  )  [virtual]
 

Implements IFIFOBuffer.

CircularBuffer& CircularBuffer::operator= const CircularBuffer other  )  [private]
 

unsigned long CircularBuffer::read unsigned char *  outData,
unsigned long  inBytesToRead
[virtual]
 

Implements IFIFOBuffer.

void CircularBuffer::reset  )  [virtual]
 

Implements IFIFOBuffer.

unsigned long CircularBuffer::spaceLeft  )  [virtual]
 

Implements IFIFOBuffer.

unsigned long CircularBuffer::write const unsigned char *  inData,
unsigned long  inBytesToWrite
[virtual]
 

Implements IFIFOBuffer.


Member Data Documentation

unsigned char* CircularBuffer::mBuffer [protected]
 

unsigned long CircularBuffer::mBufferSize [protected]
 

unsigned long CircularBuffer::mReadPtr [protected]
 

unsigned long CircularBuffer::mWritePtr [protected]
 


The documentation for this class was generated from the following files:
Generated on Fri Nov 5 22:34:07 2004 for oggdsf by  doxygen 1.3.9