ApoptoticCellKiller< SPACE_DIM > Class Template Reference

#include <ApoptoticCellKiller.hpp>

Inheritance diagram for ApoptoticCellKiller< SPACE_DIM >:

Collaboration diagram for ApoptoticCellKiller< SPACE_DIM >:

Public Member Functions
	ApoptoticCellKiller (AbstractCellPopulation< SPACE_DIM > *pCellPopulation)
void	CheckAndLabelSingleCellForApoptosis (CellPtr pCell)
virtual void	CheckAndLabelCellsForApoptosisOrDeath ()
void	OutputCellKillerParameters (out_stream &rParamsFile)
Public Member Functions inherited from AbstractCellKiller< SPACE_DIM >
	AbstractCellKiller (AbstractCellPopulation< SPACE_DIM > *pCellPopulation)
virtual	~AbstractCellKiller ()
const AbstractCellPopulation< SPACE_DIM > *	GetCellPopulation () const
void	OutputCellKillerInfo (out_stream &rParamsFile)
Public Member Functions inherited from Identifiable
virtual	~Identifiable ()
std::string	GetIdentifier () const

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

Friends
class	boost::serialization::access

Additional Inherited Members
Protected Attributes inherited from AbstractCellKiller< SPACE_DIM >
AbstractCellPopulation< SPACE_DIM > *	mpCellPopulation

Detailed Description

template<unsigned SPACE_DIM>
class ApoptoticCellKiller< SPACE_DIM >

A cell killer object that kills cells that have been specified using the ApoptoticCellProperty.

Definition at line 48 of file ApoptoticCellKiller.hpp.

Constructor & Destructor Documentation

template<unsigned SPACE_DIM>

ApoptoticCellKiller< SPACE_DIM >::ApoptoticCellKiller

(

AbstractCellPopulation< SPACE_DIM > *

pCellPopulation

)

Constructor.

Parameters

pCellPopulation

pointer to the cell population.

Definition at line 40 of file ApoptoticCellKiller.cpp.

Referenced by ApoptoticCellKiller< SPACE_DIM >::serialize().

Member Function Documentation

template<unsigned SPACE_DIM>

void ApoptoticCellKiller< SPACE_DIM >::CheckAndLabelCellsForApoptosisOrDeath ( )

virtual

Loop over cells and call CheckAndLabelSingleCellForApoptosis() on each cell.

Implements AbstractCellKiller< SPACE_DIM >.

Definition at line 55 of file ApoptoticCellKiller.cpp.

References AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::Begin(), ApoptoticCellKiller< SPACE_DIM >::CheckAndLabelSingleCellForApoptosis(), AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::End(), and AbstractCellKiller< SPACE_DIM >::mpCellPopulation.

Referenced by ApoptoticCellKiller< SPACE_DIM >::serialize().

template<unsigned SPACE_DIM>

void ApoptoticCellKiller< SPACE_DIM >::CheckAndLabelSingleCellForApoptosis

(

CellPtr

pCell

)

Starts apoptosis if the cell has been given the ApoptoticCellProperty.

Parameters

pCell

the cell to test for apoptosis.

Definition at line 46 of file ApoptoticCellKiller.cpp.

Referenced by ApoptoticCellKiller< SPACE_DIM >::CheckAndLabelCellsForApoptosisOrDeath(), and ApoptoticCellKiller< SPACE_DIM >::serialize().

template<unsigned DIM>

void ApoptoticCellKiller< DIM >::OutputCellKillerParameters ( out_stream &  rParamsFile )

virtual

Overridden OutputCellKillerParameters() method.

Parameters

rParamsFile

the file stream to which the parameters are output

Implements AbstractCellKiller< SPACE_DIM >.

Definition at line 66 of file ApoptoticCellKiller.cpp.

References EXPORT_TEMPLATE_CLASS_SAME_DIMS, and AbstractCellKiller< SPACE_DIM >::OutputCellKillerParameters().

Referenced by ApoptoticCellKiller< SPACE_DIM >::serialize().

template<unsigned SPACE_DIM>

template<class Archive >

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

inlineprivate

Boost Serialization method for archiving/checkpointing. Archives the object and its member variables.

Parameters

archive	The boost archive.
version	The current version of this class.

Definition at line 61 of file ApoptoticCellKiller.hpp.

References ApoptoticCellKiller< SPACE_DIM >::ApoptoticCellKiller(), ApoptoticCellKiller< SPACE_DIM >::CheckAndLabelCellsForApoptosisOrDeath(), ApoptoticCellKiller< SPACE_DIM >::CheckAndLabelSingleCellForApoptosis(), EXPORT_TEMPLATE_CLASS_SAME_DIMS, AbstractCellKiller< SPACE_DIM >::GetCellPopulation(), and ApoptoticCellKiller< SPACE_DIM >::OutputCellKillerParameters().

---

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

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