Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
AbstractDynamicallyLoadableEntity.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 ABSTRACTDYNAMICALLYLOADABLEENTITY_HPP_
37#define ABSTRACTDYNAMICALLYLOADABLEENTITY_HPP_
38
39#include "DynamicCellModelLoader.hpp"
40#include "DynamicModelLoaderRegistry.hpp"
42#include <boost/serialization/split_member.hpp>
43
49{
50public:
54 const DynamicCellModelLoaderPtr GetLoader() const;
55
61 void SetLoader(DynamicCellModelLoaderPtr pLoader);
62
65
66private:
67
69 DynamicCellModelLoaderPtr mpLoader;
70
71// LCOV_EXCL_START
72 /* The save and load methods in this mixin class are both adequately covered in TestDynamicallyLoadedCellModels::TestArchiving()
73 * and also in higher-level TestCardiacSimulation tests. This coverage does not appear in standard gcov parsing and
74 * hence spuriously fails.
75 */
76
77 friend class boost::serialization::access;
84 template<class Archive>
85 void save(Archive & archive, const unsigned int version) const
86 {
87 const std::string so_path = GetLoader()->GetLoadableModulePath();
88 archive & so_path;
89 }
96 template<class Archive>
97 void load(Archive & archive, const unsigned int version)
98 {
99 std::string so_path;
100 archive & so_path;
102 }
103 BOOST_SERIALIZATION_SPLIT_MEMBER()
104// LCOV_EXCL_STOP
105};
106
107#endif /*ABSTRACTDYNAMICALLYLOADABLEENTITY_HPP_*/
108
109
void SetLoader(DynamicCellModelLoaderPtr pLoader)
const DynamicCellModelLoaderPtr GetLoader() const
void load(Archive &archive, const unsigned int version)
void save(Archive &archive, const unsigned int version) const
static DynamicModelLoaderRegistry * Instance()