All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
genericguard.hh
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 */
28 #ifndef EWOMS_GENERIC_GUARD_HH
29 #define EWOMS_GENERIC_GUARD_HH
30 
31 namespace Ewoms {
41 template <class Callback>
43 {
44 public:
45  GenericGuard(Callback& callback)
46  : callback_(callback)
47  , isEnabled_(true)
48  { }
49 
50  ~GenericGuard()
51  {
52  if (isEnabled_)
53  callback_();
54  }
55 
62  void setEnabled(bool value)
63  { isEnabled_ = value; }
64 
68  bool enabled() const
69  { return isEnabled_; }
70 
71 private:
72  Callback& callback_;
73  bool isEnabled_;
74 };
75 
76 } // namespace Ewoms
77 
78 #endif
bool enabled() const
Returns whether the guard object is &quot;on duty&quot; or not.
Definition: genericguard.hh:68
A simple class which makes sure that a cleanup function is called once the object is destroyed...
Definition: genericguard.hh:42
void setEnabled(bool value)
Specify whether the guard object is &quot;on duty&quot; or not.
Definition: genericguard.hh:62