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
31namespace Opm {
41template <class Callback>
43{
44public:
45 GenericGuard(Callback& callback)
46 : callback_(callback)
47 , isEnabled_(true)
48 { }
49
50 // allow moves
52 : callback_(other.callback_)
53 , isEnabled_(other.isEnabled_)
54 {
55 other.isEnabled_ = false;
56 }
57
58 // disable copies
59 GenericGuard(const GenericGuard& other) = delete;
60
62 {
63 if (isEnabled_)
64 callback_();
65 }
66
73 void setEnabled(bool value)
74 { isEnabled_ = value; }
75
79 bool enabled() const
80 { return isEnabled_; }
81
82private:
83 Callback& callback_;
84 bool isEnabled_;
85};
86
87template <class Callback>
89{ return GenericGuard<Callback>(callback); }
90
91} // namespace Opm
92
93#endif
A simple class which makes sure that a cleanup function is called once the object is destroyed.
Definition: genericguard.hh:43
GenericGuard(Callback &callback)
Definition: genericguard.hh:45
bool enabled() const
Returns whether the guard object is "on duty" or not.
Definition: genericguard.hh:79
~GenericGuard()
Definition: genericguard.hh:61
GenericGuard(const GenericGuard &other)=delete
GenericGuard(GenericGuard &&other)
Definition: genericguard.hh:51
void setEnabled(bool value)
Specify whether the guard object is "on duty" or not.
Definition: genericguard.hh:73
Definition: blackoilboundaryratevector.hh:37
GenericGuard< Callback > make_guard(Callback &callback)
Definition: genericguard.hh:88