Chaste  Release::2018.1
CellCycleTimesGenerator.hpp
1 /*
2 
3 Copyright (c) 2005-2018, University of Oxford.
4 All rights reserved.
5 
6 University of Oxford means the Chancellor, Masters and Scholars of the
7 University of Oxford, having an administrative office at Wellington
8 Square, Oxford OX1 2JD, UK.
9 
10 This file is part of Chaste.
11 
12 Redistribution and use in source and binary forms, with or without
13 modification, are permitted provided that the following conditions are met:
14  * Redistributions of source code must retain the above copyright notice,
15  this list of conditions and the following disclaimer.
16  * Redistributions in binary form must reproduce the above copyright notice,
17  this list of conditions and the following disclaimer in the documentation
18  and/or other materials provided with the distribution.
19  * Neither the name of the University of Oxford nor the names of its
20  contributors may be used to endorse or promote products derived from this
21  software without specific prior written permission.
22 
23 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
27 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
29 GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32 OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 
34 */
35 
36 #ifndef CELLCYCLETIMESGENERATOR_HPP_
37 #define CELLCYCLETIMESGENERATOR_HPP_
38 
39 #include <sstream>
40 
41 #include "ChasteSerialization.hpp"
42 #include "RandomNumberGenerator.hpp"
43 #include "SerializableSingleton.hpp"
44 
49 class CellCycleTimesGenerator : public SerializableSingleton<CellCycleTimesGenerator>
50 {
51 private:
55 
59  unsigned mRandomSeed;
60 
64  std::vector<double> mCellCycleTimes;
65 
72  unsigned mCurrentIndex;
73 
78  double mRate;
79 
85 
88 
97  template <class Archive>
98  void serialize(Archive& archive, const unsigned int version)
99  {
100  archive& mRandomSeed;
101  archive& mCellCycleTimes;
102  archive& mCurrentIndex;
103  archive& mRate;
104  archive& mVectorCreated;
105  }
106 
107 protected:
113 
114 public:
120 
127  static void Destroy();
128 
134  void SetRandomSeed(unsigned randomSeed);
135 
141  unsigned GetRandomSeed();
142 
148  void SetRate(double rate);
149 
155  double GetRate();
156 
161 
167  double GetNextCellCycleTime();
168 };
169 
170 #endif /*CELLCYCLETIMESGENERATOR_HPP_*/
friend class boost::serialization::access
static CellCycleTimesGenerator * mpInstance
static CellCycleTimesGenerator * Instance()
std::vector< double > mCellCycleTimes
void SetRandomSeed(unsigned randomSeed)
void serialize(Archive &archive, const unsigned int version)