#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) |
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 |
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< 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.
Member Function Documentation
| 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.
| unsigned TargetedCellKiller< DIM >::GetBloodLust | ( | ) | const |
- Returns:
- mBloodLust.
Definition at line 53 of file TargetedCellKiller.cpp.
| unsigned TargetedCellKiller< DIM >::GetTargetIndex | ( | ) | const |
- Returns:
- mTargetIndex.
Definition at line 47 of file TargetedCellKiller.cpp.
| 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 AbstractCellKiller< SPACE_DIM >::OutputCellKillerParameters().
| void TargetedCellKiller< DIM >::serialize | ( | Archive & | archive, |
| const unsigned int | version | ||
| ) | [inline, private] |
Archive the object.
- Parameters:
-
archive the archive version the current version of this class
Reimplemented from AbstractCellKiller< DIM >.
Definition at line 73 of file TargetedCellKiller.hpp.
Friends And Related Function Documentation
friend class boost::serialization::access [friend] |
Needed for serialization.
Reimplemented from AbstractCellKiller< DIM >.
Definition at line 65 of file TargetedCellKiller.hpp.
Member Data Documentation
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.
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:
- cell_based/src/population/killers/TargetedCellKiller.hpp
- cell_based/src/population/killers/TargetedCellKiller.cpp
