BasicClassGroupArray Class Reference

#include <BasicClassGroupArray.h>

Collaboration diagram for BasicClassGroupArray:

[legend]

List of all members.

Public Member Functions
unsigned int	create ()
void	destroy (const unsigned int id)
void	registerClass (BasicClassAccessorBase *accessor)
BasicClassGroup *	get (const unsigned int id) const
BasicClassGroup *	operator[] (const unsigned int id) const
unsigned int	getSize () const
Private Attributes
BasicArray< BasicClassGroup * >	groups
BasicClassGroupFactory	factory

---

Detailed Description

A BasicArray and a BasicClassGroupFactory wrapped together. Allocated BasicClassGroups are kept in an array. They can then be accessed or deleted using an id which is simply an array index.

Definition at line 38 of file BasicClassGroupArray.h.

---

Member Function Documentation

unsigned int BasicClassGroupArray::create

(

)

[inline]

Add a new BasicClassGroup to the end of the array.

Returns:

The id or index of the new class group.

Definition at line 49 of file BasicClassGroupArray.h.

References BasicClassGroupFactory::create(), factory, groups, and BasicArray< T >::put().

void BasicClassGroupArray::destroy

(

const unsigned int

id

)

[inline]

Destroy an instance of a class group. If the id is invalid unexpected behavior may occur.

Parameters:

id

The class group id.

Definition at line 59 of file BasicClassGroupArray.h.

References BasicClassGroupFactory::destroy(), and factory.

void BasicClassGroupArray::registerClass

(

BasicClassAccessorBase *

accessor

)

[inline]

Register a class with the group factory. See BasicClassGroupFactory::registerClass().

Parameters:

accessor

The class accessor.

Definition at line 69 of file BasicClassGroupArray.h.

References factory, and BasicClassGroupFactory::registerClass().

BasicClassGroup* BasicClassGroupArray::get

(

const unsigned int

id

)

const [inline]

If the id is invalid unexpected behavior may occur. See BasicClassGroupAccessor for information on how to access a class with in the group.

Parameters:

id

A valid class group id.

Returns:

A pointer to the class group.

Definition at line 82 of file BasicClassGroupArray.h.

References groups.

BasicClassGroup* BasicClassGroupArray::operator[]

(

const unsigned int

id

)

const [inline]

See BasicClassGroupArray::get()

Definition at line 87 of file BasicClassGroupArray.h.

References groups.

unsigned int BasicClassGroupArray::getSize

(

)

const [inline]

See BasicArray::getSize()

Returns:

The current size of the array.

Definition at line 94 of file BasicClassGroupArray.h.

References BasicArray< T >::getSize(), and groups.

---

Member Data Documentation

BasicArray<BasicClassGroup *> BasicClassGroupArray::groups [private]

Definition at line 39 of file BasicClassGroupArray.h.

Referenced by create(), get(), getSize(), and operator[]().

BasicClassGroupFactory BasicClassGroupArray::factory [private]

Definition at line 40 of file BasicClassGroupArray.h.

Referenced by create(), destroy(), and registerClass().

---

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

• CompuCell/DOXYGEN/core/BasicUtils/BasicClassGroupArray.h