CardiacSimulationArchiver.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 
00029 #ifndef CARDIACSIMULATIONARCHIVER_HPP_
00030 #define CARDIACSIMULATIONARCHIVER_HPP_
00031 
00032 #include <string>
00033 
00034 #include "FileFinder.hpp"
00035 
00036 /*
00037  * Archiving extravaganza:
00038  *
00039  * Various objects are archived through a pointer to an abstract class.  All the potential concrete
00040  * classes need to be included here, so they are registered with Boost.  If not, Boost (<1.37) won't be
00041  * able to find the archiving methods of the concrete class and will throw the following
00042  * exception:
00043  *
00044  *       terminate called after throwing an instance of 'boost::archive::archive_exception'
00045  *       what():  unregistered class
00046  *
00047  * No member variable is defined to be of any of these clases, so removing them won't
00048  * produce any compiler error.  The exception above will occur at runtime.
00049  *
00050  * This might not be even necessary in certain cases, if the file is included implicitly by another
00051  * header file or by the test itself.  It's safer though.
00052  */
00053 #include "MonodomainProblem.hpp"
00054 #include "BidomainProblem.hpp"
00055 #include "BidomainWithBathProblem.hpp"
00056 #include "HeartConfigRelatedCellFactory.hpp"
00057 
00065 template<class PROBLEM_CLASS>
00066 class CardiacSimulationArchiver
00067 {
00068 public:
00079     static void Save(PROBLEM_CLASS& rSimulationToArchive, const std::string& rDirectory, bool clearDirectory=true);
00080 
00081 
00093     static PROBLEM_CLASS* Load(const std::string& rDirectory);
00094 
00105     static PROBLEM_CLASS* Load(const FileFinder& rDirectory);
00106 
00123     static PROBLEM_CLASS* Migrate(const FileFinder& rDirectory);
00124 };
00125 
00126 #endif /*CARDIACSIMULATIONARCHIVER_HPP_*/

Generated on Tue May 31 14:31:41 2011 for Chaste by  doxygen 1.5.5