ITK  4.9.0
Insight Segmentation and Registration Toolkit
itkMutexLock.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 itkMutexLock_h
29 #define itkMutexLock_h
30 
31 #include "itkObject.h"
32 #include "itkObjectFactory.h"
33 #include "itkThreadSupport.h"
34 
35 namespace itk
36 {
37 
48 class ITKCommon_EXPORT SimpleMutexLock
49 {
50 public:
53 
56  virtual ~SimpleMutexLock();
58 
60  static SimpleMutexLock * New();
61 
62  void Delete() { delete this; }
63 
65  virtual const char * GetNameOfClass() { return "itkSimpleMutexLock"; }
66 
68  void Lock();
69 
73  bool TryLock();
74 
76  void Unlock();
77 
80  {
81  return m_MutexLock;
82  }
83 
85  {
86  return *( const_cast< MutexType * >( &m_MutexLock ) );
87  }
88 
89 protected:
91 };
92 
103 class ITKCommon_EXPORT MutexLock:public Object
104 {
105 public:
107  typedef MutexLock Self;
111 
113  itkNewMacro(Self);
114 
116  itkTypeMacro(MutexLock, Object);
117 
119  void Lock();
120 
124  bool TryLock();
125 
127  void Unlock();
128 
129 protected:
132 
134  virtual void PrintSelf(std::ostream & os, Indent indent) const ITK_OVERRIDE;
135 
136 private:
137  MutexLock(const Self &) ITK_DELETE_FUNCTION;
138  void operator=(const Self &) ITK_DELETE_FUNCTION;
139 };
140 
141 inline void MutexLock::Lock()
142 {
143  m_SimpleMutexLock.Lock();
144 }
145 
146 inline bool MutexLock::TryLock()
147 {
148  return m_SimpleMutexLock.TryLock();
149 }
150 
151 inline void MutexLock::Unlock()
152 {
153  m_SimpleMutexLock.Unlock();
154 }
155 } //end itk namespace
156 #endif
Light weight base class for most itk classes.
SimpleMutexLock Self
Definition: itkMutexLock.h:52
MutexType & GetMutexLock()
Definition: itkMutexLock.h:79
int MutexType
virtual const char * GetNameOfClass()
Definition: itkMutexLock.h:65
Mutual exclusion locking class.
Definition: itkMutexLock.h:103
MutexType GetMutexLock() const
Definition: itkMutexLock.h:84
SmartPointer< const Self > ConstPointer
Definition: itkMutexLock.h:110
SimpleMutexLock m_SimpleMutexLock
Definition: itkMutexLock.h:133
Control indentation during Print() invocation.
Definition: itkIndent.h:49
MutexLock Self
Definition: itkMutexLock.h:107
Base class for most ITK classes.
Definition: itkObject.h:57
Simple mutual exclusion locking class.
Definition: itkMutexLock.h:48
SmartPointer< Self > Pointer
Definition: itkMutexLock.h:109