Chaste  Release::3.4
ApoptoticCellKiller.hpp
1 /*
2 
3 Copyright (c) 2005-2016, 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 APOPTOTICCELLKILLER_HPP_
37 #define APOPTOTICCELLKILLER_HPP_
38 
39 #include "AbstractCellKiller.hpp"
40 
41 #include "ChasteSerialization.hpp"
42 #include <boost/serialization/base_object.hpp>
43 
47 template<unsigned SPACE_DIM>
48 class ApoptoticCellKiller : public AbstractCellKiller<SPACE_DIM>
49 {
50 private:
51 
52  friend class boost::serialization::access;
60  template<class Archive>
61  void serialize(Archive & archive, const unsigned int version)
62  {
63  archive & boost::serialization::base_object<AbstractCellKiller<SPACE_DIM> >(*this);
64  }
65 
66 public:
67 
74 
80  void CheckAndLabelSingleCellForApoptosis(CellPtr pCell);
81 
86 
92  void OutputCellKillerParameters(out_stream& rParamsFile);
93 };
94 
97 
98 namespace boost
99 {
100 namespace serialization
101 {
105 template<class Archive, unsigned DIM>
106 inline void save_construct_data(
107  Archive & ar, const ApoptoticCellKiller<DIM> * t, const unsigned int file_version)
108 {
109  // Save data required to construct instance
110  const AbstractCellPopulation<DIM>* const p_cell_population = t->GetCellPopulation();
111  ar << p_cell_population;
112 }
113 
117 template<class Archive, unsigned DIM>
118 inline void load_construct_data(
119  Archive & ar, ApoptoticCellKiller<DIM> * t, const unsigned int file_version)
120 {
121  // Retrieve data from archive required to construct new instance
122  AbstractCellPopulation<DIM>* p_cell_population;
123  ar >> p_cell_population;
124 
125  // Invoke inplace constructor to initialise instance
126  ::new(t)ApoptoticCellKiller<DIM>(p_cell_population);
127 }
128 }
129 } // namespace ...
130 
131 #endif /*APOPTOTICCELLKILLER_HPP_*/
void CheckAndLabelSingleCellForApoptosis(CellPtr pCell)
virtual void CheckAndLabelCellsForApoptosisOrDeath()
const AbstractCellPopulation< SPACE_DIM > * GetCellPopulation() const
#define EXPORT_TEMPLATE_CLASS_SAME_DIMS(CLASS)
ApoptoticCellKiller(AbstractCellPopulation< SPACE_DIM > *pCellPopulation)
void serialize(Archive &archive, const unsigned int version)
void OutputCellKillerParameters(out_stream &rParamsFile)