Chaste Release::3.1
Public Member Functions | Protected Attributes | Private Member Functions | Friends
AbstractSimpleGenerationBasedCellCycleModel Class Reference

#include <AbstractSimpleGenerationBasedCellCycleModel.hpp>

Inheritance diagram for AbstractSimpleGenerationBasedCellCycleModel:
Collaboration diagram for AbstractSimpleGenerationBasedCellCycleModel:

List of all members.

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 38 of file AbstractSimpleGenerationBasedCellCycleModel.cpp.

AbstractSimpleGenerationBasedCellCycleModel::~AbstractSimpleGenerationBasedCellCycleModel ( ) [virtual]

Destructor.

Definition at line 45 of file AbstractSimpleGenerationBasedCellCycleModel.cpp.

Member Function Documentation

unsigned AbstractSimpleGenerationBasedCellCycleModel::GetGeneration ( ) const

Returns the cell's generation.

Definition at line 91 of file AbstractSimpleGenerationBasedCellCycleModel.cpp.

References mGeneration.

unsigned AbstractSimpleGenerationBasedCellCycleModel::GetMaxTransitGenerations ( ) const
Returns:
mMaxTransitGenerations

Definition at line 101 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 63 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:
rParamsFilethe file stream to which the parameters are output

Reimplemented from AbstractSimpleCellCycleModel.

Reimplemented in DeltaNotchCellCycleModel, FixedDurationGenerationBasedCellCycleModel, and StochasticDurationGenerationBasedCellCycleModel.

Definition at line 106 of file AbstractSimpleGenerationBasedCellCycleModel.cpp.

References mMaxTransitGenerations.

void AbstractSimpleGenerationBasedCellCycleModel::ResetForDivision ( ) [virtual]

Overridden ResetForDivision() method.

Reimplemented from AbstractSimpleCellCycleModel.

Definition at line 49 of file AbstractSimpleGenerationBasedCellCycleModel.cpp.

References mGeneration, mMaxTransitGenerations, and AbstractCellCycleModel::mpCell.

template<class Archive >
void AbstractSimpleGenerationBasedCellCycleModel::serialize ( Archive &  archive,
const unsigned int  version 
) [inline, private]

Archive the cell-cycle model.

Parameters:
archivethe archive
versionthe current version of this class

Reimplemented from AbstractSimpleCellCycleModel.

Reimplemented in DeltaNotchCellCycleModel, 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:
generationthe cell's generation

Definition at line 86 of file AbstractSimpleGenerationBasedCellCycleModel.cpp.

References mGeneration.

Referenced by StochasticDurationGenerationBasedCellCycleModel::CreateCellCycleModel(), FixedDurationGenerationBasedCellCycleModel::CreateCellCycleModel(), and DeltaNotchCellCycleModel::CreateCellCycleModel().

void AbstractSimpleGenerationBasedCellCycleModel::SetMaxTransitGenerations ( unsigned  maxTransitGenerations)

Set mMaxTransitGenerations.

Parameters:
maxTransitGenerationsthe new value of mMaxTransitGenerations

Definition at line 96 of file AbstractSimpleGenerationBasedCellCycleModel.cpp.

References mMaxTransitGenerations.

Referenced by StochasticDurationGenerationBasedCellCycleModel::CreateCellCycleModel(), FixedDurationGenerationBasedCellCycleModel::CreateCellCycleModel(), and DeltaNotchCellCycleModel::CreateCellCycleModel().

Friends And Related Function Documentation

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

Needed for serialization.

Reimplemented from AbstractSimpleCellCycleModel.

Reimplemented in DeltaNotchCellCycleModel, FixedDurationGenerationBasedCellCycleModel, and StochasticDurationGenerationBasedCellCycleModel.

Definition at line 59 of file AbstractSimpleGenerationBasedCellCycleModel.hpp.

Member Data Documentation

unsigned AbstractSimpleGenerationBasedCellCycleModel::mGeneration [protected]

The generation of this cell (STEM cells have a generation of 0)

Definition at line 77 of file AbstractSimpleGenerationBasedCellCycleModel.hpp.

Referenced by StochasticDurationGenerationBasedCellCycleModel::CreateCellCycleModel(), FixedDurationGenerationBasedCellCycleModel::CreateCellCycleModel(), DeltaNotchCellCycleModel::CreateCellCycleModel(), GetGeneration(), InitialiseDaughterCell(), ResetForDivision(), serialize(), and SetGeneration().

unsigned AbstractSimpleGenerationBasedCellCycleModel::mMaxTransitGenerations [protected]

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(), DeltaNotchCellCycleModel::CreateCellCycleModel(), GetMaxTransitGenerations(), InitialiseDaughterCell(), OutputCellCycleModelParameters(), ResetForDivision(), serialize(), and SetMaxTransitGenerations().

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