Chaste  Release::3.4
SerializableSingleton.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 SERIALIZABLESINGLETON_HPP_
37 #define SERIALIZABLESINGLETON_HPP_
38 
39 #include <boost/utility.hpp>
40 #include "ChasteSerialization.hpp"
41 #include <boost/serialization/split_member.hpp>
42 
79 template<class SINGLETON_CLASS>
80 class SerializableSingleton : private boost::noncopyable
81 {
82 public:
87  {
88  return const_cast<SerializableSingleton<SINGLETON_CLASS>*>(this);
89  }
90 
91 private:
92  friend class boost::serialization::access;
93 
100  template<class Archive>
101  void save(Archive & archive, const unsigned int version) const
102  {
103  SINGLETON_CLASS* p_instance = SINGLETON_CLASS::Instance();
104  archive & *p_instance;
105  archive & p_instance;
106  }
107 
114  template<class Archive>
115  void load(Archive & archive, const unsigned int version)
116  {
117  SINGLETON_CLASS* p_instance = SINGLETON_CLASS::Instance();
118  archive & *p_instance;
119  archive & p_instance;
120 
121  // To avoid a memory leak, we now need to delete this (temporary) wrapper, and
122  // ideally tell the archive that it should be using the instance's instead.
123  // Unfortunately reset_object_address doesn't work from within load(), so we
124  // just create a new wrapper each time; not too bad.
125  //archive.reset_object_address(p_instance->GetSerializationWrapper(), this);
126  delete this;
127  }
128  BOOST_SERIALIZATION_SPLIT_MEMBER()
129 };
130 
131 #endif // SERIALIZABLESINGLETON_HPP_
void save(Archive &archive, const unsigned int version) const
SerializableSingleton< SINGLETON_CLASS > * GetSerializationWrapper() const
void load(Archive &archive, const unsigned int version)