CompuCell3D::CellType Class Reference

#include <CellType.h>

List of all members.

Public Member Functions

 CellType ()
unsigned char addTransition (Transition *transition)
Transition * getTransition (unsigned char id)
unsigned char update (const Point3D &pt, CellG *cell)

Private Attributes

BasicArray< Transition * > transitions

Detailed Description

Represents a cell type. In computer science terms we would call this cell state rather than type.

Definition at line 40 of file CellType.h.

Constructor & Destructor Documentation

CompuCell3D::CellType::CellType (  )  [inline]

Definition at line 45 of file CellType.h.

Member Function Documentation

unsigned char CompuCell3D::CellType::addTransition ( Transition *  transition  )  [inline]

Add a transition to another CellType

Parameters:
transition 
Returns:
The index or id of this transition.

Definition at line 54 of file CellType.h.

References transitions.

Referenced by CompuCell3D::ChickTypePlugin::init(), and CompuCell3D::ChickGrowthTypePlugin::init().

Transition* CompuCell3D::CellType::getTransition ( unsigned char  id  )  [inline]

This function will throw a BasicException if id is out of range.

Parameters:
id The Transition index or id.
Returns:
A pointer to the transition.

Definition at line 65 of file CellType.h.

References transitions.

unsigned char CellType::update ( const Point3D &  pt,
CellG *  cell 
)

Update cells state.

Parameters:
cell The cell to be updated.
Returns:
The new CellType id.

Definition at line 35 of file CellType.cpp.

References transitions, and CompuCell3D::CellG::type.

Referenced by CompuCell3D::Automaton::field3DChange().

Member Data Documentation

BasicArray<Transition *> CompuCell3D::CellType::transitions [private]

Definition at line 41 of file CellType.h.

Referenced by addTransition(), getTransition(), and update().

The documentation for this class was generated from the following files:
Generated on Thu Dec 4 11:41:52 2008 for CompuCell3D by  doxygen 1.5.6