File: itkMutexLock.h

package info (click to toggle)
insighttoolkit5 5.4.5-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 704,588 kB
  • sloc: cpp: 784,579; ansic: 628,724; xml: 44,704; fortran: 34,250; python: 22,934; sh: 4,078; pascal: 2,636; lisp: 2,158; makefile: 461; yacc: 328; asm: 205; perl: 203; lex: 146; tcl: 132; javascript: 98; csh: 81
file content (177 lines) | stat: -rw-r--r-- 4,172 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         https://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
/*=========================================================================
 *
 *  Portions of this file are subject to the VTK Toolkit Version 3 copyright.
 *
 *  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
 *
 *  For complete copyright, license and disclaimer of warranty information
 *  please refer to the NOTICE file at the top of the ITK source tree.
 *
 *=========================================================================*/
#ifndef itkMutexLock_h
#define itkMutexLock_h

#include "itkObject.h"
#include "itkObjectFactory.h"
#include "itkThreadSupport.h"
#include "ITKDeprecatedExport.h"

namespace itk
{

/**
 * \class SimpleMutexLock
 * \brief Simple mutual exclusion locking class.

 * SimpleMutexLock allows the locking of variables which are accessed
 * through different threads.  This header file also defines
 * SimpleMutexLock which is not a subclass of Object.
 *
 * \ingroup OSSystemObjects
 * \ingroup ITKDeprecated
 */
class ITKDeprecated_EXPORT SimpleMutexLock
{
public:
  /** Standard class type aliases.  */
  using Self = SimpleMutexLock;

  /** Constructor and destructor left public purposely. */
  SimpleMutexLock();
  virtual ~SimpleMutexLock();

  /** Methods for creation and destruction through the object factory. */
  static SimpleMutexLock *
  New();

  void
  Delete()
  {
    delete this;
  }

  /** Used for debugging and other run-time purposes. */
  virtual const char *
  GetNameOfClass()
  {
    return "itkSimpleMutexLock";
  }

  /** Lock the MutexLock. */
  void
  Lock();

  /** Non-blocking Lock access.
   \return bool - true if lock is captured, false if it was already held by someone else.
   */
  bool
  TryLock();

  /** Unlock the MutexLock. */
  void
  Unlock();

  /** Access the MutexType member variable from outside this class */
  MutexType &
  GetMutexLock()
  {
    return m_MutexLock;
  }

  MutexType
  GetMutexLock() const
  {
    return *(const_cast<MutexType *>(&m_MutexLock));
  }

protected:
  MutexType m_MutexLock{};
};

/**
 * \class MutexLock
 * \brief Mutual exclusion locking class.
 *
 * MutexLock allows the locking of variables which are accessed
 * through different threads.  This header file also defines
 * SimpleMutexLock which is not a subclass of itkObject.
 *
 * \ingroup OSSystemObjects
 * \ingroup ITKDeprecated
 */
class ITKDeprecated_EXPORT MutexLock : public Object
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(MutexLock);

  /** Standard class type aliases. */
  using Self = MutexLock;
  using Superclass = Object;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  /** Method for creation. */
  itkNewMacro(Self);

  /** \see LightObject::GetNameOfClass() */
  itkOverrideGetNameOfClassMacro(MutexLock);

  /** Lock the itkMutexLock. */
  void
  Lock();

  /** Non-blocking Lock access.
   \return bool - true if lock is captured, false if it was already held by someone else.
   */
  bool
  TryLock();

  /** Unlock the MutexLock. */
  void
  Unlock();

protected:
  MutexLock() = default;
  ~MutexLock() override = default;

  SimpleMutexLock m_SimpleMutexLock{};
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
};

inline void
MutexLock::Lock()
{
  m_SimpleMutexLock.Lock();
}

inline bool
MutexLock::TryLock()
{
  return m_SimpleMutexLock.TryLock();
}

inline void
MutexLock::Unlock()
{
  m_SimpleMutexLock.Unlock();
}
} // namespace itk
#endif