AbstractCellCycleModel.hpp

/*

Copyright (C) University of Oxford, 2005-2010

University of Oxford means the Chancellor, Masters and Scholars of the
University of Oxford, having an administrative office at Wellington
Square, Oxford OX1 2JD, UK.

This file is part of Chaste.

Chaste is free software: you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published
by the Free Software Foundation, either version 2.1 of the License, or
(at your option) any later version.

Chaste is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
License for more details. The offer of Chaste under the terms of the
License is subject to the License being interpreted in accordance with
English Law and subject to any action against the University of Oxford
being under the jurisdiction of the English Courts.

You should have received a copy of the GNU Lesser General Public License
along with Chaste. If not, see <http://www.gnu.org/licenses/>.

*/
#ifndef ABSTRACTCELLCYCLEMODEL_HPP_
#define ABSTRACTCELLCYCLEMODEL_HPP_

#include "UblasIncludes.hpp"
#include "ChasteSerialization.hpp"
#include "ClassIsAbstract.hpp"
#include <boost/serialization/base_object.hpp>

#include <vector>

#include "CellProliferativeTypes.hpp"
#include "CellCyclePhases.hpp"
#include "SimulationTime.hpp"
#include "TissueConfig.hpp"
#include "TissueCell.hpp"

class TissueCell; // Circular definition (cells need to know about cycle models and vice-versa)


class AbstractCellCycleModel
{
private:

    friend class boost::serialization::access;
    template<class Archive>
    void serialize(Archive & archive, const unsigned int version)
    {
        // Make sure the SimulationTime and TissueConfig singletons get saved too
        SimulationTime* p_time = SimulationTime::Instance();
        archive & *p_time;
        archive & p_time;
        TissueConfig* p_params = TissueConfig::Instance();
        archive & *p_params;
        archive & p_params;

        // DO NOT archive & mpCell; -- The CellCycleModel is only ever archived from the Cell
        // which knows this and it is handled in the load_construct of TissueCell.
        archive & mBirthTime;
        archive & mCurrentCellCyclePhase;
        archive & mG1Duration;
        archive & mReadyToDivide;
        archive & mDimension;
    }

    AbstractCellCycleModel & operator = (const AbstractCellCycleModel& rOtherModel);

protected:

    TissueCell* mpCell;

    double mBirthTime;

    CellCyclePhase mCurrentCellCyclePhase;

    double mG1Duration;

    bool mReadyToDivide;

    unsigned mDimension;

public:

    AbstractCellCycleModel();

    virtual ~AbstractCellCycleModel();

    void SetCell(TissueCell* pCell);

    virtual void Initialise()
    {}

    virtual void InitialiseDaughterCell()
    {}

    TissueCell* GetCell();

    virtual void SetBirthTime(double birthTime);

    void SetDimension(unsigned dimension);

    unsigned GetDimension();

    double GetBirthTime() const;

    double GetAge();

    bool ReadyToDivide();

    virtual void UpdateCellCyclePhase()=0;

    virtual void ResetForDivision();

    virtual AbstractCellCycleModel* CreateCellCycleModel()=0;

    CellCyclePhase GetCurrentCellCyclePhase();

    virtual double GetG1Duration();

    virtual double GetSDuration();

    virtual double GetG2Duration();

    virtual double GetMDuration();

    virtual double GetAverageTransitCellCycleTime();

    virtual double GetAverageStemCellCycleTime();

    virtual bool CanCellTerminallyDifferentiate();
};


CLASS_IS_ABSTRACT(AbstractCellCycleModel)


#endif /*ABSTRACTCELLCYCLEMODEL_HPP_*/