Eclipse SUMO - Simulation of Urban MObility
Loading...
Searching...
No Matches
ScopedLocker.h
Go to the documentation of this file.
1/****************************************************************************/
2// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
3// Copyright (C) 2018-2024 German Aerospace Center (DLR) and others.
4// This program and the accompanying materials are made available under the
5// terms of the Eclipse Public License 2.0 which is available at
6// https://www.eclipse.org/legal/epl-2.0/
7// This Source Code may also be made available under the following Secondary
8// Licenses when the conditions for such availability set forth in the Eclipse
9// Public License 2.0 are satisfied: GNU General Public License, version 2
10// or later which is available at
11// https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
12// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
13/****************************************************************************/
18// A scoped lock which only triggers on condition
19/****************************************************************************/
20#pragma once
21#include <config.h>
22
23
24// ===========================================================================
25// class declarations
26// ===========================================================================
27namespace FX {
28class FXMutex;
29}
30
31
32// ===========================================================================
33// class definitions
34// ===========================================================================
39template<typename T = FX::FXMutex, bool IGNORE_COND = false>
41
42public:
44 ScopedLocker(T& m, const bool condition = true)
45 : myMutex(m), myCondition(condition) {
46 if (IGNORE_COND || condition) {
47 m.lock();
48 }
49 }
50
53 if (IGNORE_COND || myCondition) {
54 myMutex.unlock();
55 }
56 }
57
58private:
60 const bool myCondition;
61
62private:
64};
A scoped lock which only triggers on condition.
~ScopedLocker()
Destroy and unlock associated mutex.
ScopedLocker(T &m, const bool condition=true)
Construct & lock associated mutex if the condition is true.
ScopedLocker & operator=(const ScopedLocker &)=delete
const bool myCondition
Definition GUI.h:31