Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
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

◆ TargetedCellKiller()

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

Default constructor.

Parameters
pCellPopulationpointer to the cell population
targetedIndexThe index of the cell to kill
bloodLustWether to kill cells or not defaults to true (used by load methods)

Definition at line 39 of file TargetedCellKiller.cpp.

Member Function Documentation

◆ CheckAndLabelCellsForApoptosisOrDeath()

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.

◆ GetBloodLust()

template<unsigned DIM>
unsigned TargetedCellKiller< DIM >::GetBloodLust ( ) const
Returns
mBloodLust.

Definition at line 53 of file TargetedCellKiller.cpp.

◆ GetTargetIndex()

template<unsigned DIM>
unsigned TargetedCellKiller< DIM >::GetTargetIndex ( ) const
Returns
mTargetIndex.

Definition at line 47 of file TargetedCellKiller.cpp.

◆ OutputCellKillerParameters()

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

Overridden OutputCellKillerParameters() method.

Parameters
rParamsFilethe file stream to which the parameters are output

Implements AbstractCellKiller< DIM >.

Definition at line 71 of file TargetedCellKiller.cpp.

References AbstractCellKiller< SPACE_DIM >::OutputCellKillerParameters().

◆ serialize()

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

Archive the object.

Parameters
archivethe archive
versionthe current version of this class

Definition at line 73 of file TargetedCellKiller.hpp.

Friends And Related Symbol Documentation

◆ boost::serialization::access

template<unsigned DIM>
friend class boost::serialization::access
friend

Needed for serialization.

Definition at line 65 of file TargetedCellKiller.hpp.

Member Data Documentation

◆ mBloodLust

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.

◆ mTargetIndex

template<unsigned DIM>
unsigned TargetedCellKiller< DIM >::mTargetIndex
private

The index of the cell to kill

Definition at line 56 of file TargetedCellKiller.hpp.


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