Chaste  Release::2018.1
AbstractSrnModel.cpp
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 #include "AbstractSrnModel.hpp"
37 
39  : mSimulatedToTime(SimulationTime::Instance()->GetTime())
40 {
41 }
42 
44 {
45 }
46 
48 {
49 }
50 
52 {
53 }
54 
56  : mSimulatedToTime(rModel.GetSimulatedToTime())
57 {
58  /*
59  * Set each member variable of the new SRN model that inherits
60  * its value from the parent.
61  *
62  * Note 1: some of the new SRN model's member variables
63  * will already have been correctly initialized in its constructor.
64  *
65  * Note 2: one or more of the new SRN model's member variables
66  * may be set/overwritten as soon as InitialiseDaughterCell() is called on
67  * the new SRN model.
68  *
69  * Note 3: Only set the variables defined in this class. Variables defined
70  * in parent classes will be defined there.
71  */
72 }
73 
75 {
76  // Make sure we're at the current time
78  assert(mSimulatedToTime == SimulationTime::Instance()->GetTime());
79 }
80 
81 void AbstractSrnModel::SetCell(CellPtr pCell)
82 {
83  mpCell = pCell;
84 }
85 
87 {
88  assert(mpCell != nullptr);
89  return mpCell;
90 }
91 
92 void AbstractSrnModel::SetSimulatedToTime(double simulatedToTime)
93 {
94  mSimulatedToTime = simulatedToTime;
95 }
96 
98 {
99  return mSimulatedToTime;
100 }
101 
102 /*
104 void AbstractSrnModel::SimulateToCurrentTime()
105 {
106  // This should be overridden
107  SetSimulatedToTime(SimulationTime::Instance()->GetTime());
108 }
109 */
110 
111 void AbstractSrnModel::OutputSrnModelInfo(out_stream& rParamsFile)
112 {
113  std::string srn_model_type = GetIdentifier();
114 
115  *rParamsFile << "\t\t<" << srn_model_type << ">\n";
116  OutputSrnModelParameters(rParamsFile);
117  *rParamsFile << "\t\t</" << srn_model_type << ">\n";
118 }
119 
120 void AbstractSrnModel::OutputSrnModelParameters(out_stream& rParamsFile)
121 {
122 }
static SimulationTime * Instance()
void SetCell(CellPtr pCell)
virtual void SimulateToCurrentTime()=0
virtual void InitialiseDaughterCell()
virtual void ResetForDivision()
virtual void Initialise()
void SetSimulatedToTime(double simulatedToTime)
virtual void OutputSrnModelParameters(out_stream &rParamsFile)
virtual ~AbstractSrnModel()
double GetSimulatedToTime() const
std::string GetIdentifier() const
void OutputSrnModelInfo(out_stream &rParamsFile)