AbstractCellKiller< SPACE_DIM > Class Template Reference

#include <AbstractCellKiller.hpp>

Inheritance diagram for AbstractCellKiller< SPACE_DIM >:

Inheritance graph
[legend]
Collaboration diagram for AbstractCellKiller< SPACE_DIM >:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 AbstractCellKiller (AbstractTissue< SPACE_DIM > *pTissue)
virtual ~AbstractCellKiller ()
virtual void TestAndLabelCellsForApoptosisOrDeath ()=0
const AbstractTissue< SPACE_DIM > * GetTissue () const

Protected Attributes

AbstractTissue< SPACE_DIM > * mpTissue

Private Member Functions

template<class Archive>
void serialize (Archive &archive, const unsigned int version)

Friends

class boost::serialization::access


Detailed Description

template<unsigned SPACE_DIM>
class AbstractCellKiller< SPACE_DIM >

An abstract cell killer class.

Definition at line 41 of file AbstractCellKiller.hpp.


Constructor & Destructor Documentation

template<unsigned SPACE_DIM>
AbstractCellKiller< SPACE_DIM >::AbstractCellKiller ( AbstractTissue< SPACE_DIM > *  pTissue  )  [inline]

Constructor.

Parameters:
pTissue pointer to the tissue.

Definition at line 95 of file AbstractCellKiller.hpp.

template<unsigned SPACE_DIM>
virtual AbstractCellKiller< SPACE_DIM >::~AbstractCellKiller (  )  [inline, virtual]

Destructor.

Definition at line 55 of file AbstractCellKiller.hpp.


Member Function Documentation

template<unsigned SPACE_DIM>
virtual void AbstractCellKiller< SPACE_DIM >::TestAndLabelCellsForApoptosisOrDeath (  )  [pure virtual]

Pure method which should call StartApoptosis() on any cell which should be about to undergo programmed death, or Kill() on any cell which should die immediately.

Implemented in RandomCellKiller< DIM >, and SloughingCellKiller< DIM >.

template<unsigned SPACE_DIM>
const AbstractTissue< SPACE_DIM > * AbstractCellKiller< SPACE_DIM >::GetTissue (  )  const [inline]

Get a pointer to the tissue.

Returns:
A const pointer to the mpTissue

Definition at line 101 of file AbstractCellKiller.hpp.

References AbstractCellKiller< SPACE_DIM >::mpTissue.

template<unsigned SPACE_DIM>
template<class Archive>
void AbstractCellKiller< SPACE_DIM >::serialize ( Archive &  archive,
const unsigned int  version 
) [inline, private]

Serialize the object and its member variables.

Parameters:
archive the archive
version the current version of this class

Reimplemented in RandomCellKiller< DIM >, and SloughingCellKiller< DIM >.

Definition at line 87 of file AbstractCellKiller.hpp.


Friends And Related Function Documentation

template<unsigned SPACE_DIM>
friend class boost::serialization::access [friend]

Needed for serialization.

Reimplemented in RandomCellKiller< DIM >, and SloughingCellKiller< DIM >.

Definition at line 79 of file AbstractCellKiller.hpp.


Member Data Documentation

template<unsigned SPACE_DIM>
AbstractTissue<SPACE_DIM>* AbstractCellKiller< SPACE_DIM >::mpTissue [protected]

The tissue.

Definition at line 74 of file AbstractCellKiller.hpp.

Referenced by AbstractCellKiller< SPACE_DIM >::GetTissue().


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

Generated on Tue Aug 4 16:10:35 2009 for Chaste by  doxygen 1.5.5