GDAL
ogrlayerpool.h
1 /******************************************************************************
2  * $Id$
3  *
4  * Project: OpenGIS Simple Features Reference Implementation
5  * Purpose: Defines OGRLayerPool and OGRProxiedLayer class
6  * Author: Even Rouault, even dot rouault at spatialys.com
7  *
8  ******************************************************************************
9  * Copyright (c) 2012-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 OGRLAYERPOOL_H_INCLUDED
31 #define OGRLAYERPOOL_H_INCLUDED
32 
33 #ifndef DOXYGEN_SKIP
34 
35 #include "ogrsf_frmts.h"
36 
37 typedef OGRLayer *(*OpenLayerFunc)(void *user_data);
38 typedef void (*FreeUserDataFunc)(void *user_data);
39 
40 class OGRLayerPool;
41 
42 /************************************************************************/
43 /* OGRAbstractProxiedLayer */
44 /************************************************************************/
45 
46 class CPL_DLL OGRAbstractProxiedLayer : public OGRLayer
47 {
48  CPL_DISALLOW_COPY_ASSIGN(OGRAbstractProxiedLayer)
49 
50  friend class OGRLayerPool;
51 
52  OGRAbstractProxiedLayer
53  *poPrevLayer; /* Chain to a layer that was used more recently */
54  OGRAbstractProxiedLayer
55  *poNextLayer; /* Chain to a layer that was used less recently */
56 
57  protected:
58  OGRLayerPool *poPool;
59 
60  virtual void CloseUnderlyingLayer() = 0;
61 
62  public:
63  explicit OGRAbstractProxiedLayer(OGRLayerPool *poPool);
64  virtual ~OGRAbstractProxiedLayer();
65 };
66 
67 /************************************************************************/
68 /* OGRLayerPool */
69 /************************************************************************/
70 
71 class CPL_DLL OGRLayerPool
72 {
73  CPL_DISALLOW_COPY_ASSIGN(OGRLayerPool)
74 
75  protected:
76  OGRAbstractProxiedLayer *poMRULayer; /* the most recently used layer */
77  OGRAbstractProxiedLayer
78  *poLRULayer; /* the least recently used layer (still opened) */
79  int nMRUListSize; /* the size of the list */
80  int nMaxSimultaneouslyOpened;
81 
82  public:
83  explicit OGRLayerPool(int nMaxSimultaneouslyOpened = 100);
84  ~OGRLayerPool();
85 
86  void SetLastUsedLayer(OGRAbstractProxiedLayer *poProxiedLayer);
87  void UnchainLayer(OGRAbstractProxiedLayer *poProxiedLayer);
88 
89  int GetMaxSimultaneouslyOpened() const
90  {
91  return nMaxSimultaneouslyOpened;
92  }
93  int GetSize() const
94  {
95  return nMRUListSize;
96  }
97 };
98 
99 /************************************************************************/
100 /* OGRProxiedLayer */
101 /************************************************************************/
102 
103 class OGRProxiedLayer : public OGRAbstractProxiedLayer
104 {
105  CPL_DISALLOW_COPY_ASSIGN(OGRProxiedLayer)
106 
107  OpenLayerFunc pfnOpenLayer;
108  FreeUserDataFunc pfnFreeUserData;
109  void *pUserData;
110  OGRLayer *poUnderlyingLayer;
111  OGRFeatureDefn *poFeatureDefn;
112  OGRSpatialReference *poSRS;
113 
114  int OpenUnderlyingLayer();
115 
116  protected:
117  virtual void CloseUnderlyingLayer() override;
118 
119  public:
120  OGRProxiedLayer(OGRLayerPool *poPool, OpenLayerFunc pfnOpenLayer,
121  FreeUserDataFunc pfnFreeUserData, void *pUserData);
122  virtual ~OGRProxiedLayer();
123 
124  OGRLayer *GetUnderlyingLayer();
125 
126  virtual OGRGeometry *GetSpatialFilter() override;
127  virtual void SetSpatialFilter(OGRGeometry *) override;
128  virtual void SetSpatialFilter(int iGeomField, OGRGeometry *) override;
129 
130  virtual OGRErr SetAttributeFilter(const char *) override;
131 
132  virtual void ResetReading() override;
133  virtual OGRFeature *GetNextFeature() override;
134  virtual OGRErr SetNextByIndex(GIntBig nIndex) override;
135  virtual OGRFeature *GetFeature(GIntBig nFID) override;
136  virtual OGRErr ISetFeature(OGRFeature *poFeature) override;
137  virtual OGRErr ICreateFeature(OGRFeature *poFeature) override;
138  virtual OGRErr IUpsertFeature(OGRFeature *poFeature) override;
139  OGRErr IUpdateFeature(OGRFeature *poFeature, int nUpdatedFieldsCount,
140  const int *panUpdatedFieldsIdx,
141  int nUpdatedGeomFieldsCount,
142  const int *panUpdatedGeomFieldsIdx,
143  bool bUpdateStyleString) override;
144  virtual OGRErr DeleteFeature(GIntBig nFID) override;
145 
146  virtual GDALDataset *GetDataset() override;
147  virtual bool GetArrowStream(struct ArrowArrayStream *out_stream,
148  CSLConstList papszOptions = nullptr) override;
149 
150  virtual const char *GetName() override;
151  virtual OGRwkbGeometryType GetGeomType() override;
152  virtual OGRFeatureDefn *GetLayerDefn() override;
153 
154  virtual OGRSpatialReference *GetSpatialRef() override;
155 
156  virtual GIntBig GetFeatureCount(int bForce = TRUE) override;
157  virtual OGRErr GetExtent(int iGeomField, OGREnvelope *psExtent,
158  int bForce = TRUE) override;
159  virtual OGRErr GetExtent(OGREnvelope *psExtent, int bForce = TRUE) override;
160 
161  virtual int TestCapability(const char *) override;
162 
163  virtual OGRErr CreateField(OGRFieldDefn *poField,
164  int bApproxOK = TRUE) override;
165  virtual OGRErr DeleteField(int iField) override;
166  virtual OGRErr ReorderFields(int *panMap) override;
167  virtual OGRErr AlterFieldDefn(int iField, OGRFieldDefn *poNewFieldDefn,
168  int nFlags) override;
169  virtual OGRErr
170  AlterGeomFieldDefn(int iGeomField,
171  const OGRGeomFieldDefn *poNewGeomFieldDefn,
172  int nFlags) override;
173 
174  virtual OGRErr SyncToDisk() override;
175 
176  virtual OGRStyleTable *GetStyleTable() override;
177  virtual void SetStyleTableDirectly(OGRStyleTable *poStyleTable) override;
178 
179  virtual void SetStyleTable(OGRStyleTable *poStyleTable) override;
180 
181  virtual OGRErr StartTransaction() override;
182  virtual OGRErr CommitTransaction() override;
183  virtual OGRErr RollbackTransaction() override;
184 
185  virtual const char *GetFIDColumn() override;
186  virtual const char *GetGeometryColumn() override;
187 
188  virtual OGRErr SetIgnoredFields(const char **papszFields) override;
189 
190  virtual OGRErr Rename(const char *pszNewName) override;
191 };
192 
193 #endif /* #ifndef DOXYGEN_SKIP */
194 
195 #endif // OGRLAYERPOOL_H_INCLUDED
OGRStyleTable
This class represents a style table.
Definition: ogr_featurestyle.h:84
OGRSpatialReference
This class represents an OpenGIS Spatial Reference System, and contains methods for converting betwee...
Definition: ogr_spatialref.h:166
OGRGeometry
Abstract base class for all geometry classes.
Definition: ogr_geometry.h:334
OGRLayer
This class represents a layer of simple features, with access methods.
Definition: ogrsf_frmts.h:73
GDALDataset
A set of associated raster bands, usually from one file.
Definition: gdal_priv.h:348
CSLConstList
char ** CSLConstList
Type of a constant null-terminated list of nul terminated strings.
Definition: cpl_port.h:1178
ogrsf_frmts.h
OGRFieldDefn
Definition of an attribute of an OGRFeatureDefn.
Definition: ogr_feature.h:103
OGRGeomFieldDefn
Definition of a geometry field of an OGRFeatureDefn.
Definition: ogr_feature.h:286
OGRErr
int OGRErr
Type for a OGR error.
Definition: ogr_core.h:378
GIntBig
long long GIntBig
Large signed integer type (generally 64-bit integer type).
Definition: cpl_port.h:226
OGRwkbGeometryType
OGRwkbGeometryType
List of well known binary geometry types.
Definition: ogr_core.h:406
OGRFeature
A simple feature, including geometry and attributes.
Definition: ogr_feature.h:680
OGREnvelope
Simple container for a bounding region (rectangle)
Definition: ogr_core.h:57
OGRFeatureDefn
Definition of a feature class or feature layer.
Definition: ogr_feature.h:385
CPL_DISALLOW_COPY_ASSIGN
#define CPL_DISALLOW_COPY_ASSIGN(ClassName)
Helper to remove the copy and assignment constructors so that the compiler will not generate the defa...
Definition: cpl_port.h:1042