AbstractSimpleGenerationBasedCellCycleModel.hpp

00001 /*
00002 
00003 Copyright (C) University of Oxford, 2005-2011
00004 
00005 University of Oxford means the Chancellor, Masters and Scholars of the
00006 University of Oxford, having an administrative office at Wellington
00007 Square, Oxford OX1 2JD, UK.
00008 
00009 This file is part of Chaste.
00010 
00011 Chaste is free software: you can redistribute it and/or modify it
00012 under the terms of the GNU Lesser General Public License as published
00013 by the Free Software Foundation, either version 2.1 of the License, or
00014 (at your option) any later version.
00015 
00016 Chaste is distributed in the hope that it will be useful, but WITHOUT
00017 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
00019 License for more details. The offer of Chaste under the terms of the
00020 License is subject to the License being interpreted in accordance with
00021 English Law and subject to any action against the University of Oxford
00022 being under the jurisdiction of the English Courts.
00023 
00024 You should have received a copy of the GNU Lesser General Public License
00025 along with Chaste. If not, see <http://www.gnu.org/licenses/>.
00026 
00027 */
00028 #ifndef ABSTRACTSIMPLEGENERATIONBASEDCYCLEMODEL_HPP_
00029 #define ABSTRACTSIMPLEGENERATIONBASEDCYCLEMODEL_HPP_
00030 
00031 #include "ChasteSerialization.hpp"
00032 #include "ClassIsAbstract.hpp"
00033 #include <boost/serialization/base_object.hpp>
00034 
00035 #include "AbstractSimpleCellCycleModel.hpp"
00036 
00046 class AbstractSimpleGenerationBasedCellCycleModel : public AbstractSimpleCellCycleModel
00047 {
00048 private:
00049 
00051     friend class boost::serialization::access;
00058     template<class Archive>
00059     void serialize(Archive & archive, const unsigned int version)
00060     {
00061         archive & boost::serialization::base_object<AbstractSimpleCellCycleModel>(*this);
00062         archive & mGeneration;
00063         archive & mMaxTransitGenerations;
00064     }
00065 
00066 protected:
00067 
00069     unsigned mGeneration;
00070 
00072     unsigned mMaxTransitGenerations;
00073 
00074 public:
00075 
00079     AbstractSimpleGenerationBasedCellCycleModel();
00080 
00084     virtual ~AbstractSimpleGenerationBasedCellCycleModel();
00085 
00087     void ResetForDivision();
00088 
00093     void InitialiseDaughterCell();
00094 
00100     void SetGeneration(unsigned generation);
00101 
00105     unsigned GetGeneration() const;
00106 
00112     void SetMaxTransitGenerations(unsigned maxTransitGenerations);
00113 
00117     unsigned GetMaxTransitGenerations() const;
00118 
00124     virtual void OutputCellCycleModelParameters(out_stream& rParamsFile);
00125 };
00126 
00127 CLASS_IS_ABSTRACT(AbstractSimpleGenerationBasedCellCycleModel)
00128 
00129 #endif /*ABSTRACTSIMPLEGENERATIONBASEDCYCLEMODEL_HPP_*/

Generated on Tue May 31 14:31:40 2011 for Chaste by  doxygen 1.5.5