CCirBuf Class Reference

class CCirBuf : public CCirBufBase

A circular buffer containing objects of a type defined by the template parameter.

Inherits from

Constructor & Destructor Documentation

CCirBuf()

CCirBuf()[inline]

Default C++ constructor.

The size of each object in the buffer is fixed and is the length of the class passed as the template parameter.

panic
E32USER-CBase 72, if the length of the template class is zero.

Member Functions Documentation

Add(const T *)

TInt Add(const T *aPtr)[inline]

Adds a single object to the circular buffer.

The object is of type class T and is only added if there is space available.

panic
E32USER-CBase 74, if a call to CCirBufBase::SetLengthL() has not been made before calling this function.
CCirBufBase::SetLengthL

Parameters

const T * aPtrA pointer to the object of type class T to be added to the circular buffer.

Add(const T *, TInt)

TInt Add(const T *aPtr,
TIntaCount
)[inline]

Adds multiple objects to the circular buffer.

The function attempts to add aCount objects of type class T. The objects are only added if there is space available.

panic
E32USER-CBase 74, if a call to CCirBufBase::SetLengthL() has not been made before calling this function.
panic
E32USER-CBase 75, if aCount is not a positive value.
CCirBufBase::SetLengthL

Parameters

const T * aPtrA pointer to a set of contiguous objects of type class T to be added to the circular buffer.
TInt aCountThe number of objects to be added to the circular buffer.

Remove(T *)

TInt Remove(T *aPtr)[inline]

Removes a single object from the circular buffer.

An object can only be removed if there are objects in the buffer.

A binary copy of the object is made to aPtr.

Parameters

T * aPtrA pointer to an object of type class T supplied by the caller.

Remove(T *, TInt)

TInt Remove(T *aPtr,
TIntaCount
)[inline]

Removes multiple objects from the circular buffer.

The function attempts to remove aCount objects of type class T. Objects can only be removed if there are objects in the buffer

A binary copy of the objects is made to aPtr.

panic
E32USER-CBase 76, if aCount is not a positive value.

Parameters

T * aPtrA pointer to contiguous memory able to hold aCount class T objects, supplied by the caller.
TInt aCountThe number of objects to be removed from the circular buffer.