TargetedCellKiller< DIM > Class Template Reference

#include <TargetedCellKiller.hpp>

Inheritance diagram for TargetedCellKiller< DIM >:

Collaboration diagram for TargetedCellKiller< DIM >:

Public Member Functions
	TargetedCellKiller (AbstractCellPopulation< DIM > *pCellPopulation, unsigned targetedIndex, bool bloodLust=true)
unsigned	GetTargetIndex () const
unsigned	GetBloodLust () const
void	CheckAndLabelCellsForApoptosisOrDeath ()
void	OutputCellKillerParameters (out_stream &rParamsFile)
Public Member Functions inherited from AbstractCellKiller< 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)

Private Attributes
unsigned	mTargetIndex
bool	mBloodLust

Friends
class	boost::serialization::access

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

Detailed Description

template<unsigned DIM>
class TargetedCellKiller< DIM >

Simple cell killer, which at the first timestep kills any cell whose corresponding location index is a given number.

Definition at line 49 of file TargetedCellKiller.hpp.

Constructor & Destructor Documentation

template<unsigned DIM>

TargetedCellKiller< DIM >::TargetedCellKiller	(	AbstractCellPopulation< DIM > *	pCellPopulation,
		unsigned	targetedIndex,
		bool	bloodLust = true
	)

Default constructor.

Parameters

pCellPopulation	pointer to the cell population
targetedIndex	The index of the cell to kill
bloodLust	Wether to kill cells or not defaults to true (used by load methods)

Definition at line 39 of file TargetedCellKiller.cpp.

Referenced by TargetedCellKiller< DIM >::serialize().

Member Function Documentation

template<unsigned DIM>

void TargetedCellKiller< DIM >::CheckAndLabelCellsForApoptosisOrDeath ( )

virtual

Loop over cells and start apoptosis randomly, based on the user-set probability.

Implements AbstractCellKiller< DIM >.

Definition at line 59 of file TargetedCellKiller.cpp.

References AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetCellUsingLocationIndex(), AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetNumRealCells(), TargetedCellKiller< DIM >::mBloodLust, AbstractCellKiller< DIM >::mpCellPopulation, and TargetedCellKiller< DIM >::mTargetIndex.

Referenced by TargetedCellKiller< DIM >::serialize().

template<unsigned DIM>

unsigned TargetedCellKiller< DIM >::GetBloodLust

(

)

const

Returns

mBloodLust.

Definition at line 53 of file TargetedCellKiller.cpp.

References TargetedCellKiller< DIM >::mBloodLust.

Referenced by TargetedCellKiller< DIM >::serialize().

template<unsigned DIM>

unsigned TargetedCellKiller< DIM >::GetTargetIndex

(

)

const

Returns

mTargetIndex.

Definition at line 47 of file TargetedCellKiller.cpp.

References TargetedCellKiller< DIM >::mTargetIndex.

Referenced by TargetedCellKiller< DIM >::serialize().

template<unsigned DIM>

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

virtual

Overridden OutputCellKillerParameters() method.

Parameters

rParamsFile

the file stream to which the parameters are output

Implements AbstractCellKiller< DIM >.

Definition at line 70 of file TargetedCellKiller.cpp.

References EXPORT_TEMPLATE_CLASS_SAME_DIMS, TargetedCellKiller< DIM >::mBloodLust, TargetedCellKiller< DIM >::mTargetIndex, and AbstractCellKiller< SPACE_DIM >::OutputCellKillerParameters().

Referenced by TargetedCellKiller< DIM >::serialize().

template<unsigned DIM>

template<class Archive >

void TargetedCellKiller< DIM >::serialize ( Archive &  archive, const unsigned int  version  )

inlineprivate

Archive the object.

Parameters

archive	the archive
version	the current version of this class

Definition at line 73 of file TargetedCellKiller.hpp.

References TargetedCellKiller< DIM >::CheckAndLabelCellsForApoptosisOrDeath(), EXPORT_TEMPLATE_CLASS_SAME_DIMS, TargetedCellKiller< DIM >::GetBloodLust(), AbstractCellKiller< DIM >::GetCellPopulation(), TargetedCellKiller< DIM >::GetTargetIndex(), TargetedCellKiller< DIM >::OutputCellKillerParameters(), and TargetedCellKiller< DIM >::TargetedCellKiller().

Friends And Related Function Documentation

template<unsigned DIM>

friend class boost::serialization::access

friend

Needed for serialization.

Definition at line 65 of file TargetedCellKiller.hpp.

Member Data Documentation

template<unsigned DIM>

bool TargetedCellKiller< DIM >::mBloodLust

private

Variable to reack when the cell has been killed. Once the cell has been called mBloodLust will stop the killer killing more cells.

Definition at line 62 of file TargetedCellKiller.hpp.

Referenced by TargetedCellKiller< DIM >::CheckAndLabelCellsForApoptosisOrDeath(), TargetedCellKiller< DIM >::GetBloodLust(), and TargetedCellKiller< DIM >::OutputCellKillerParameters().

template<unsigned DIM>

unsigned TargetedCellKiller< DIM >::mTargetIndex

private

The index of the cell to kill

Definition at line 56 of file TargetedCellKiller.hpp.

Referenced by TargetedCellKiller< DIM >::CheckAndLabelCellsForApoptosisOrDeath(), TargetedCellKiller< DIM >::GetTargetIndex(), and TargetedCellKiller< DIM >::OutputCellKillerParameters().

---

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

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