Chaste Release::3.1
AbstractCellKiller< SPACE_DIM > Class Template Reference

#include <AbstractCellKiller.hpp>

Inheritance diagram for AbstractCellKiller< SPACE_DIM >:
Collaboration diagram for AbstractCellKiller< SPACE_DIM >:

List of all members.

Public Member Functions

 AbstractCellKiller (AbstractCellPopulation< SPACE_DIM > *pCellPopulation)
virtual ~AbstractCellKiller ()
virtual void CheckAndLabelCellsForApoptosisOrDeath ()=0
const AbstractCellPopulation
< SPACE_DIM > * 
GetCellPopulation () const
void OutputCellKillerInfo (out_stream &rParamsFile)
virtual void OutputCellKillerParameters (out_stream &rParamsFile)=0

Protected Attributes

AbstractCellPopulation
< SPACE_DIM > * 
mpCellPopulation

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, for use in cell-based simulations.

Definition at line 49 of file AbstractCellKiller.hpp.


Constructor & Destructor Documentation

template<unsigned SPACE_DIM>
AbstractCellKiller< SPACE_DIM >::AbstractCellKiller ( AbstractCellPopulation< SPACE_DIM > *  pCellPopulation)

Constructor.

Parameters:
pCellPopulationpointer to the cell population.

Definition at line 39 of file AbstractCellKiller.cpp.

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

Destructor.

Definition at line 45 of file AbstractCellKiller.cpp.


Member Function Documentation

template<unsigned SPACE_DIM>
virtual void AbstractCellKiller< SPACE_DIM >::CheckAndLabelCellsForApoptosisOrDeath ( ) [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 ApoptoticCellKiller< SPACE_DIM >, PlaneBasedCellKiller< DIM >, RandomCellKiller< DIM >, TargetedCellKiller< DIM >, RadialSloughingCellKiller, and SloughingCellKiller< DIM >.

template<unsigned SPACE_DIM>
const AbstractCellPopulation< SPACE_DIM > * AbstractCellKiller< SPACE_DIM >::GetCellPopulation ( ) const

Get a pointer to the cell population.

Returns:
A const pointer to the mpCellPopulation

Definition at line 50 of file AbstractCellKiller.cpp.

template<unsigned SPACE_DIM>
void AbstractCellKiller< SPACE_DIM >::OutputCellKillerInfo ( out_stream &  rParamsFile)

Outputs cell killer used in the simulation to file and then calls OutputCellKillerParameters to output all relevant parameters.

Parameters:
rParamsFilethe file stream to which the parameters are output
template<unsigned SPACE_DIM>
virtual void AbstractCellKiller< SPACE_DIM >::OutputCellKillerParameters ( out_stream &  rParamsFile) [pure virtual]
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:
archivethe archive
versionthe current version of this class

Reimplemented in ApoptoticCellKiller< SPACE_DIM >, PlaneBasedCellKiller< DIM >, RandomCellKiller< DIM >, TargetedCellKiller< DIM >, RadialSloughingCellKiller, and SloughingCellKiller< DIM >.

Definition at line 61 of file AbstractCellKiller.hpp.


Friends And Related Function Documentation

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

Member Data Documentation

template<unsigned SPACE_DIM>
AbstractCellPopulation<SPACE_DIM>* AbstractCellKiller< SPACE_DIM >::mpCellPopulation [protected]

The cell population.

Definition at line 69 of file AbstractCellKiller.hpp.


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