AbstractCellKiller< SPACE_DIM > Class Template Reference

#include <AbstractCellKiller.hpp>

Inherited by OxygenBasedCellKiller< SPACE_DIM >.

Collaboration diagram for AbstractCellKiller< SPACE_DIM >:

Public Member Functions
	AbstractCellKiller (AbstractCellPopulation< SPACE_DIM > *pCellPopulation)
virtual	~AbstractCellKiller ()
virtual void	TestAndLabelCellsForApoptosisOrDeath ()=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 42 of file AbstractCellKiller.hpp.

Constructor & Destructor Documentation

template<unsigned SPACE_DIM>

AbstractCellKiller< SPACE_DIM >::AbstractCellKiller ( AbstractCellPopulation< SPACE_DIM > * pCellPopulation ) [inline]

Constructor.

Parameters:

pCellPopulation

pointer to the cell population.

Definition at line 32 of file AbstractCellKiller.cpp.

template<unsigned SPACE_DIM>

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

Destructor.

Definition at line 38 of file AbstractCellKiller.cpp.

Member Function Documentation

template<unsigned SPACE_DIM>

const AbstractCellPopulation< SPACE_DIM > * AbstractCellKiller< SPACE_DIM >::GetCellPopulation ( ) const [inline]

Get a pointer to the cell population.

Returns:: A const pointer to the mpCellPopulation

Definition at line 43 of file AbstractCellKiller.cpp.

References AbstractCellKiller< SPACE_DIM >::mpCellPopulation.

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:

rParamsFile

the file stream to which the parameters are output

template<unsigned SPACE_DIM>

virtual void AbstractCellKiller< SPACE_DIM >::OutputCellKillerParameters ( out_stream & rParamsFile ) [pure virtual]

Outputs cell killer parameters to file

As this method is pure virtual, it must be overridden in subclasses.

Parameters:

rParamsFile

the file stream to which the parameters are output

Implemented in OxygenBasedCellKiller< SPACE_DIM >, PlaneBasedCellKiller< DIM >, RandomCellKiller< DIM >, TargetedCellKiller< DIM >, RadialSloughingCellKiller, and SloughingCellKiller< DIM >.

Referenced by AbstractCellKiller< DIM >::OutputCellKillerInfo().

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 OxygenBasedCellKiller< SPACE_DIM >, PlaneBasedCellKiller< DIM >, RandomCellKiller< DIM >, TargetedCellKiller< DIM >, RadialSloughingCellKiller, and SloughingCellKiller< DIM >.

Definition at line 54 of file AbstractCellKiller.hpp.

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 OxygenBasedCellKiller< SPACE_DIM >, PlaneBasedCellKiller< DIM >, RandomCellKiller< DIM >, TargetedCellKiller< DIM >, RadialSloughingCellKiller, and SloughingCellKiller< DIM >.