AbstractSimpleGenerationBasedCellCycleModel Class Reference
#include <AbstractSimpleGenerationBasedCellCycleModel.hpp>
Inherits AbstractSimpleCellCycleModel.
Inherited by ExponentiallyDistributedStochasticDurationGenerationBasedCellCycleModel, FixedDurationGenerationBasedCellCycleModel, and StochasticDurationGenerationBasedCellCycleModel.
Public Member Functions | |
| AbstractSimpleGenerationBasedCellCycleModel () | |
| virtual | ~AbstractSimpleGenerationBasedCellCycleModel () |
| void | ResetForDivision () |
| void | InitialiseDaughterCell () |
| void | SetGeneration (unsigned generation) |
| unsigned | GetGeneration () const |
| void | SetMaxTransitGenerations (unsigned maxTransitGenerations) |
| unsigned | GetMaxTransitGenerations () const |
| virtual void | OutputCellCycleModelParameters (out_stream &rParamsFile) |
Protected Attributes | |
| unsigned | mGeneration |
| unsigned | mMaxTransitGenerations |
Private Member Functions | |
| template<class Archive > | |
| void | serialize (Archive &archive, const unsigned int version) |
Friends | |
| class | boost::serialization::access |
Detailed Description
This class contains all the things common to simple generation-based cell cycle models, i.e. models in which the length of cell cycle phases are determined when the cell-cycle model is created, rather than evaluated 'on the fly' by ODEs and suchlike, and in which each cell has a 'generation'.
N.B. Whether or not the cell should actually divide may depend on Wnt / Oxygen etc. in subclasses.
Definition at line 54 of file AbstractSimpleGenerationBasedCellCycleModel.hpp.
Constructor & Destructor Documentation
| AbstractSimpleGenerationBasedCellCycleModel::AbstractSimpleGenerationBasedCellCycleModel | ( | ) |
Default constructor - creates an AbstractSimpleCellCycleModel.
Definition at line 41 of file AbstractSimpleGenerationBasedCellCycleModel.cpp.
| AbstractSimpleGenerationBasedCellCycleModel::~AbstractSimpleGenerationBasedCellCycleModel | ( | ) | [virtual] |
Destructor.
Definition at line 48 of file AbstractSimpleGenerationBasedCellCycleModel.cpp.
Member Function Documentation
| unsigned AbstractSimpleGenerationBasedCellCycleModel::GetGeneration | ( | ) | const |
- Returns:
- the cell's generation.
Definition at line 110 of file AbstractSimpleGenerationBasedCellCycleModel.cpp.
References mGeneration.
| unsigned AbstractSimpleGenerationBasedCellCycleModel::GetMaxTransitGenerations | ( | ) | const |
- Returns:
- mMaxTransitGenerations
Definition at line 120 of file AbstractSimpleGenerationBasedCellCycleModel.cpp.
References mMaxTransitGenerations.
| void AbstractSimpleGenerationBasedCellCycleModel::InitialiseDaughterCell | ( | ) | [virtual] |
Set the new cell's G1 duration once it has been created after division. The duration will be based on cell type.
Reimplemented from AbstractSimpleCellCycleModel.
Definition at line 77 of file AbstractSimpleGenerationBasedCellCycleModel.cpp.
References mGeneration, mMaxTransitGenerations, and AbstractCellCycleModel::mpCell.
| void AbstractSimpleGenerationBasedCellCycleModel::OutputCellCycleModelParameters | ( | out_stream & | rParamsFile | ) | [virtual] |
Outputs cell cycle model parameters to file.
- Parameters:
-
rParamsFile the file stream to which the parameters are output
Reimplemented from AbstractSimpleCellCycleModel.
Reimplemented in DeltaNotchCellCycleModel, ExponentiallyDistributedStochasticDurationGenerationBasedCellCycleModel, FixedDurationGenerationBasedCellCycleModel, and StochasticDurationGenerationBasedCellCycleModel.
Definition at line 125 of file AbstractSimpleGenerationBasedCellCycleModel.cpp.
References mMaxTransitGenerations.
| void AbstractSimpleGenerationBasedCellCycleModel::ResetForDivision | ( | ) | [virtual] |
Overridden ResetForDivision() method.
Reimplemented from AbstractSimpleCellCycleModel.
Definition at line 52 of file AbstractSimpleGenerationBasedCellCycleModel.cpp.
References mGeneration, mMaxTransitGenerations, and AbstractCellCycleModel::mpCell.
| void AbstractSimpleGenerationBasedCellCycleModel::serialize | ( | Archive & | archive, | |
| const unsigned int | version | |||
| ) | [inline, private] |
Archive the cell-cycle model.
- Parameters:
-
archive the archive version the current version of this class
Reimplemented from AbstractSimpleCellCycleModel.
Reimplemented in DeltaNotchCellCycleModel, ExponentiallyDistributedStochasticDurationGenerationBasedCellCycleModel, FixedDurationGenerationBasedCellCycleModel, and StochasticDurationGenerationBasedCellCycleModel.
Definition at line 67 of file AbstractSimpleGenerationBasedCellCycleModel.hpp.
References mGeneration, and mMaxTransitGenerations.
| void AbstractSimpleGenerationBasedCellCycleModel::SetGeneration | ( | unsigned | generation | ) |
Sets the cell's generation.
- Parameters:
-
generation the cell's generation
Definition at line 105 of file AbstractSimpleGenerationBasedCellCycleModel.cpp.
References mGeneration.
Referenced by StochasticDurationGenerationBasedCellCycleModel::CreateCellCycleModel(), FixedDurationGenerationBasedCellCycleModel::CreateCellCycleModel(), ExponentiallyDistributedStochasticDurationGenerationBasedCellCycleModel::CreateCellCycleModel(), and DeltaNotchCellCycleModel::CreateCellCycleModel().
| void AbstractSimpleGenerationBasedCellCycleModel::SetMaxTransitGenerations | ( | unsigned | maxTransitGenerations | ) |
Set mMaxTransitGenerations.
- Parameters:
-
maxTransitGenerations the new value of mMaxTransitGenerations
Definition at line 115 of file AbstractSimpleGenerationBasedCellCycleModel.cpp.
References mMaxTransitGenerations.
Referenced by StochasticDurationGenerationBasedCellCycleModel::CreateCellCycleModel(), FixedDurationGenerationBasedCellCycleModel::CreateCellCycleModel(), ExponentiallyDistributedStochasticDurationGenerationBasedCellCycleModel::CreateCellCycleModel(), and DeltaNotchCellCycleModel::CreateCellCycleModel().
Friends And Related Function Documentation
friend class boost::serialization::access [friend] |
Needed for serialization.
Reimplemented from AbstractSimpleCellCycleModel.
Reimplemented in DeltaNotchCellCycleModel, ExponentiallyDistributedStochasticDurationGenerationBasedCellCycleModel, FixedDurationGenerationBasedCellCycleModel, and StochasticDurationGenerationBasedCellCycleModel.
Definition at line 59 of file AbstractSimpleGenerationBasedCellCycleModel.hpp.
Member Data Documentation
The generation of this cell (cells with a StemCellProliferativeType have a generation of 0)
Definition at line 77 of file AbstractSimpleGenerationBasedCellCycleModel.hpp.
Referenced by StochasticDurationGenerationBasedCellCycleModel::CreateCellCycleModel(), FixedDurationGenerationBasedCellCycleModel::CreateCellCycleModel(), ExponentiallyDistributedStochasticDurationGenerationBasedCellCycleModel::CreateCellCycleModel(), DeltaNotchCellCycleModel::CreateCellCycleModel(), GetGeneration(), InitialiseDaughterCell(), ResetForDivision(), serialize(), and SetGeneration().
How many generations a transit cell lives for before becoming fully differentiated.
Definition at line 80 of file AbstractSimpleGenerationBasedCellCycleModel.hpp.
Referenced by StochasticDurationGenerationBasedCellCycleModel::CreateCellCycleModel(), FixedDurationGenerationBasedCellCycleModel::CreateCellCycleModel(), ExponentiallyDistributedStochasticDurationGenerationBasedCellCycleModel::CreateCellCycleModel(), DeltaNotchCellCycleModel::CreateCellCycleModel(), GetMaxTransitGenerations(), InitialiseDaughterCell(), OutputCellCycleModelParameters(), ResetForDivision(), serialize(), and SetMaxTransitGenerations().
The documentation for this class was generated from the following files:
- cell_based/src/population/cell/cycle/AbstractSimpleGenerationBasedCellCycleModel.hpp
- cell_based/src/population/cell/cycle/AbstractSimpleGenerationBasedCellCycleModel.cpp
