GDAL

- Main Page
- Related Pages
- Classes
- Files
- Download
- Issue Tracker

- File List
- File Members

ogrlayerpool.h
1 /******************************************************************************
2 * $Id: ogrlayerpool.h 36501 2016-11-25 14:09:24Z 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 friend class OGRLayerPool;
49
50 OGRAbstractProxiedLayer *poPrevLayer; /* Chain to a layer that was used more recently */
51 OGRAbstractProxiedLayer *poNextLayer; /* Chain to a layer that was used less recently */
52
53 protected:
54 OGRLayerPool *poPool;
55
56 virtual void CloseUnderlyingLayer() = 0;
57
58 public:
59 explicit OGRAbstractProxiedLayer(OGRLayerPool* poPool);
60 virtual ~OGRAbstractProxiedLayer();
61 };
62
63 /************************************************************************/
64 /* OGRLayerPool */
65 /************************************************************************/
66
67 class OGRLayerPool
68 {
69 protected:
70 OGRAbstractProxiedLayer *poMRULayer; /* the most recently used layer */
71 OGRAbstractProxiedLayer *poLRULayer; /* the least recently used layer (still opened) */
72 int nMRUListSize; /* the size of the list */
73 int nMaxSimultaneouslyOpened;
74
75 public:
76 explicit OGRLayerPool(int nMaxSimultaneouslyOpened = 100);
77 ~OGRLayerPool();
78
79 void SetLastUsedLayer(OGRAbstractProxiedLayer* poProxiedLayer);
80 void UnchainLayer(OGRAbstractProxiedLayer* poProxiedLayer);
81
82 int GetMaxSimultaneouslyOpened() const { return nMaxSimultaneouslyOpened; }
83 int GetSize() const { return nMRUListSize; }
84 };
85
86 /************************************************************************/
87 /* OGRProxiedLayer */
88 /************************************************************************/
89
90 class OGRProxiedLayer : public OGRAbstractProxiedLayer
91 {
92 OpenLayerFunc pfnOpenLayer;
93 FreeUserDataFunc pfnFreeUserData;
94 void *pUserData;
95 OGRLayer *poUnderlyingLayer;
96 OGRFeatureDefn *poFeatureDefn;
97 OGRSpatialReference *poSRS;
98
99 int OpenUnderlyingLayer();
100
101 protected:
102
103 virtual void CloseUnderlyingLayer() override;
104
105 public:
106
107 OGRProxiedLayer(OGRLayerPool* poPool,
108 OpenLayerFunc pfnOpenLayer,
109 FreeUserDataFunc pfnFreeUserData,
110 void* pUserData);
111 virtual ~OGRProxiedLayer();
112
113 OGRLayer *GetUnderlyingLayer();
114
115 virtual OGRGeometry *GetSpatialFilter() override;
116 virtual void SetSpatialFilter( OGRGeometry * ) override;
117 virtual void SetSpatialFilter( int iGeomField, OGRGeometry * ) override;
118
119 virtual OGRErr SetAttributeFilter( const char * ) override;
120
121 virtual void ResetReading() override;
122 virtual OGRFeature *GetNextFeature() override;
123 virtual OGRErr SetNextByIndex( GIntBig nIndex ) override;
124 virtual OGRFeature *GetFeature( GIntBig nFID ) override;
125 virtual OGRErr ISetFeature( OGRFeature *poFeature ) override;
126 virtual OGRErr ICreateFeature( OGRFeature *poFeature ) override;
127 virtual OGRErr DeleteFeature( GIntBig nFID ) override;
128
129 virtual const char *GetName() override;
130 virtual OGRwkbGeometryType GetGeomType() override;
131 virtual OGRFeatureDefn *GetLayerDefn() override;
132
133 virtual OGRSpatialReference *GetSpatialRef() override;
134
135 virtual GIntBig GetFeatureCount( int bForce = TRUE ) override;
136 virtual OGRErr GetExtent(int iGeomField, OGREnvelope *psExtent, int bForce = TRUE) override;
137 virtual OGRErr GetExtent(OGREnvelope *psExtent, int bForce = TRUE) override;
138
139 virtual int TestCapability( const char * ) override;
140
141 virtual OGRErr CreateField( OGRFieldDefn *poField,
142 int bApproxOK = TRUE ) override;
143 virtual OGRErr DeleteField( int iField ) override;
144 virtual OGRErr ReorderFields( int* panMap ) override;
145 virtual OGRErr AlterFieldDefn( int iField, OGRFieldDefn* poNewFieldDefn, int nFlags ) override;
146
147 virtual OGRErr SyncToDisk() override;
148
149 virtual OGRStyleTable *GetStyleTable() override;
150 virtual void SetStyleTableDirectly( OGRStyleTable *poStyleTable ) override;
151
152 virtual void SetStyleTable(OGRStyleTable *poStyleTable) override;
153
154 virtual OGRErr StartTransaction() override;
155 virtual OGRErr CommitTransaction() override;
156 virtual OGRErr RollbackTransaction() override;
157
158 virtual const char *GetFIDColumn() override;
159 virtual const char *GetGeometryColumn() override;
160
161 virtual OGRErr SetIgnoredFields( const char **papszFields ) override;
162 };
163
164 #endif /* #ifndef DOXYGEN_SKIP */
165
166 #endif // OGRLAYERPOOL_H_INCLUDED
OGRFeatureDefn
Definition of a feature class or feature layer.
Definition: ogr_feature.h:207
OGRFieldDefn
Definition of an attribute of an OGRFeatureDefn.
Definition: ogr_feature.h:62
OGRwkbGeometryType
OGRwkbGeometryType
List of well known binary geometry types.
Definition: ogr_core.h:312
OGRGeometry
Abstract base class for all geometry classes.
Definition: ogr_geometry.h:118
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:132
OGRLayer
This class represents a layer of simple features, with access methods.
Definition: ogrsf_frmts.h:68
OGRFeature
A simple feature, including geometry and attributes.
Definition: ogr_feature.h:279
OGRStyleTable
This class represents a style table.
Definition: ogr_featurestyle.h:83
GIntBig
long long GIntBig
Large signed integer type (generally 64-bit integer type).
Definition: cpl_port.h:250
OGRErr
int OGRErr
Simple container for a bounding region.
Definition: ogr_core.h:285

Generated for GDAL by 1.8.8.