TissueCell.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 TISSUECELL_HPP_
#define TISSUECELL_HPP_

#include "ChasteSerialization.hpp"
#include <boost/shared_ptr.hpp>
#include <boost/serialization/shared_ptr.hpp>

#include "Element.hpp"
#include "CellProliferativeTypes.hpp"
#include "AbstractCellMutationState.hpp"
#include "AbstractCellCycleModel.hpp"
#include "SimulationTime.hpp"

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


class TissueCell
{
private:

    bool mCanDivide;

    friend class boost::serialization::access;
    template<class Archive>
    void serialize(Archive & archive, const unsigned int version)
    {
        // If Archive is an output archive, then '&' resolves to '<<'
        // If Archive is an input archive, then '&' resolves to '>>'
        // These first four are also dealt with by {load,save}_construct_data
        archive & mCanDivide;
        archive & mCellProliferativeType;
        archive & mpMutationState;
        archive & mpCellCycleModel;
        archive & mUndergoingApoptosis;
        archive & mDeathTime;
        archive & mStartOfApoptosisTime;
        archive & mIsDead;
        archive & mIsLogged;
        archive & mAncestor;
        archive & mCellId;
        archive & mMaxCellId;
    }

protected:

    // NB - if you add any member variables, make sure CommonCopy includes them.

    CellProliferativeType mCellProliferativeType;

    boost::shared_ptr<AbstractCellMutationState> mpMutationState;

    AbstractCellCycleModel* mpCellCycleModel;

    unsigned mAncestor;

    unsigned mCellId;

    static unsigned mMaxCellId;

    double mDeathTime;

    double mStartOfApoptosisTime;

    bool mUndergoingApoptosis;

    bool mIsDead;

    bool mIsLogged;

    void CommonCopy(const TissueCell& rOtherCell);

public:

    TissueCell(CellProliferativeType cellType,
               boost::shared_ptr<AbstractCellMutationState> pMutationState,
               AbstractCellCycleModel* pCellCycleModel,
               bool archiving = false);

    ~TissueCell();

    TissueCell(const TissueCell& rOtherCell);

    TissueCell& operator=(const TissueCell& rOtherCell);

    void SetBirthTime(double birthTime);

    void SetCellCycleModel(AbstractCellCycleModel* pCellCycleModel);

    AbstractCellCycleModel* GetCellCycleModel() const;

    void InitialiseCellCycleModel();

    double GetAge() const;

    double GetBirthTime() const;

    double GetStartOfApoptosisTime() const;

    CellProliferativeType GetCellProliferativeType() const;

    void SetCellProliferativeType(CellProliferativeType cellType);

    boost::shared_ptr<AbstractCellMutationState> GetMutationState() const;

    void SetMutationState(boost::shared_ptr<AbstractCellMutationState> pMutationState);

    bool ReadyToDivide();

    TissueCell Divide();

    void StartApoptosis(bool setDeathTime=true);

    void Kill();

    bool HasApoptosisBegun() const;

    double GetTimeUntilDeath() const;

    bool IsDead();

    void SetLogged();

    bool IsLogged();

    void SetAncestor(unsigned ancestorIndex);

    unsigned GetAncestor() const;

    unsigned GetCellId() const;

    static void ResetMaxCellId();
};


#include "SerializationExportWrapper.hpp"
CHASTE_CLASS_EXPORT(TissueCell);

namespace boost
{
namespace serialization
{
template<class Archive>
inline void save_construct_data(
    Archive & ar, const TissueCell * t, const BOOST_PFTO unsigned int file_version)
{
    // Save data required to construct instance
    const CellProliferativeType cell_type = t->GetCellProliferativeType();
    const boost::shared_ptr<AbstractCellMutationState> p_mutation_state = t->GetMutationState();

    const AbstractCellCycleModel* const p_cell_cycle_model = t->GetCellCycleModel();
    ar << cell_type;
    ar << p_mutation_state;
    ar << p_cell_cycle_model;
}

template<class Archive>
inline void load_construct_data(
    Archive & ar, TissueCell * t, const unsigned int file_version)
{
    // Retrieve data from archive required to construct new instance
    CellProliferativeType cell_type;
    boost::shared_ptr<AbstractCellMutationState> p_mutation_state;
    AbstractCellCycleModel* p_cell_cycle_model;

    ar >> cell_type;
    ar >> p_mutation_state;
    ar >> p_cell_cycle_model;
    bool archiving = true;

    // Invoke inplace constructor to initialize instance
    ::new(t)TissueCell(cell_type, p_mutation_state, p_cell_cycle_model, archiving);
}
}
} // namespace ...

#endif /*TISSUECELL_HPP_*/