vtkCriticalSection.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkCriticalSection.h
 
  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
 
     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.
 
=========================================================================*/
#ifndef vtkCriticalSection_h
#define vtkCriticalSection_h
 
#include "vtkCommonCoreModule.h" // For export macro
#include "vtkDeprecation.h"      // For VTK_DEPRECATED_IN_9_1_0
#include "vtkObject.h"
#include <mutex> // for std::mutex
 
VTK_ABI_NAMESPACE_BEGIN
// Remove with VTK_DEPRECATED_IN_9_2_0 because it was not actually deprecated
// in 9.1.0.
class VTK_DEPRECATED_IN_9_1_0("Use std::mutex instead") VTKCOMMONCORE_EXPORT vtkCriticalSection
  : public vtkObject
{
public:
  static vtkCriticalSection* New();
 
  vtkTypeMacro(vtkCriticalSection, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  void Lock();
 
  void Unlock();
 
protected:
  std::mutex mtx;
  vtkCriticalSection() = default;
  ~vtkCriticalSection() override = default;
 
private:
  vtkCriticalSection(const vtkCriticalSection&) = delete;
  void operator=(const vtkCriticalSection&) = delete;
};
 
inline void vtkCriticalSection::Lock()
{
  this->mtx.lock();
}
 
inline void vtkCriticalSection::Unlock()
{
  this->mtx.unlock();
}
 
VTK_ABI_NAMESPACE_END
#endif
 
// VTK-HeaderTest-Exclude: vtkCriticalSection.h