SloughingCellKiller Class Reference

#include <SloughingCellKiller.hpp>

Inheritance diagram for SloughingCellKiller:

[legend]

Collaboration diagram for SloughingCellKiller:

[legend]

List of all members.

Public Member Functions
	SloughingCellKiller (AbstractTissue< 2 > *pCrypt, bool sloughSides=false)
bool	GetSloughSides () const
virtual void	TestAndLabelCellsForApoptosisOrDeath ()
Private Member Functions
template<class Archive>
void	serialize (Archive &archive, const unsigned int version)
Private Attributes
bool	mSloughSides
Friends
class	boost::serialization::access

---

Detailed Description

A cell killer that kills cells if they are outside the crypt.

The crypt width and height is taken from the cancer parameters singleton object. The crypt is assumed to start at x=0 and y=0. By default only cells are sloughed if y>crypt_height. To slough the sides call the constructor with the appropriate parameter.

Definition at line 44 of file SloughingCellKiller.hpp.

---

Constructor & Destructor Documentation

SloughingCellKiller::SloughingCellKiller	(	AbstractTissue< 2 > *	pCrypt,
		bool	sloughSides = false
	)

Default constructor.

Parameters:

	pCrypt	pointer to a tissue
	sloughSides	whether to slough cells at the side of the crypt

Definition at line 31 of file SloughingCellKiller.cpp.

---

Member Function Documentation

template<class Archive>

void SloughingCellKiller::serialize	(	Archive &	archive,
		const unsigned int	version
	)			[inline, private]

Archive the object and its member variables.

Parameters:

	archive
	version

Reimplemented from AbstractCellKiller< 2 >.

Definition at line 60 of file SloughingCellKiller.hpp.

References CancerParameters::Instance().

bool SloughingCellKiller::GetSloughSides

(

)

const

Returns:

mSloughSides.

Definition at line 38 of file SloughingCellKiller.cpp.

References mSloughSides.

void SloughingCellKiller::TestAndLabelCellsForApoptosisOrDeath

(

)

[virtual]

Loops over cells and kills cells outside boundary.

Implements AbstractCellKiller< 2 >.

Definition at line 44 of file SloughingCellKiller.cpp.

References AbstractTissue< DIM >::Begin(), AbstractTissue< DIM >::End(), CancerParameters::GetCryptLength(), CancerParameters::GetCryptWidth(), AbstractTissue< DIM >::GetLocationOfCellCentre(), CancerParameters::Instance(), AbstractCellKiller< 2 >::mpTissue, and mSloughSides.

---

Friends And Related Function Documentation

friend class boost::serialization::access [friend]

Needed for serialization.

Reimplemented from AbstractCellKiller< 2 >.

Definition at line 52 of file SloughingCellKiller.hpp.

---

Member Data Documentation

bool SloughingCellKiller::mSloughSides [private]

Whether cells should be sloughed from the sides of the crypt.

Definition at line 49 of file SloughingCellKiller.hpp.

Referenced by GetSloughSides(), and TestAndLabelCellsForApoptosisOrDeath().

---

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

• /tmp/release_1/cancer/src/tissue/killers/SloughingCellKiller.hpp
• /tmp/release_1/cancer/src/tissue/killers/SloughingCellKiller.cpp