Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
CellSrnModel.hpp
1/*
2
3Copyright (c) 2005-2024, University of Oxford.
4All rights reserved.
5
6University of Oxford means the Chancellor, Masters and Scholars of the
7University of Oxford, having an administrative office at Wellington
8Square, Oxford OX1 2JD, UK.
9
10This file is part of Chaste.
11
12Redistribution and use in source and binary forms, with or without
13modification, 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
23THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
27LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
29GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33
34*/
35
36#ifndef CELLSRNMODEL_HPP_
37#define CELLSRNMODEL_HPP_
38
39#include <vector>
41#include "ClassIsAbstract.hpp"
42#include <boost/serialization/base_object.hpp>
43#include <boost/serialization/vector.hpp>
44#include "AbstractSrnModel.hpp"
45#include "CellCycleModelOdeHandler.hpp"
46#include "SimulationTime.hpp"
47
48typedef boost::shared_ptr<AbstractSrnModel> AbstractSrnModelPtr;
49
57{
58
59private:
60
69 template<class Archive>
70 void serialize(Archive & archive, const unsigned int version)
71 {
72 archive & boost::serialization::base_object<AbstractSrnModel>(*this);
73 archive & mEdgeSrnModels;
74 archive & mpInteriorSrnModel;
75 }
76
78 std::vector<boost::shared_ptr<AbstractSrnModel>> mEdgeSrnModels;
79
84 using abstractsrnmodel_t = std::vector<AbstractSrnModelPtr>;
85
87 boost::shared_ptr<AbstractSrnModel> mpInteriorSrnModel;
88
89protected:
90
95 CellSrnModel(const CellSrnModel &rModel);
96
97public:
98
103 using iterator = abstractsrnmodel_t::iterator;
104
109 using const_iterator = abstractsrnmodel_t::const_iterator;
110
115 iterator begin() { return mEdgeSrnModels.begin(); }
116
121 iterator end() { return mEdgeSrnModels.end(); }
122
127 const_iterator begin() const { return mEdgeSrnModels.begin(); }
128
133 const_iterator end() const { return mEdgeSrnModels.end(); }
134
139 const_iterator cbegin() const { return mEdgeSrnModels.cbegin(); }
140
145 const_iterator cend() const { return mEdgeSrnModels.cend(); }
146
150 CellSrnModel();
151
156
160 virtual void Initialise();
161
167 virtual void ResetForDivision();
168
172 virtual void SimulateToCurrentTime();
173
179
185 void AddEdgeSrn(std::vector<AbstractSrnModelPtr> edgeSrns);
186
192 void AddEdgeSrnModel(AbstractSrnModelPtr pEdgeSrn);
193
199 unsigned GetNumEdgeSrn() const;
200
207 AbstractSrnModelPtr GetEdgeSrn(unsigned index) const;
208
214 const std::vector<AbstractSrnModelPtr>& GetEdges() const;
215
221 void SetInteriorSrnModel(AbstractSrnModelPtr pInteriorSrn);
222
228 AbstractSrnModelPtr GetInteriorSrn() const;
229
235 virtual void SetCell(CellPtr pCell);
236};
237
238// Declare identifier for the serializer
241
242#endif /* CELLSRNMODEL_HPP_ */
gcov doesn't like this file...
#define CHASTE_CLASS_EXPORT(T)
void AddEdgeSrn(std::vector< AbstractSrnModelPtr > edgeSrns)
unsigned GetNumEdgeSrn() const
abstractsrnmodel_t::const_iterator const_iterator
AbstractSrnModelPtr GetEdgeSrn(unsigned index) const
virtual void Initialise()
virtual AbstractSrnModel * CreateSrnModel()
virtual void SetCell(CellPtr pCell)
virtual void ResetForDivision()
const std::vector< AbstractSrnModelPtr > & GetEdges() const
const_iterator end() const
const_iterator begin() const
iterator end()
std::vector< boost::shared_ptr< AbstractSrnModel > > mEdgeSrnModels
abstractsrnmodel_t::iterator iterator
const_iterator cend() const
friend class boost::serialization::access
void AddEdgeSrnModel(AbstractSrnModelPtr pEdgeSrn)
void serialize(Archive &archive, const unsigned int version)
void SetInteriorSrnModel(AbstractSrnModelPtr pInteriorSrn)
iterator begin()
std::vector< AbstractSrnModelPtr > abstractsrnmodel_t
boost::shared_ptr< AbstractSrnModel > mpInteriorSrnModel
AbstractSrnModelPtr GetInteriorSrn() const
virtual void SimulateToCurrentTime()
const_iterator cbegin() const