RandomCellKiller< DIM > Class Template Reference

#include <RandomCellKiller.hpp>

Collaboration diagram for RandomCellKiller< DIM >:

Public Member Functions
	RandomCellKiller (AbstractTissue< DIM > *pTissue, double probabilityOfDeathInAnHour)
double	GetDeathProbabilityInAnHour () const
void	TestAndLabelSingleCellForApoptosis (TissueCell &rCell)
void	TestAndLabelCellsForApoptosisOrDeath ()
Private Member Functions
template<class Archive >
void	serialize (Archive &archive, const unsigned int version)
Private Attributes
double	mProbabilityOfDeathInAnHour
Friends
class	boost::serialization::access

Detailed Description

template<unsigned DIM>
class RandomCellKiller< DIM >

A cell killer that randomly kills cells based on the user set probability.

The probability passed into the constructor will be the probability of any cell dying whenever TestAndLabelCellsForApoptosis() is called.

Note this does take into account timesteps - the input probability is the probability that in an hour's worth of trying, the cell killer will have successfully killed a given cell. In the method TestAndLabelSingleCellForApoptosis() this probability is used to calculate the probability that the cell is killed at a given time step.

Definition at line 51 of file RandomCellKiller.hpp.

Constructor & Destructor Documentation

template<unsigned DIM>

RandomCellKiller< DIM >::RandomCellKiller	(	AbstractTissue< DIM > *	pTissue,
		double	probabilityOfDeathInAnHour
	)			`[inline]`

Default constructor.

Parameters:

	pTissue	pointer to the tissue
	probabilityOfDeathInAnHour	probability that a cell is labelled for apoptosis in one hour's worth of trying

Definition at line 32 of file RandomCellKiller.cpp.

References RandomCellKiller< DIM >::mProbabilityOfDeathInAnHour.

Member Function Documentation

template<unsigned DIM>

double RandomCellKiller< DIM >::GetDeathProbabilityInAnHour ( ) const [inline]

Returns:: mProbabilityOfDeathInAnHour.

Definition at line 43 of file RandomCellKiller.cpp.

References RandomCellKiller< DIM >::mProbabilityOfDeathInAnHour.

template<unsigned DIM>

template<class Archive >

void RandomCellKiller< DIM >::serialize	(	Archive &	archive,
		const unsigned int	version
	)			`[inline, private]`

Archive the object and its member variables.

Serialization of singleton objects must be done with care. Before the object is serialized via a pointer, it *MUST* be serialized directly, or an assertion will trip when a second instance of the class is created on de-serialization.

Parameters: