AbstractCellKiller< SPACE_DIM > Class Template Reference

#include <AbstractCellKiller.hpp>

Inheritance diagram for AbstractCellKiller< SPACE_DIM >:

Collaboration diagram for AbstractCellKiller< SPACE_DIM >:

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
Public Member Functions inherited from Identifiable
virtual	~Identifiable ()
std::string	GetIdentifier () const

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 50 of file AbstractCellKiller.hpp.

Constructor & Destructor Documentation

template<unsigned SPACE_DIM>

AbstractCellKiller< SPACE_DIM >::AbstractCellKiller

(

AbstractCellPopulation< SPACE_DIM > *

pCellPopulation

)

Constructor.

Parameters

pCellPopulation

pointer 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 SloughingCellKiller< DIM >, RandomCellKiller< DIM >, PlaneBasedCellKiller< DIM >, TargetedCellKiller< DIM >, RadialSloughingCellKiller, T2SwapCellKiller< DIM >, ApoptoticCellKiller< SPACE_DIM >, and IsolatedLabelledCellKiller< 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

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

Referenced by AbstractCellKiller< DIM >::OutputCellKillerInfo(), ApoptoticCellKiller< SPACE_DIM >::OutputCellKillerParameters(), IsolatedLabelledCellKiller< DIM >::OutputCellKillerParameters(), T2SwapCellKiller< DIM >::OutputCellKillerParameters(), RadialSloughingCellKiller::OutputCellKillerParameters(), PlaneBasedCellKiller< DIM >::OutputCellKillerParameters(), TargetedCellKiller< DIM >::OutputCellKillerParameters(), RandomCellKiller< DIM >::OutputCellKillerParameters(), and SloughingCellKiller< DIM >::OutputCellKillerParameters().

template<unsigned SPACE_DIM>

template<class Archive >

void AbstractCellKiller< SPACE_DIM >::serialize ( Archive &  archive, const unsigned int  version  )

inlineprivate

Serialize the object and its member variables.

Parameters

archive	the archive
version	the current version of this class

Definition at line 62 of file AbstractCellKiller.hpp.

Friends And Related Function Documentation

template<unsigned SPACE_DIM>

friend class boost::serialization::access

friend

Needed for serialization.

Definition at line 54 of file AbstractCellKiller.hpp.

Member Data Documentation

template<unsigned SPACE_DIM>

AbstractCellPopulation<SPACE_DIM>* AbstractCellKiller< SPACE_DIM >::mpCellPopulation

protected

The cell population.

Definition at line 70 of file AbstractCellKiller.hpp.

---

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

• cell_based/src/population/killers/AbstractCellKiller.hpp
• cell_based/src/population/killers/AbstractCellKiller.cpp