SloughingCellKiller< DIM > Class Template Reference

#include <SloughingCellKiller.hpp>

Inherits AbstractCellKiller< DIM >.

Collaboration diagram for SloughingCellKiller< DIM >:

[legend]

List of all members.

Public Member Functions
	SloughingCellKiller (AbstractTissue< DIM > *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

template<unsigned DIM>
class SloughingCellKiller< DIM >

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

The crypt width and height is taken from the TissueConfig 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 45 of file SloughingCellKiller.hpp.

---

Constructor & Destructor Documentation

template<unsigned DIM>

SloughingCellKiller< DIM >::SloughingCellKiller	(	AbstractTissue< DIM > *	pCrypt,
		bool	sloughSides = false
	)			[inline]

Default constructor.

Parameters:

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

Definition at line 32 of file SloughingCellKiller.cpp.

---

Member Function Documentation

template<unsigned DIM>

bool SloughingCellKiller< DIM >::GetSloughSides

(

)

const [inline]

Returns:

mSloughSides.

Definition at line 39 of file SloughingCellKiller.cpp.

References SloughingCellKiller< DIM >::mSloughSides.

template<unsigned DIM>

template<class Archive >

void SloughingCellKiller< 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:

	archive	the archive
	version	the current version of this class

Reimplemented from AbstractCellKiller< DIM >.

Definition at line 66 of file SloughingCellKiller.hpp.

References TissueConfig::Instance().

template<unsigned DIM>

void SloughingCellKiller< DIM >::TestAndLabelCellsForApoptosisOrDeath

(

)

[inline, virtual]

Loops over cells and kills cells outside boundary.

Implements AbstractCellKiller< DIM >.

Definition at line 45 of file SloughingCellKiller.cpp.

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

---

Friends And Related Function Documentation

template<unsigned DIM>

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

Needed for serialization.

Reimplemented from AbstractCellKiller< DIM >.

Definition at line 53 of file SloughingCellKiller.hpp.

---

Member Data Documentation

template<unsigned DIM>

bool SloughingCellKiller< DIM >::mSloughSides [private]

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

Definition at line 50 of file SloughingCellKiller.hpp.

Referenced by SloughingCellKiller< DIM >::GetSloughSides(), and SloughingCellKiller< DIM >::TestAndLabelCellsForApoptosisOrDeath().

---

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

• /tmp/release_2.0/cell_based/src/crypt/killers/SloughingCellKiller.hpp
• /tmp/release_2.0/cell_based/src/crypt/killers/SloughingCellKiller.cpp