Geddei::BufferDatas Class Reference
[Geddei's core classes.]

Array-like class for a collection of BufferData objects. More...

#include <bufferdatas.h>

Collaboration diagram for Geddei::BufferDatas:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 BufferDatas (const uint count=0)
 BufferDatas (const BufferDatas &src)
void copyData (const uint i, const BufferData &d)
const uint count () const
void nullify ()
BufferDatasoperator= (const BufferDatas &src)
BufferDataoperator[] (uint i)
const BufferDataoperator[] (uint i) const
void resize (const uint count)
BufferDatas samples (const uint index, const uint amount)
const BufferDatas samples (const uint index, const uint amount) const
void setData (const uint i, const BufferData *d)
const uint size () const

Friends

class SubProcessor

Detailed Description

Array-like class for a collection of BufferData objects.

Author:
Gav Wood <gav@cs.york.ac.uk>
This class is a simple, array-like class but has extensions for holding BufferData objects. This class will only be used publicly by SubProcessor developers, the needs of which are very limited. It however needs extensive utility methods for Geddei's internal use and as such most methods are for internal use only and therefore undocumented.

Don't let this worry you. Unless you're working on Geddei's core, you can completely ignore them and you'll really only need to use the array operator. The size() method has been left in too, just for fun.


Member Function Documentation

const BufferData& Geddei::BufferDatas::operator[] ( uint  i  )  const [inline]

Get a single BufferData from the array.

Parameters:
i The index to retrieve the BufferData object from.
Returns:
The BufferData object at position i .

BufferData& Geddei::BufferDatas::operator[] ( uint  i  )  [inline]

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Get a single BufferData from the array.

For notice of internal development: Don't be tempted to use this method to set the contents BufferDatas. Use setData() instead. It is only non-const for access to non-const methods of the returned BufferData. BufferDatas itself should be left unchanged.

Parameters:
i The index to retrieve the BufferData object from.
Returns:
The BufferData object at position i .

const uint Geddei::BufferDatas::size (  )  const [inline]

Get the number of BufferDatas objects stored.

Returns:
The number of slots for BufferData objects.

const uint Geddei::BufferDatas::count (  )  const [inline]

Get the number of BufferDatas objects stored.

Returns:
The number of slots for BufferData objects.


The documentation for this class was generated from the following files:
Generated on Thu Jul 13 06:56:39 2006 for Exscalibar by  doxygen 1.4.7