409116b99d60579f71e23c845785073a3f42209a
[occt.git] / src / TopTools / TopTools_MutexForShapeProvider.hxx
1 // Created on: 2012-06-27
2 // Created by: Dmitry BOBYLEV
3 // Copyright (c) 2012 OPEN CASCADE SAS
4 //
5 // The content of this file is subject to the Open CASCADE Technology Public
6 // License Version 6.5 (the "License"). You may not use the content of this file
7 // except in compliance with the License. Please obtain a copy of the License
8 // at http://www.opencascade.org and read it completely before using this file.
9 //
10 // The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
11 // main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
12 //
13 // The Original Code and all software distributed under the License is
14 // distributed on an "AS IS" basis, without warranty of any kind, and the
15 // Initial Developer hereby disclaims all such warranties, including without
16 // limitation, any warranties of merchantability, fitness for a particular
17 // purpose or non-infringement. Please see the License for the specific terms
18 // and conditions governing the rights and limitations under the License.
19
20
21 #ifndef _TopTools_MutexForShapeProvider_HeaderFile
22 #define _TopTools_MutexForShapeProvider_HeaderFile
23
24 #include <NCollection_DataMap.hxx>
25 #include <Standard_Mutex.hxx>
26 #include <TopAbs_ShapeEnum.hxx>
27 #include <TopoDS_Shape.hxx>
28 #include <TopTools_ShapeMapHasher.hxx>
29
30
31 //! Class TopTools_MutexForShapeProvider 
32 //!   This class is used to create and store mutexes associated with shapes.
33 class TopTools_MutexForShapeProvider
34 {
35 public:
36   //! Constructor
37   Standard_EXPORT TopTools_MutexForShapeProvider();
38
39   //! Destructor
40   Standard_EXPORT ~TopTools_MutexForShapeProvider();
41
42   //! Creates and associates mutexes with each sub-shape of type theType in theShape.
43   Standard_EXPORT void CreateMutexesForSubShapes(const TopoDS_Shape& theShape, const TopAbs_ShapeEnum theType);
44
45   //! Creates and associates mutex with theShape
46   Standard_EXPORT void CreateMutexForShape(const TopoDS_Shape& theShape);
47
48   //! Returns pointer to mutex associated with theShape.
49   //! In case when mutex not found returns NULL.
50   Standard_EXPORT Standard_Mutex* GetMutex(const TopoDS_Shape& theShape) const;
51
52   //! Removes all mutexes
53   Standard_EXPORT void RemoveAllMutexes();
54
55 private:
56   //! This method should not be called (prohibited).
57   TopTools_MutexForShapeProvider (const TopTools_MutexForShapeProvider &);
58   //! This method should not be called (prohibited).
59   TopTools_MutexForShapeProvider & operator = (const TopTools_MutexForShapeProvider &);
60
61
62   NCollection_DataMap<TopoDS_Shape, Standard_Mutex *, TopTools_ShapeMapHasher> myMap;
63
64 };
65
66 #endif