TargetedCellKiller.hpp

00001 /*
00002 
00003 Copyright (C) University of Oxford, 2005-2011
00004 
00005 University of Oxford means the Chancellor, Masters and Scholars of the
00006 University of Oxford, having an administrative office at Wellington
00007 Square, Oxford OX1 2JD, UK.
00008 
00009 This file is part of Chaste.
00010 
00011 Chaste is free software: you can redistribute it and/or modify it
00012 under the terms of the GNU Lesser General Public License as published
00013 by the Free Software Foundation, either version 2.1 of the License, or
00014 (at your option) any later version.
00015 
00016 Chaste is distributed in the hope that it will be useful, but WITHOUT
00017 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
00019 License for more details. The offer of Chaste under the terms of the
00020 License is subject to the License being interpreted in accordance with
00021 English Law and subject to any action against the University of Oxford
00022 being under the jurisdiction of the English Courts.
00023 
00024 You should have received a copy of the GNU Lesser General Public License
00025 along with Chaste. If not, see <http://www.gnu.org/licenses/>.
00026 
00027 */
00028 #ifndef TARGETEDCELLKILLER_HPP_
00029 #define TARGETEDCELLKILLER_HPP_
00030 
00031 #include "AbstractCellKiller.hpp"
00032 
00033 #include "ChasteSerialization.hpp"
00034 #include <boost/serialization/base_object.hpp>
00035 
00040 template<unsigned DIM>
00041 class TargetedCellKiller : public AbstractCellKiller<DIM>
00042 {
00043 private:
00044 
00048     unsigned mTargetIndex;
00049 
00050 
00055     bool mBloodLust;
00056 
00057 
00059     friend class boost::serialization::access;
00071     template<class Archive>
00072     void serialize(Archive & archive, const unsigned int version)
00073     {
00074         archive & boost::serialization::base_object<AbstractCellKiller<DIM> >(*this);
00075         // archive & mTargetIndex; // done in load_construct_data
00076         // archive & mBloodlust; // done in load_construct_data
00077     }
00078 
00079 public:
00080 
00088     TargetedCellKiller(AbstractCellPopulation<DIM>* pCellPopulation, unsigned targetedIndex, bool bloodLust = true);
00089 
00093    unsigned GetTargetIndex() const;
00094 
00098   unsigned GetBloodLust() const;
00099 
00100 
00105     void TestAndLabelCellsForApoptosisOrDeath();
00106 
00115     void OutputCellKillerParameters(out_stream& rParamsFile);
00116 };
00117 
00118 #include "SerializationExportWrapper.hpp"
00119 EXPORT_TEMPLATE_CLASS_SAME_DIMS(TargetedCellKiller)
00120 
00121 namespace boost
00122 {
00123 namespace serialization
00124 {
00128 template<class Archive, unsigned DIM>
00129 inline void save_construct_data(
00130     Archive & ar, const TargetedCellKiller<DIM> * t, const BOOST_PFTO unsigned int file_version)
00131 {
00132     // Save data required to construct instance
00133     const AbstractCellPopulation<DIM>* const p_cell_population = t->GetCellPopulation();
00134     ar << p_cell_population;
00135     unsigned targeted_index = t->GetTargetIndex();
00136     ar << targeted_index;
00137     bool blood_lust = t->GetBloodLust();
00138     ar << blood_lust;
00139 }
00140 
00144 template<class Archive, unsigned DIM>
00145 inline void load_construct_data(
00146     Archive & ar, TargetedCellKiller<DIM> * t, const unsigned int file_version)
00147 {
00148     // Retrieve data from archive required to construct new instance
00149     AbstractCellPopulation<DIM>* p_cell_population;
00150     ar >> p_cell_population;
00151     unsigned targeted_index;
00152     ar >> targeted_index;
00153     bool blood_lust;
00154     ar >> blood_lust;
00155 
00156     // Invoke inplace constructor to initialise instance
00157     ::new(t)TargetedCellKiller<DIM>(p_cell_population, targeted_index, blood_lust);
00158 }
00159 }
00160 } // namespace ...
00161 
00162 #endif /*TARGETEDCELLKILLER_HPP_*/

Generated on Mon Apr 18 11:35:27 2011 for Chaste by  doxygen 1.5.5