AbstractSimpleCellCycleModel Class Reference

#include <AbstractSimpleCellCycleModel.hpp>

Inheritance diagram for AbstractSimpleCellCycleModel:

Collaboration diagram for AbstractSimpleCellCycleModel:

List of all members.

Public Member Functions

AbstractSimpleCellCycleModel ()

virtual ~AbstractSimpleCellCycleModel ()

virtual void ResetForDivision ()

virtual void UpdateCellCyclePhase ()

void InitialiseDaughterCell ()

virtual void Initialise ()

virtual void OutputCellCycleModelParameters (out_stream &rParamsFile)

Protected Member Functions

virtual void SetG1Duration ()

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' cell-cycle models

i.e. models where 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.

N.B. Whether or not the cell should actually divide may still depend on Wnt / Oxygen etc. in subclasses...

Definition at line 46 of file AbstractSimpleCellCycleModel.hpp.

Constructor & Destructor Documentation

AbstractSimpleCellCycleModel::AbstractSimpleCellCycleModel ( )

Default constructor - creates an AbstractSimpleCellCycleModel.

Definition at line 31 of file AbstractSimpleCellCycleModel.cpp.

AbstractSimpleCellCycleModel::~AbstractSimpleCellCycleModel ( ) [virtual]

Default destructor.

Definition at line 35 of file AbstractSimpleCellCycleModel.cpp.

Member Function Documentation

template<class Archive>

void AbstractSimpleCellCycleModel::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 AbstractCellCycleModel.

Reimplemented in AbstractSimpleGenerationBasedCellCycleModel, FixedDurationGenerationBasedCellCycleModel, SimpleOxygenBasedCellCycleModel, StochasticDurationGenerationBasedCellCycleModel, StochasticOxygenBasedCellCycleModel, SimpleWntCellCycleModel, and SingleOdeWntCellCycleModel.

Definition at line 59 of file AbstractSimpleCellCycleModel.hpp.

void AbstractSimpleCellCycleModel::SetG1Duration ( ) [protected, virtual]

Subclasses can override this function if they wish, this just allocates the default values for each of the different cell types' G1 durations as defined in AbstractCellCycleModel.

Reimplemented in StochasticDurationGenerationBasedCellCycleModel, and SimpleWntCellCycleModel.

Definition at line 50 of file AbstractSimpleCellCycleModel.cpp.

References AbstractCellCycleModel::GetStemCellG1Duration(), AbstractCellCycleModel::GetTransitCellG1Duration(), AbstractCellCycleModel::mCellProliferativeType, AbstractCellCycleModel::mG1Duration, AbstractCellCycleModel::mpCell, and NEVER_REACHED.

Referenced by Initialise(), InitialiseDaughterCell(), and ResetForDivision().

void AbstractSimpleCellCycleModel::ResetForDivision ( ) [virtual]

See AbstractCellCycleModel::ResetForDivision()

Reimplemented from AbstractCellCycleModel.

Reimplemented in AbstractSimpleGenerationBasedCellCycleModel, and StochasticOxygenBasedCellCycleModel.

Definition at line 70 of file AbstractSimpleCellCycleModel.cpp.

References SimulationTime::GetTime(), SimulationTime::Instance(), AbstractCellCycleModel::mBirthTime, AbstractCellCycleModel::ResetForDivision(), and SetG1Duration().

Referenced by StochasticOxygenBasedCellCycleModel::ResetForDivision(), and AbstractSimpleGenerationBasedCellCycleModel::ResetForDivision().

void AbstractSimpleCellCycleModel::UpdateCellCyclePhase ( ) [virtual]

Default UpdateCellCyclePhase() method for a simple cell-cycle model.

Can be overridden if they should do something more subtle.

Implements AbstractCellCycleModel.

Reimplemented in SimpleOxygenBasedCellCycleModel, SimpleWntCellCycleModel, and SingleOdeWntCellCycleModel.

Definition at line 77 of file AbstractSimpleCellCycleModel.cpp.

