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 * SPDX-License-Identifier: MIT
12 ****************************************************************************/
13
14#ifndef OGRLAYERPOOL_H_INCLUDED
15#define OGRLAYERPOOL_H_INCLUDED
16
17#ifndef DOXYGEN_SKIP
18
19#include "ogrsf_frmts.h"
20
21 typedef OGRLayer *(*OpenLayerFunc)(void *user_data);
22 typedef void (*FreeUserDataFunc)(void *user_data);
23
24 class OGRLayerPool;
25
26/************************************************************************/
27/* OGRAbstractProxiedLayer */
28/************************************************************************/
29
30 class CPL_DLL OGRAbstractProxiedLayer : public OGRLayer
31{
32 CPL_DISALLOW_COPY_ASSIGN(OGRAbstractProxiedLayer)
33
34 friend class OGRLayerPool;
35
36 OGRAbstractProxiedLayer
37 *poPrevLayer; /* Chain to a layer that was used more recently */
38 OGRAbstractProxiedLayer
39 *poNextLayer; /* Chain to a layer that was used less recently */
40
41 protected:
42 OGRLayerPool *poPool;
43
44 virtual void CloseUnderlyingLayer() = 0;
45
46 public:
47 explicit OGRAbstractProxiedLayer(OGRLayerPool *poPool);
48 virtual ~OGRAbstractProxiedLayer();
49};
50
51/************************************************************************/
52/* OGRLayerPool */
53/************************************************************************/
54
55 class CPL_DLL OGRLayerPool
56{
57 CPL_DISALLOW_COPY_ASSIGN(OGRLayerPool)
58
59 protected:
60 OGRAbstractProxiedLayer *poMRULayer; /* the most recently used layer */
61 OGRAbstractProxiedLayer
62 *poLRULayer; /* the least recently used layer (still opened) */
63 int nMRUListSize; /* the size of the list */
64 int nMaxSimultaneouslyOpened;
65
66 public:
67 explicit OGRLayerPool(int nMaxSimultaneouslyOpened = 100);
68 ~OGRLayerPool();
69
70 void SetLastUsedLayer(OGRAbstractProxiedLayer *poProxiedLayer);
71 void UnchainLayer(OGRAbstractProxiedLayer *poProxiedLayer);
72
73 int GetMaxSimultaneouslyOpened() const
74 {
75 return nMaxSimultaneouslyOpened;
76 }
77
78 int GetSize() const
79 {
80 return nMRUListSize;
81 }
82};
83
84/************************************************************************/
85/* OGRProxiedLayer */
86/************************************************************************/
87
88 class CPL_DLL OGRProxiedLayer : public OGRAbstractProxiedLayer
89{
90 CPL_DISALLOW_COPY_ASSIGN(OGRProxiedLayer)
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 virtual void CloseUnderlyingLayer() override;
103
104 public:
105 OGRProxiedLayer(OGRLayerPool *poPool, OpenLayerFunc pfnOpenLayer,
106 FreeUserDataFunc pfnFreeUserData, void *pUserData);
107 virtual ~OGRProxiedLayer();
108
109 OGRLayer *GetUnderlyingLayer();
110
111 virtual OGRGeometry *GetSpatialFilter() override;
112 virtual void SetSpatialFilter(OGRGeometry *) override;
113 virtual void SetSpatialFilter(int iGeomField, OGRGeometry *) override;
114
115 virtual OGRErr SetAttributeFilter(const char *) override;
116
117 virtual void ResetReading() override;
118 virtual OGRFeature *GetNextFeature() override;
119 virtual OGRErr SetNextByIndex(GIntBig nIndex) override;
120 virtual OGRFeature *GetFeature(GIntBig nFID) override;
121 virtual OGRErr ISetFeature(OGRFeature *poFeature) override;
122 virtual OGRErr ICreateFeature(OGRFeature *poFeature) override;
123 virtual OGRErr IUpsertFeature(OGRFeature *poFeature) override;
124 OGRErr IUpdateFeature(OGRFeature *poFeature, int nUpdatedFieldsCount,
125 const int *panUpdatedFieldsIdx,
126 int nUpdatedGeomFieldsCount,
127 const int *panUpdatedGeomFieldsIdx,
128 bool bUpdateStyleString) override;
129 virtual OGRErr DeleteFeature(GIntBig nFID) override;
130
131 virtual GDALDataset *GetDataset() override;
132 virtual bool GetArrowStream(struct ArrowArrayStream *out_stream,
133 CSLConstList papszOptions = nullptr) 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,
143 int bForce = TRUE) override;
144 virtual OGRErr GetExtent(OGREnvelope *psExtent, int bForce = TRUE) override;
145
146 virtual int TestCapability(const char *) override;
147
148 virtual OGRErr CreateField(const OGRFieldDefn *poField,
149 int bApproxOK = TRUE) override;
150 virtual OGRErr DeleteField(int iField) override;
151 virtual OGRErr ReorderFields(int *panMap) override;
152 virtual OGRErr AlterFieldDefn(int iField, OGRFieldDefn *poNewFieldDefn,
153 int nFlags) override;
154 virtual OGRErr
155 AlterGeomFieldDefn(int iGeomField,
156 const OGRGeomFieldDefn *poNewGeomFieldDefn,
157 int nFlags) override;
158
159 virtual OGRErr SyncToDisk() override;
160
161 virtual OGRStyleTable *GetStyleTable() override;
162 virtual void SetStyleTableDirectly(OGRStyleTable *poStyleTable) override;
163
164 virtual void SetStyleTable(OGRStyleTable *poStyleTable) override;
165
166 virtual OGRErr StartTransaction() override;
167 virtual OGRErr CommitTransaction() override;
168 virtual OGRErr RollbackTransaction() override;
169
170 virtual const char *GetFIDColumn() override;
171 virtual const char *GetGeometryColumn() override;
172
173 virtual OGRErr SetIgnoredFields(CSLConstList papszFields) override;
174
175 virtual OGRErr Rename(const char *pszNewName) override;
176};
177
178#endif /* #ifndef DOXYGEN_SKIP */
179
180#endif // OGRLAYERPOOL_H_INCLUDED
GDALDataset
A set of associated raster bands, usually from one file.
Definition gdal_priv.h:495
OGREnvelope
Simple container for a bounding region (rectangle)
Definition ogr_core.h:45
OGRFeatureDefn
Definition of a feature class or feature layer.
Definition ogr_feature.h:501
OGRFeature
A simple feature, including geometry and attributes.
Definition ogr_feature.h:877
OGRFieldDefn
Definition of an attribute of an OGRFeatureDefn.
Definition ogr_feature.h:95
OGRGeomFieldDefn
Definition of a geometry field of an OGRFeatureDefn.
Definition ogr_feature.h:330
OGRGeometry
Abstract base class for all geometry classes.
Definition ogr_geometry.h:361
OGRLayer
This class represents a layer of simple features, with access methods.
Definition ogrsf_frmts.h:58
OGRLayer::SetSpatialFilter
virtual void SetSpatialFilter(OGRGeometry *)
Set a new spatial filter.
Definition ogrlayer.cpp:1472
OGRLayer::DeleteFeature
virtual OGRErr DeleteFeature(GIntBig nFID)
Delete feature from layer.
Definition ogrlayer.cpp:1988
OGRLayer::SetStyleTableDirectly
virtual void SetStyleTableDirectly(OGRStyleTable *poStyleTable)
Set layer style table.
Definition ogrlayer.cpp:2105
OGRLayer::StartTransaction
virtual OGRErr StartTransaction()
For datasources which support transactions, StartTransaction creates a transaction.
Definition ogrlayer.cpp:1225
OGRLayer::GetName
virtual const char * GetName()
Return the layer name.
Definition ogrlayer.cpp:2168
OGRLayer::GetFeatureCount
virtual GIntBig GetFeatureCount(int bForce=TRUE)
Fetch the feature count in this layer.
Definition ogrlayer.cpp:158
OGRLayer::SetStyleTable
virtual void SetStyleTable(OGRStyleTable *poStyleTable)
Set layer style table.
Definition ogrlayer.cpp:2116
OGRLayer::GetExtent
virtual OGRErr GetExtent(OGREnvelope *psExtent, int bForce=TRUE)
Fetch the extent of this layer.
Definition ogrlayer.cpp:196
OGRLayer::IUpdateFeature
virtual OGRErr IUpdateFeature(OGRFeature *poFeature, int nUpdatedFieldsCount, const int *panUpdatedFieldsIdx, int nUpdatedGeomFieldsCount, const int *panUpdatedGeomFieldsIdx, bool bUpdateStyleString)
Update (part of) an existing feature.
Definition ogrlayer.cpp:886
OGRLayer::IUpsertFeature
virtual OGRErr IUpsertFeature(OGRFeature *poFeature)
Rewrite/replace an existing feature or create a new feature within a layer.
Definition ogrlayer.cpp:818
OGRLayer::GetArrowStream
virtual bool GetArrowStream(struct ArrowArrayStream *out_stream, CSLConstList papszOptions=nullptr)
Get a Arrow C stream.
Definition ogrlayerarrow.cpp:2445
OGRLayer::ICreateFeature
virtual OGRErr ICreateFeature(OGRFeature *poFeature)
Create and write a new feature within a layer.
Definition ogrlayer.cpp:778
OGRLayer::GetNextFeature
virtual OGRFeature * GetNextFeature()=0
Fetch the next available feature from this layer.
OGRLayer::AlterGeomFieldDefn
virtual OGRErr AlterGeomFieldDefn(int iGeomField, const OGRGeomFieldDefn *poNewGeomFieldDefn, int nFlagsIn)
Alter the definition of an existing geometry field on a layer.
Definition ogrlayer.cpp:1154
OGRLayer::GetDataset
virtual GDALDataset * GetDataset()
Return the dataset associated with this layer.
Definition ogrlayer.cpp:5782
OGRLayer::ISetFeature
virtual OGRErr ISetFeature(OGRFeature *poFeature)
Rewrite/replace an existing feature.
Definition ogrlayer.cpp:738
OGRLayer::CreateField
virtual OGRErr CreateField(const OGRFieldDefn *poField, int bApproxOK=TRUE)
Create a new field on a layer.
Definition ogrlayer.cpp:943
OGRLayer::CommitTransaction
virtual OGRErr CommitTransaction()
For datasources which support transactions, CommitTransaction commits a transaction.
Definition ogrlayer.cpp:1252
OGRLayer::GetSpatialRef
virtual OGRSpatialReference * GetSpatialRef()
Fetch the spatial reference system for this layer.
Definition ogrlayer.cpp:1354
OGRLayer::GetLayerDefn
virtual OGRFeatureDefn * GetLayerDefn()=0
Fetch the schema information for this layer.
OGRLayer::GetGeomType
virtual OGRwkbGeometryType GetGeomType()
Return the layer geometry type.
Definition ogrlayer.cpp:2195
OGRLayer::ResetReading
virtual void ResetReading()=0
Reset feature reading to start on the first feature.
OGRLayer::DeleteField
virtual OGRErr DeleteField(int iField)
Delete an existing field on a layer.
Definition ogrlayer.cpp:978
OGRLayer::SetIgnoredFields
virtual OGRErr SetIgnoredFields(CSLConstList papszFields)
Set which fields can be omitted when retrieving features from the layer.
Definition ogrlayer.cpp:2232
OGRLayer::RollbackTransaction
virtual OGRErr RollbackTransaction()
For datasources which support transactions, RollbackTransaction will roll back a datasource to its st...
Definition ogrlayer.cpp:1279
OGRLayer::SetNextByIndex
virtual OGRErr SetNextByIndex(GIntBig nIndex)
Move read cursor to the nIndex'th feature in the current resultset.
Definition ogrlayer.cpp:583
OGRLayer::GetStyleTable
virtual OGRStyleTable * GetStyleTable()
Returns layer style table.
Definition ogrlayer.cpp:2096
OGRLayer::SetAttributeFilter
virtual OGRErr SetAttributeFilter(const char *)
Set a new attribute query.
Definition ogrlayer.cpp:421
OGRLayer::GetFeature
virtual OGRFeature * GetFeature(GIntBig nFID)
Fetch a feature by its identifier.
Definition ogrlayer.cpp:529
OGRLayer::GetSpatialFilter
virtual OGRGeometry * GetSpatialFilter()
This method returns the current spatial filter for this layer.
Definition ogrlayer.cpp:1403
OGRLayer::Rename
virtual OGRErr Rename(const char *pszNewName)
Rename layer.
Definition ogrlayer.cpp:2316
OGRLayer::SyncToDisk
virtual OGRErr SyncToDisk()
Flush pending changes to disk.
Definition ogrlayer.cpp:1961
OGRLayer::ReorderFields
virtual OGRErr ReorderFields(int *panMap)
Reorder all the fields of a layer.
Definition ogrlayer.cpp:1010
OGRLayer::TestCapability
virtual int TestCapability(const char *)=0
Test if this layer supported the named capability.
OGRLayer::GetFIDColumn
virtual const char * GetFIDColumn()
This method returns the name of the underlying database column being used as the FID column,...
Definition ogrlayer.cpp:2039
OGRLayer::AlterFieldDefn
virtual OGRErr AlterFieldDefn(int iField, OGRFieldDefn *poNewFieldDefn, int nFlagsIn)
Alter the definition of an existing field on a layer.
Definition ogrlayer.cpp:1117
OGRLayer::GetGeometryColumn
virtual const char * GetGeometryColumn()
This method returns the name of the underlying database column being used as the geometry column,...
Definition ogrlayer.cpp:2066
OGRSpatialReference
This class represents an OpenGIS Spatial Reference System, and contains methods for converting betwee...
Definition ogr_spatialref.h:153
OGRStyleTable
This class represents a style table.
Definition ogr_featurestyle.h:70
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:1030
CSLConstList
char ** CSLConstList
Type of a constant null-terminated list of nul terminated strings.
Definition cpl_port.h:1179
GIntBig
long long GIntBig
Large signed integer type (generally 64-bit integer type).
Definition cpl_port.h:199
OGRwkbGeometryType
OGRwkbGeometryType
List of well known binary geometry types.
Definition ogr_core.h:407
OGRErr
int OGRErr
Type for a OGR error.
Definition ogr_core.h:371
ogrsf_frmts.h
Classes related to registration of format support, and opening datasets.