Chaste  Release::3.4
Public Member Functions | Private Member Functions | Friends | List of all members
FixedDurationGenerationBasedCellCycleModel Class Reference

#include <FixedDurationGenerationBasedCellCycleModel.hpp>

+ Inheritance diagram for FixedDurationGenerationBasedCellCycleModel:
+ Collaboration diagram for FixedDurationGenerationBasedCellCycleModel:

Public Member Functions

 FixedDurationGenerationBasedCellCycleModel ()
 
AbstractCellCycleModel * CreateCellCycleModel ()
 
virtual void OutputCellCycleModelParameters (out_stream &rParamsFile)
 
- Public Member Functions inherited from AbstractSimpleGenerationBasedCellCycleModel
 AbstractSimpleGenerationBasedCellCycleModel ()
 
virtual ~AbstractSimpleGenerationBasedCellCycleModel ()
 
void ResetForDivision ()
 
void InitialiseDaughterCell ()
 
void SetGeneration (unsigned generation)
 
unsigned GetGeneration () const
 
void SetMaxTransitGenerations (unsigned maxTransitGenerations)
 
unsigned GetMaxTransitGenerations () const
 
- Public Member Functions inherited from AbstractSimpleCellCycleModel
 AbstractSimpleCellCycleModel ()
 
virtual ~AbstractSimpleCellCycleModel ()
 
virtual void UpdateCellCyclePhase ()
 
virtual void Initialise ()
 
- Public Member Functions inherited from AbstractCellCycleModel
 AbstractCellCycleModel ()
 
virtual ~AbstractCellCycleModel ()
 
void SetCell (CellPtr pCell)
 
CellPtr GetCell ()
 
virtual void SetBirthTime (double birthTime)
 
void SetDimension (unsigned dimension)
 
unsigned GetDimension ()
 
double GetBirthTime () const
 
double GetAge ()
 
virtual bool ReadyToDivide ()
 
CellCyclePhase GetCurrentCellCyclePhase ()
 
virtual double GetG1Duration ()
 
double GetStemCellG1Duration ()
 
double GetTransitCellG1Duration ()
 
double GetSG2MDuration ()
 
virtual double GetSDuration ()
 
virtual double GetG2Duration ()
 
virtual double GetMDuration ()
 
virtual void SetStemCellG1Duration (double stemCellG1Duration)
 
virtual void SetTransitCellG1Duration (double transitCellG1Duration)
 
void SetSDuration (double sDuration)
 
void SetG2Duration (double g2Duration)
 
void SetMDuration (double mDuration)
 
virtual double GetAverageTransitCellCycleTime ()
 
virtual double GetAverageStemCellCycleTime ()
 
virtual bool CanCellTerminallyDifferentiate ()
 
double GetMinimumGapDuration ()
 
void SetMinimumGapDuration (double minimumGapDuration)
 
void OutputCellCycleModelInfo (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)
 

Friends

class boost::serialization::access
 

Additional Inherited Members

- Protected Member Functions inherited from AbstractSimpleCellCycleModel
virtual void SetG1Duration ()
 
- Protected Attributes inherited from AbstractSimpleGenerationBasedCellCycleModel
unsigned mGeneration
 
unsigned mMaxTransitGenerations
 
- Protected Attributes inherited from AbstractCellCycleModel
CellPtr mpCell
 
double mBirthTime
 
CellCyclePhase mCurrentCellCyclePhase
 
double mG1Duration
 
bool mReadyToDivide
 
unsigned mDimension
 
double mMinimumGapDuration
 
double mStemCellG1Duration
 
double mTransitCellG1Duration
 
double mSDuration
 
double mG2Duration
 
double mMDuration
 

Detailed Description

Fixed cell-cycle model.

Cell cycle time is deterministic for stem and transit cells (with values StemCellG1Duration + SG2MDuration and TransitCellG1Duration + SG2MDuration (values found in AbstractCellCycleModel))

Definition at line 48 of file FixedDurationGenerationBasedCellCycleModel.hpp.

Constructor & Destructor Documentation

FixedDurationGenerationBasedCellCycleModel::FixedDurationGenerationBasedCellCycleModel ( )

Default constructor. Note that mBirthTime is set in AbstractCellCycleModel() and mG1Duration is set in AbstractSimpleCellCycleModel().

Definition at line 38 of file FixedDurationGenerationBasedCellCycleModel.cpp.

Referenced by CreateCellCycleModel().

Member Function Documentation

AbstractCellCycleModel * FixedDurationGenerationBasedCellCycleModel::CreateCellCycleModel ( )
virtual

Overridden builder method to create new copies of this cell-cycle model.

Returns
new cell-cycle model

Implements AbstractCellCycleModel.

Definition at line 42 of file FixedDurationGenerationBasedCellCycleModel.cpp.

References FixedDurationGenerationBasedCellCycleModel(), AbstractCellCycleModel::mBirthTime, AbstractCellCycleModel::mG2Duration, AbstractSimpleGenerationBasedCellCycleModel::mGeneration, AbstractSimpleGenerationBasedCellCycleModel::mMaxTransitGenerations, AbstractCellCycleModel::mMDuration, AbstractCellCycleModel::mMinimumGapDuration, AbstractCellCycleModel::mSDuration, AbstractCellCycleModel::mStemCellG1Duration, AbstractCellCycleModel::mTransitCellG1Duration, AbstractCellCycleModel::SetBirthTime(), AbstractCellCycleModel::SetG2Duration(), AbstractSimpleGenerationBasedCellCycleModel::SetGeneration(), AbstractSimpleGenerationBasedCellCycleModel::SetMaxTransitGenerations(), AbstractCellCycleModel::SetMDuration(), AbstractCellCycleModel::SetMinimumGapDuration(), AbstractCellCycleModel::SetSDuration(), AbstractCellCycleModel::SetStemCellG1Duration(), and AbstractCellCycleModel::SetTransitCellG1Duration().

void FixedDurationGenerationBasedCellCycleModel::OutputCellCycleModelParameters ( out_stream &  rParamsFile)
virtual

Outputs cell cycle model parameters to file.

Parameters
rParamsFilethe file stream to which the parameters are output

Reimplemented from AbstractSimpleGenerationBasedCellCycleModel.

Definition at line 77 of file FixedDurationGenerationBasedCellCycleModel.cpp.

References AbstractSimpleGenerationBasedCellCycleModel::OutputCellCycleModelParameters().

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

Archive the cell-cycle model, never used directly - boost uses this.

Parameters
archivethe archive
versionthe current version of this class

Definition at line 61 of file FixedDurationGenerationBasedCellCycleModel.hpp.

Friends And Related Function Documentation

friend class boost::serialization::access
friend

Needed for serialization.

Definition at line 53 of file FixedDurationGenerationBasedCellCycleModel.hpp.

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