References AbstractCellCycleModel::GetAge(), AbstractCellCycleModel::GetG2Duration(), AbstractCellCycleModel::GetMDuration(), AbstractCellCycleModel::GetSDuration(), AbstractCellCycleModel::mCellProliferativeType, AbstractCellCycleModel::mCurrentCellCyclePhase, and AbstractCellCycleModel::mG1Duration.

Referenced by SingleOdeWntCellCycleModel::UpdateCellCyclePhase(), SimpleWntCellCycleModel::UpdateCellCyclePhase(), and SimpleOxygenBasedCellCycleModel::UpdateCellCyclePhase().

void AbstractSimpleCellCycleModel::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 AbstractCellCycleModel.

Reimplemented in AbstractSimpleGenerationBasedCellCycleModel, StochasticOxygenBasedCellCycleModel, and SimpleWntCellCycleModel.

Definition at line 44 of file AbstractSimpleCellCycleModel.cpp.

References AbstractCellCycleModel::InitialiseDaughterCell(), and SetG1Duration().

Referenced by SimpleWntCellCycleModel::InitialiseDaughterCell(), StochasticOxygenBasedCellCycleModel::InitialiseDaughterCell(), and AbstractSimpleGenerationBasedCellCycleModel::InitialiseDaughterCell().

void AbstractSimpleCellCycleModel::Initialise ( void ) [virtual]

See AbstractCellCycleModel::Initialise()

Reimplemented from AbstractCellCycleModel.

Reimplemented in StochasticOxygenBasedCellCycleModel, and SingleOdeWntCellCycleModel.

Definition at line 39 of file AbstractSimpleCellCycleModel.cpp.

References SetG1Duration().

Referenced by SingleOdeWntCellCycleModel::Initialise(), and StochasticOxygenBasedCellCycleModel::Initialise().

void AbstractSimpleCellCycleModel::OutputCellCycleModelParameters ( out_stream & rParamsFile ) [virtual]

Outputs cell cycle model parameters to file.

Parameters:

rParamsFile

the file stream to which the parameters are output

Implements AbstractCellCycleModel.

Reimplemented in AbstractSimpleGenerationBasedCellCycleModel, FixedDurationGenerationBasedCellCycleModel, SimpleOxygenBasedCellCycleModel, StochasticDurationGenerationBasedCellCycleModel, StochasticOxygenBasedCellCycleModel, SimpleWntCellCycleModel, and SingleOdeWntCellCycleModel.

Definition at line 104 of file AbstractSimpleCellCycleModel.cpp.

References AbstractCellCycleModel::OutputCellCycleModelParameters().

Referenced by SimpleWntCellCycleModel::OutputCellCycleModelParameters(), SimpleOxygenBasedCellCycleModel::OutputCellCycleModelParameters(), and AbstractSimpleGenerationBasedCellCycleModel::OutputCellCycleModelParameters().

Friends And Related Function Documentation

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

Needed for serialization.

Reimplemented from AbstractCellCycleModel.

Reimplemented in AbstractSimpleGenerationBasedCellCycleModel, FixedDurationGenerationBasedCellCycleModel, SimpleOxygenBasedCellCycleModel, StochasticDurationGenerationBasedCellCycleModel, StochasticOxygenBasedCellCycleModel, SimpleWntCellCycleModel, and SingleOdeWntCellCycleModel.

Definition at line 51 of file AbstractSimpleCellCycleModel.hpp.

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

cell_based/src/population/cell/cycle/AbstractSimpleCellCycleModel.hpp
cell_based/src/population/cell/cycle/AbstractSimpleCellCycleModel.cpp


Public Member Functions
	AbstractSimpleCellCycleModel ()
virtual	~AbstractSimpleCellCycleModel ()
virtual void	ResetForDivision ()
virtual void	UpdateCellCyclePhase ()
void	InitialiseDaughterCell ()
virtual void	Initialise ()
virtual void	OutputCellCycleModelParameters (out_stream &rParamsFile)
Protected Member Functions
virtual void	SetG1Duration ()
Private Member Functions
template<class Archive>
void	serialize (Archive &archive, const unsigned int version)
Friends
class	boost::serialization::access