ITK  4.13.0
Insight Segmentation and Registration Toolkit
itkMutexLockHolder.h
Go to the documentation of this file.
1 /*=========================================================================
2  *
3  * Copyright Insight Software Consortium
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0.txt
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  *=========================================================================*/
18 /*=========================================================================
19  *
20  * Portions of this file are subject to the VTK Toolkit Version 3 copyright.
21  *
22  * Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
23  *
24  * For complete copyright, license and disclaimer of warranty information
25  * please refer to the NOTICE file at the top of the ITK source tree.
26  *
27  *=========================================================================*/
28 #ifndef itkMutexLockHolder_h
29 #define itkMutexLockHolder_h
30 
31 #include "itkMacro.h"
32 
33 namespace itk
34 {
43 template< typename TMutex >
45 {
46 public:
48  typedef TMutex MutexType;
49 
50  MutexLockHolder(MutexType & mutex, const bool noblock=false)
51  :m_Mutex(mutex),
52  m_LockCaptured(true)
53  {
54  if( noblock == false )
55  {
56  m_Mutex.Lock();
57  }
58  else
59  {
60  m_LockCaptured = m_Mutex.TryLock();
61  }
62  }
63 
67  inline bool GetLockCaptured() const { return this->m_LockCaptured; }
68  operator bool () const { return this->m_LockCaptured; }
70 
72  {
73  if ( m_LockCaptured )
74  {
75  m_Mutex.Unlock();
76  }
77  }
78 
79 protected:
82 private:
83  ITK_DISALLOW_COPY_AND_ASSIGN(MutexLockHolder);
84 
85 };
86 
87 } //end itk namespace
88 
89 #endif
bool GetLockCaptured() const
A container to store a Mutex. This holder class for ensuring that locks are released in the event of ...
MutexLockHolder(MutexType &mutex, const bool noblock=false)