1 /******************************************************************************
2  * $Id: ogrmutexedlayer.h 355b41831cd2685c85d1aabe5b95665a2c6e99b7 2019-06-19 17:07:04 +0200 Even Rouault $
3  *
4  * Project:  OpenGIS Simple Features Reference Implementation
5  * Purpose:  Defines OGRLMutexedLayer class
6  * Author:   Even Rouault, even dot rouault at spatialys.com
7  *
8  ******************************************************************************
9  * Copyright (c) 2013, Even Rouault <even dot rouault at spatialys.com>
10  *
11  * Permission is hereby granted, free of charge, to any person obtaining a
12  * copy of this software and associated documentation files (the "Software"),
13  * to deal in the Software without restriction, including without limitation
14  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
15  * and/or sell copies of the Software, and to permit persons to whom the
16  * Software is furnished to do so, subject to the following conditions:
17  *
18  * The above copyright notice and this permission notice shall be included
19  * in all copies or substantial portions of the Software.
20  *
21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
22  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
24  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
26  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
27  * DEALINGS IN THE SOFTWARE.
28  ****************************************************************************/
29 
30 #ifndef OGRMUTEXEDLAYER_H_INCLUDED
31 #define OGRMUTEXEDLAYER_H_INCLUDED
32 
33 #ifndef DOXYGEN_SKIP
34 
35 #include "ogrlayerdecorator.h"
36 #include "cpl_multiproc.h"
37 
38 /** OGRMutexedLayer class protects all virtual methods of OGRLayer with a mutex.
39  *
40  *  If the passed mutex is NULL, then no locking will be done.
41  *
42  *  Note that the constructors and destructors are not explicitly protected
43  *  by the mutex.
44  */
45 class CPL_DLL OGRMutexedLayer : public OGRLayerDecorator
46 {
47     CPL_DISALLOW_COPY_ASSIGN(OGRMutexedLayer)
48 
49   protected:
50         CPLMutex          *m_hMutex;
51 
52   public:
53 
54     /* The construction of the object isn't protected by the mutex */
55                        OGRMutexedLayer(OGRLayer* poDecoratedLayer,
56                                        int bTakeOwnership,
57                                        CPLMutex* hMutex);
58 
59     /* The destruction of the object isn't protected by the mutex */
60     virtual           ~OGRMutexedLayer();
61 
62     virtual OGRGeometry *GetSpatialFilter() override;
63     virtual void        SetSpatialFilter( OGRGeometry * ) override;
64     virtual void        SetSpatialFilterRect( double dfMinX, double dfMinY,
65                                               double dfMaxX, double dfMaxY ) override;
66     virtual void        SetSpatialFilter( int iGeomField, OGRGeometry * ) override;
67     virtual void        SetSpatialFilterRect( int iGeomField, double dfMinX, double dfMinY,
68                                               double dfMaxX, double dfMaxY ) override;
69 
70     virtual OGRErr      SetAttributeFilter( const char * ) override;
71 
72     virtual void        ResetReading() override;
73     virtual OGRFeature *GetNextFeature() override;
74     virtual OGRErr      SetNextByIndex( GIntBig nIndex ) override;
75     virtual OGRFeature *GetFeature( GIntBig nFID ) override;
76     virtual OGRErr      ISetFeature( OGRFeature *poFeature ) override;
77     virtual OGRErr      ICreateFeature( OGRFeature *poFeature ) override;
78     virtual OGRErr      DeleteFeature( GIntBig nFID ) override;
79 
80     virtual const char *GetName() override;
81     virtual OGRwkbGeometryType GetGeomType() override;
82     virtual OGRFeatureDefn *GetLayerDefn() override;
83 
84     virtual OGRSpatialReference *GetSpatialRef() override;
85 
86     virtual GIntBig     GetFeatureCount( int bForce = TRUE ) override;
87     virtual OGRErr      GetExtent(int iGeomField, OGREnvelope *psExtent, int bForce = TRUE) override;
88     virtual OGRErr      GetExtent(OGREnvelope *psExtent, int bForce = TRUE) override;
89 
90     virtual int         TestCapability( const char * ) override;
91 
92     virtual OGRErr      CreateField( OGRFieldDefn *poField,
93                                      int bApproxOK = TRUE ) override;
94     virtual OGRErr      DeleteField( int iField ) override;
95     virtual OGRErr      ReorderFields( int* panMap ) override;
96     virtual OGRErr      AlterFieldDefn( int iField, OGRFieldDefn* poNewFieldDefn, int nFlags ) override;
97 
98     virtual OGRErr      SyncToDisk() override;
99 
100     virtual OGRStyleTable *GetStyleTable() override;
101     virtual void        SetStyleTableDirectly( OGRStyleTable *poStyleTable ) override;
102 
103     virtual void        SetStyleTable(OGRStyleTable *poStyleTable) override;
104 
105     virtual OGRErr      StartTransaction() override;
106     virtual OGRErr      CommitTransaction() override;
107     virtual OGRErr      RollbackTransaction() override;
108 
109     virtual const char *GetFIDColumn() override;
110     virtual const char *GetGeometryColumn() override;
111 
112     virtual OGRErr      SetIgnoredFields( const char **papszFields ) override;
113 
114     virtual char      **GetMetadata( const char * pszDomain = "" ) override;
115     virtual CPLErr      SetMetadata( char ** papszMetadata,
116                                      const char * pszDomain = "" ) override;
117     virtual const char *GetMetadataItem( const char * pszName,
118                                          const char * pszDomain = "" ) override;
119     virtual CPLErr      SetMetadataItem( const char * pszName,
120                                          const char * pszValue,
121                                          const char * pszDomain = "" ) override;
122 };
123 
124 #endif /* #ifndef DOXYGEN_SKIP */
125 
126 #endif // OGRMUTEXEDLAYER_H_INCLUDED
127