GDAL
ogrlayerpool.h
1 /******************************************************************************
2  * $Id: ogrlayerpool.h 10e54d45fee8229428eb8ab22949aa46eb9da150 2018-05-06 11:07:25 +0200 Even Rouault $
3  *
4  * Project: OpenGIS Simple Features Reference Implementation
5  * Purpose: Defines OGRLayerPool and OGRProxiedLayer class
6  * Author: Even Rouault, even dot rouault at mines dash paris dot org
7  *
8  ******************************************************************************
9  * Copyright (c) 2012-2013, Even Rouault <even dot rouault at mines-paris dot org>
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 OGRAbstractProxiedLayer : public OGRLayer
47 {
48  CPL_DISALLOW_COPY_ASSIGN(OGRAbstractProxiedLayer)
49 
50  friend class OGRLayerPool;
51 
52  OGRAbstractProxiedLayer *poPrevLayer; /* Chain to a layer that was used more recently */
53  OGRAbstractProxiedLayer *poNextLayer; /* Chain to a layer that was used less recently */
54 
55  protected:
56  OGRLayerPool *poPool;
57 
58  virtual void CloseUnderlyingLayer() = 0;
59 
60  public:
61  explicit OGRAbstractProxiedLayer(OGRLayerPool* poPool);
62  virtual ~OGRAbstractProxiedLayer();
63 };
64 
65 /************************************************************************/
66 /* OGRLayerPool */
67 /************************************************************************/
68 
69 class OGRLayerPool
70 {
71  CPL_DISALLOW_COPY_ASSIGN(OGRLayerPool)
72 
73  protected:
74  OGRAbstractProxiedLayer *poMRULayer; /* the most recently used layer */
75  OGRAbstractProxiedLayer *poLRULayer; /* the least recently used layer (still opened) */
76  int nMRUListSize; /* the size of the list */
77  int nMaxSimultaneouslyOpened;
78 
79  public:
80  explicit OGRLayerPool(int nMaxSimultaneouslyOpened = 100);
81  ~OGRLayerPool();
82 
83  void SetLastUsedLayer(OGRAbstractProxiedLayer* poProxiedLayer);
84  void UnchainLayer(OGRAbstractProxiedLayer* poProxiedLayer);
85 
86  int GetMaxSimultaneouslyOpened() const { return nMaxSimultaneouslyOpened; }
87  int GetSize() const { return nMRUListSize; }
88 };
89 
90 /************************************************************************/
91 /* OGRProxiedLayer */
92 /************************************************************************/
93 
94 class OGRProxiedLayer : public OGRAbstractProxiedLayer
95 {
96  CPL_DISALLOW_COPY_ASSIGN(OGRProxiedLayer)
97 
98  OpenLayerFunc pfnOpenLayer;
99  FreeUserDataFunc pfnFreeUserData;
100  void *pUserData;
101  OGRLayer *poUnderlyingLayer;
102  OGRFeatureDefn *poFeatureDefn;
103  OGRSpatialReference *poSRS;
104 
105  int OpenUnderlyingLayer();
106 
107  protected:
108 
109  virtual void CloseUnderlyingLayer() override;
110 
111  public:
112 
113  OGRProxiedLayer(OGRLayerPool* poPool,
114  OpenLayerFunc pfnOpenLayer,
115  FreeUserDataFunc pfnFreeUserData,
116  void* pUserData);
117  virtual ~OGRProxiedLayer();
118 
119  OGRLayer *GetUnderlyingLayer();
120 
121  virtual OGRGeometry *GetSpatialFilter() override;
122  virtual void SetSpatialFilter( OGRGeometry * ) override;
123  virtual void SetSpatialFilter( int iGeomField, OGRGeometry * ) override;
124 
125  virtual OGRErr SetAttributeFilter( const char * ) override;
126 
127  virtual void ResetReading() override;
128  virtual OGRFeature *GetNextFeature() override;
129  virtual OGRErr SetNextByIndex( GIntBig nIndex ) override;
130  virtual OGRFeature *GetFeature( GIntBig nFID ) override;
131  virtual OGRErr ISetFeature( OGRFeature *poFeature ) override;
132  virtual OGRErr ICreateFeature( OGRFeature *poFeature ) override;
133  virtual OGRErr DeleteFeature( GIntBig nFID ) override;
134 
135  virtual const char *GetName() override;
136  virtual OGRwkbGeometryType GetGeomType() override;
137  virtual OGRFeatureDefn *GetLayerDefn() override;
138 
139  virtual OGRSpatialReference *GetSpatialRef() override;
140 
141  virtual GIntBig GetFeatureCount( int bForce = TRUE ) override;
142  virtual OGRErr GetExtent(int iGeomField, OGREnvelope *psExtent, int bForce = TRUE) override;
143  virtual OGRErr GetExtent(OGREnvelope *psExtent, int bForce = TRUE) override;
144 
145  virtual int TestCapability( const char * ) override;
146 
147  virtual OGRErr CreateField( OGRFieldDefn *poField,
148  int bApproxOK = TRUE ) override;
149  virtual OGRErr DeleteField( int iField ) override;
150  virtual OGRErr ReorderFields( int* panMap ) override;
151  virtual OGRErr AlterFieldDefn( int iField, OGRFieldDefn* poNewFieldDefn, int nFlags ) override;
152 
153  virtual OGRErr SyncToDisk() override;
154 
155  virtual OGRStyleTable *GetStyleTable() override;
156  virtual void SetStyleTableDirectly( OGRStyleTable *poStyleTable ) override;
157 
158  virtual void SetStyleTable(OGRStyleTable *poStyleTable) override;
159 
160  virtual OGRErr StartTransaction() override;
161  virtual OGRErr CommitTransaction() override;
162  virtual OGRErr RollbackTransaction() override;
163 
164  virtual const char *GetFIDColumn() override;
165  virtual const char *GetGeometryColumn() override;
166 
167  virtual OGRErr SetIgnoredFields( const char **papszFields ) override;
168 };
169 
170 #endif /* #ifndef DOXYGEN_SKIP */
171 
172 #endif // OGRLAYERPOOL_H_INCLUDED
OGRFeatureDefn
Definition of a feature class or feature layer.
Definition: ogr_feature.h:259
OGRFieldDefn
Definition of an attribute of an OGRFeatureDefn.
Definition: ogr_feature.h:92
OGRwkbGeometryType
OGRwkbGeometryType
List of well known binary geometry types.
Definition: ogr_core.h:317
OGRGeometry
Abstract base class for all geometry classes.
Definition: ogr_geometry.h:286
ogrsf_frmts.h
Classes related to registration of format support, and opening datasets.
OGRSpatialReference
This class represents an OpenGIS Spatial Reference System, and contains methods for converting betwee...
Definition: ogr_spatialref.h:147
OGRLayer
This class represents a layer of simple features, with access methods.
Definition: ogrsf_frmts.h:70
OGRFeature
A simple feature, including geometry and attributes.
Definition: ogr_feature.h:354
OGRStyleTable
This class represents a style table.
Definition: ogr_featurestyle.h:84
GIntBig
long long GIntBig
Large signed integer type (generally 64-bit integer type).
Definition: cpl_port.h:248
OGRErr
int OGRErr
Simple container for a bounding region.
Definition: ogr_core.h:290
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:989
Generated for GDAL by doxygen 1.8.13.