My Project
EnsureFinalized.hpp
Go to the documentation of this file.
1 // -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
2 // vi: set et ts=4 sw=4 sts=4:
3 /*
4  This file is part of the Open Porous Media project (OPM).
5 
6  OPM is free software: you can redistribute it and/or modify
7  it under the terms of the GNU General Public License as published by
8  the Free Software Foundation, either version 2 of the License, or
9  (at your option) any later version.
10 
11  OPM is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  GNU General Public License for more details.
15 
16  You should have received a copy of the GNU General Public License
17  along with OPM. If not, see <http://www.gnu.org/licenses/>.
18 
19  Consult the COPYING file in the top-level source directory of this
20  module for the precise wording of the license and the list of
21  copyright holders.
22 */
27 #ifndef OPM_MATERIAL_ENSURE_FINALIZED_HPP
28 #define OPM_MATERIAL_ENSURE_FINALIZED_HPP
29 
30 #include <cassert>
31 #include <stdexcept>
32 
33 // TODO: move this variable to config.h
34 #define OPM_CHECK_PARAM_FINALIZED 1
35 
36 #if ! defined(NDEBUG) && OPM_CHECK_PARAM_FINALIZED
37 #define USE_OPM_CHECK_PARAM_FINALIZED 1
38 #endif
39 
40 namespace Opm {
41 
47 {
48 #if USE_OPM_CHECK_PARAM_FINALIZED
49  bool finalized_;
50 #endif
51 
52 protected:
57 #if USE_OPM_CHECK_PARAM_FINALIZED
58  : finalized_( false )
59 #endif
60  {
61  }
62 
63  void check() const
64  {
65 #if USE_OPM_CHECK_PARAM_FINALIZED
66  if (!finalized_)
67  throw std::runtime_error("Parameter class has not been finalized before usage!");
68 #endif
69  }
70 
71 public:
75  void finalize()
76  {
77 #if USE_OPM_CHECK_PARAM_FINALIZED
78  finalized_ = true;
79 #endif
80  }
81 };
82 
83 #undef USE_OPM_CHECK_PARAM_FINALIZED
84 
85 } // namespace Opm
86 #endif
Default implementation for asserting finalization of parameter objects.
Definition: EnsureFinalized.hpp:47
void finalize()
Mark the object as finalized.
Definition: EnsureFinalized.hpp:75
EnsureFinalized()
The default constructor.
Definition: EnsureFinalized.hpp:56