Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
TargetedCellKiller.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 TARGETEDCELLKILLER_HPP_
37#define TARGETEDCELLKILLER_HPP_
38
39#include "AbstractCellKiller.hpp"
40
42#include <boost/serialization/base_object.hpp>
43
48template<unsigned DIM>
50{
51private:
52
56 unsigned mTargetIndex;
57
63
72 template<class Archive>
73 void serialize(Archive & archive, const unsigned int version)
74 {
75 archive & boost::serialization::base_object<AbstractCellKiller<DIM> >(*this);
76 // archive & mTargetIndex; // done in load_construct_data
77 // archive & mBloodlust; // done in load_construct_data
78 }
79
80public:
81
89 TargetedCellKiller(AbstractCellPopulation<DIM>* pCellPopulation, unsigned targetedIndex, bool bloodLust = true);
90
94 unsigned GetTargetIndex() const;
95
99 unsigned GetBloodLust() const;
100
106
112 void OutputCellKillerParameters(out_stream& rParamsFile);
113};
114
117
118namespace boost
119{
120namespace serialization
121{
125template<class Archive, unsigned DIM>
126inline void save_construct_data(
127 Archive & ar, const TargetedCellKiller<DIM> * t, const unsigned int file_version)
128{
129 // Save data required to construct instance
130 const AbstractCellPopulation<DIM>* const p_cell_population = t->GetCellPopulation();
131 ar << p_cell_population;
132 unsigned targeted_index = t->GetTargetIndex();
133 ar << targeted_index;
134 bool blood_lust = t->GetBloodLust();
135 ar << blood_lust;
136}
137
141template<class Archive, unsigned DIM>
142inline void load_construct_data(
143 Archive & ar, TargetedCellKiller<DIM> * t, const unsigned int file_version)
144{
145 // Retrieve data from archive required to construct new instance
146 AbstractCellPopulation<DIM>* p_cell_population;
147 ar >> p_cell_population;
148 unsigned targeted_index;
149 ar >> targeted_index;
150 bool blood_lust;
151 ar >> blood_lust;
152
153 // Invoke inplace constructor to initialise instance
154 ::new(t)TargetedCellKiller<DIM>(p_cell_population, targeted_index, blood_lust);
155}
156}
157} // namespace ...
158
159#endif /*TARGETEDCELLKILLER_HPP_*/
gcov doesn't like this file...
#define EXPORT_TEMPLATE_CLASS_SAME_DIMS(CLASS)
unsigned GetBloodLust() const
unsigned GetTargetIndex() const
void serialize(Archive &archive, const unsigned int version)
void CheckAndLabelCellsForApoptosisOrDeath()
friend class boost::serialization::access
void OutputCellKillerParameters(out_stream &rParamsFile)