GDAL

ogrlayerpool.h
1/******************************************************************************
2 *
3 * Project: OpenGIS Simple Features Reference Implementation
4 * Purpose: Defines OGRLayerPool and OGRProxiedLayer class
5 * Author: Even Rouault, even dot rouault at spatialys.com
6 *
7 ******************************************************************************
8 * Copyright (c) 2012-2013, Even Rouault <even dot rouault at spatialys.com>
9 *
10 * SPDX-License-Identifier: MIT
11 ****************************************************************************/
12
13#ifndef OGRLAYERPOOL_H_INCLUDED
14#define OGRLAYERPOOL_H_INCLUDED
15
16#ifndef DOXYGEN_SKIP
17
18#include "ogrsf_frmts.h"
19
20#include <mutex>
21
22 typedef OGRLayer *(*OpenLayerFunc)(void *user_data);
23 typedef void (*ReleaseLayerFunc)(OGRLayer *, void *user_data);
24 typedef void (*FreeUserDataFunc)(void *user_data);
25
26 class OGRLayerPool;
27
28/************************************************************************/
29/* OGRAbstractProxiedLayer */
30/************************************************************************/
31
32 class CPL_DLL OGRAbstractProxiedLayer : public OGRLayer
33{
34 CPL_DISALLOW_COPY_ASSIGN(OGRAbstractProxiedLayer)
35
36 friend class OGRLayerPool;
37
38 OGRAbstractProxiedLayer
39 *poPrevLayer; /* Chain to a layer that was used more recently */
40 OGRAbstractProxiedLayer
41 *poNextLayer; /* Chain to a layer that was used less recently */
42
43 protected:
44 OGRLayerPool *poPool;
45
46 virtual void CloseUnderlyingLayer() = 0;
47
48 public:
49 explicit OGRAbstractProxiedLayer(OGRLayerPool *poPool);
50 ~OGRAbstractProxiedLayer() override;
51};
52
53/************************************************************************/
54/* OGRLayerPool */
55/************************************************************************/
56
57 class CPL_DLL OGRLayerPool
58{
59 CPL_DISALLOW_COPY_ASSIGN(OGRLayerPool)
60
61 protected:
62 OGRAbstractProxiedLayer *poMRULayer; /* the most recently used layer */
63 OGRAbstractProxiedLayer
64 *poLRULayer; /* the least recently used layer (still opened) */
65 int nMRUListSize; /* the size of the list */
66 int nMaxSimultaneouslyOpened;
67
68 public:
69 explicit OGRLayerPool(int nMaxSimultaneouslyOpened = 100);
70 ~OGRLayerPool();
71
72 void SetLastUsedLayer(OGRAbstractProxiedLayer *poProxiedLayer);
73 void UnchainLayer(OGRAbstractProxiedLayer *poProxiedLayer);
74
75 int GetMaxSimultaneouslyOpened() const
76 {
77 return nMaxSimultaneouslyOpened;
78 }
79
80 int GetSize() const
81 {
82 return nMRUListSize;
83 }
84};
85
86/************************************************************************/
87/* OGRProxiedLayer */
88/************************************************************************/
89
90 class CPL_DLL OGRProxiedLayer : public OGRAbstractProxiedLayer
91{
92 CPL_DISALLOW_COPY_ASSIGN(OGRProxiedLayer)
93
94 OpenLayerFunc pfnOpenLayer;
95 ReleaseLayerFunc pfnReleaseLayer;
96 FreeUserDataFunc pfnFreeUserData;
97 void *pUserData;
98 mutable OGRLayer *poUnderlyingLayer;
99 mutable OGRFeatureDefn *poFeatureDefn;
100 mutable OGRSpatialReference *poSRS;
101 mutable std::recursive_mutex m_oMutex{};
102
103 int OpenUnderlyingLayer() const;
104
105 protected:
106 void CloseUnderlyingLayer() override;
107
108 public:
109 OGRProxiedLayer(OGRLayerPool *poPool, OpenLayerFunc pfnOpenLayer,
110 FreeUserDataFunc pfnFreeUserData, void *pUserData);
111 OGRProxiedLayer(OGRLayerPool *poPool, OpenLayerFunc pfnOpenLayer,
112 ReleaseLayerFunc pfnReleaseLayer,
113 FreeUserDataFunc pfnFreeUserData, void *pUserData);
114 ~OGRProxiedLayer() override;
115
116 OGRLayer *GetUnderlyingLayer();
117
118 OGRGeometry *GetSpatialFilter() override;
119 virtual OGRErr ISetSpatialFilter(int iGeomField,
120 const OGRGeometry *) override;
121
122 OGRErr SetAttributeFilter(const char *) override;
123
124 void ResetReading() override;
125 OGRFeature *GetNextFeature() override;
126 OGRErr SetNextByIndex(GIntBig nIndex) override;
127 OGRFeature *GetFeature(GIntBig nFID) override;
128 OGRErr ISetFeature(OGRFeature *poFeature) override;
129 OGRErr ICreateFeature(OGRFeature *poFeature) override;
130 OGRErr IUpsertFeature(OGRFeature *poFeature) override;
131 OGRErr IUpdateFeature(OGRFeature *poFeature, int nUpdatedFieldsCount,
132 const int *panUpdatedFieldsIdx,
133 int nUpdatedGeomFieldsCount,
134 const int *panUpdatedGeomFieldsIdx,
135 bool bUpdateStyleString) override;
136 OGRErr DeleteFeature(GIntBig nFID) override;
137
138 GDALDataset *GetDataset() override;
139 virtual bool GetArrowStream(struct ArrowArrayStream *out_stream,
140 CSLConstList papszOptions = nullptr) override;
141
142 const char *GetName() const override;
143 OGRwkbGeometryType GetGeomType() const override;
144 const OGRFeatureDefn *GetLayerDefn() const override;
145
146 const OGRSpatialReference *GetSpatialRef() const override;
147
148 GIntBig GetFeatureCount(int bForce = TRUE) override;
149 OGRErr IGetExtent(int iGeomField, OGREnvelope *psExtent,
150 bool bForce) override;
151
152 int TestCapability(const char *) const override;
153
154 virtual OGRErr CreateField(const OGRFieldDefn *poField,
155 int bApproxOK = TRUE) override;
156 OGRErr DeleteField(int iField) override;
157 OGRErr ReorderFields(int *panMap) override;
158 virtual OGRErr AlterFieldDefn(int iField, OGRFieldDefn *poNewFieldDefn,
159 int nFlags) override;
160 virtual OGRErr
161 AlterGeomFieldDefn(int iGeomField,
162 const OGRGeomFieldDefn *poNewGeomFieldDefn,
163 int nFlags) override;
164
165 OGRErr SyncToDisk() override;
166
167 OGRStyleTable *GetStyleTable() override;
168 void SetStyleTableDirectly(OGRStyleTable *poStyleTable) override;
169
170 void SetStyleTable(OGRStyleTable *poStyleTable) override;
171
172 OGRErr StartTransaction() override;
173 OGRErr CommitTransaction() override;
174 OGRErr RollbackTransaction() override;
175
176 const char *GetFIDColumn() const override;
177 const char *GetGeometryColumn() const override;
178
179 OGRErr SetIgnoredFields(CSLConstList papszFields) override;
180
181 OGRErr Rename(const char *pszNewName) override;
182};
183
184#endif /* #ifndef DOXYGEN_SKIP */
185
186#endif // OGRLAYERPOOL_H_INCLUDED
GDALDataset
A set of associated raster bands, usually from one file.
Definition gdal_dataset.h:76
OGREnvelope
Simple container for a bounding region (rectangle)
Definition ogr_core.h:44
OGRFeatureDefn
Definition of a feature class or feature layer.
Definition ogr_feature.h:504
OGRFeature
A simple feature, including geometry and attributes.
Definition ogr_feature.h:934
OGRFieldDefn
Definition of an attribute of an OGRFeatureDefn.
Definition ogr_feature.h:69
OGRGeomFieldDefn
Definition of a geometry field of an OGRFeatureDefn.
Definition ogr_feature.h:332
OGRGeometry
Abstract base class for all geometry classes.
Definition ogr_geometry.h:357
OGRLayer
This class represents a layer of simple features, with access methods.
Definition ogrsf_frmts.h:61
OGRLayer::ISetSpatialFilter
virtual OGRErr ISetSpatialFilter(int iGeomField, const OGRGeometry *)
Set a new spatial filter.
Definition ogrlayer.cpp:3398
OGRLayer::DeleteFeature
virtual OGRErr DeleteFeature(GIntBig nFID)
Delete feature from layer.
Definition ogrlayer.cpp:4338
OGRLayer::SetStyleTableDirectly
virtual void SetStyleTableDirectly(OGRStyleTable *poStyleTable)
Set layer style table.
Definition ogrlayer.cpp:4536
OGRLayer::StartTransaction
virtual OGRErr StartTransaction()
For datasources which support transactions, StartTransaction creates a transaction.
Definition ogrlayer.cpp:2600
OGRLayer::GetFeatureCount
virtual GIntBig GetFeatureCount(int bForce=TRUE)
Fetch the feature count in this layer.
Definition ogrlayer.cpp:205
OGRLayer::SetStyleTable
virtual void SetStyleTable(OGRStyleTable *poStyleTable)
Set layer style table.
Definition ogrlayer.cpp:4558
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:1748
OGRLayer::IUpsertFeature
virtual OGRErr IUpsertFeature(OGRFeature *poFeature)
Rewrite/replace an existing feature or create a new feature within a layer.
Definition ogrlayer.cpp:1562
OGRLayer::GetArrowStream
virtual bool GetArrowStream(struct ArrowArrayStream *out_stream, CSLConstList papszOptions=nullptr)
Get a Arrow C stream.
Definition ogrlayerarrow.cpp:2584
OGRLayer::ICreateFeature
virtual OGRErr ICreateFeature(OGRFeature *poFeature)
Create and write a new feature within a layer.
Definition ogrlayer.cpp:1462
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:2415
OGRLayer::GetDataset
virtual GDALDataset * GetDataset()
Return the dataset associated with this layer.
Definition ogrlayer.cpp:8353
OGRLayer::TestCapability
virtual int TestCapability(const char *) const =0
Test if this layer supported the named capability.
OGRLayer::ISetFeature
virtual OGRErr ISetFeature(OGRFeature *poFeature)
Rewrite/replace an existing feature.
Definition ogrlayer.cpp:1343
OGRLayer::GetName
virtual const char * GetName() const
Return the layer name.
Definition ogrlayer.cpp:4625
OGRLayer::CreateField
virtual OGRErr CreateField(const OGRFieldDefn *poField, int bApproxOK=TRUE)
Create a new field on a layer.
Definition ogrlayer.cpp:1898
OGRLayer::GetGeometryColumn
virtual const char * GetGeometryColumn() const
This method returns the name of the underlying database column being used as the geometry column,...
Definition ogrlayer.cpp:4463
OGRLayer::CommitTransaction
virtual OGRErr CommitTransaction()
For datasources which support transactions, CommitTransaction commits a transaction.
Definition ogrlayer.cpp:2659
OGRLayer::IGetExtent
virtual OGRErr IGetExtent(int iGeomField, OGREnvelope *psExtent, bool bForce)
Fetch the extent of this layer, on the specified geometry field.
Definition ogrlayer.cpp:377
OGRLayer::GetLayerDefn
virtual const OGRFeatureDefn * GetLayerDefn() const =0
Fetch the schema information for this layer.
OGRLayer::GetSpatialRef
virtual const OGRSpatialReference * GetSpatialRef() const
Fetch the spatial reference system for this layer.
Definition ogrlayer.cpp:2922
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:1989
OGRLayer::SetIgnoredFields
virtual OGRErr SetIgnoredFields(CSLConstList papszFields)
Set which fields can be omitted when retrieving features from the layer.
Definition ogrlayer.cpp:4764
OGRLayer::RollbackTransaction
virtual OGRErr RollbackTransaction()
For datasources which support transactions, RollbackTransaction will roll back a datasource to its st...
Definition ogrlayer.cpp:2734
OGRLayer::GetGeomType
virtual OGRwkbGeometryType GetGeomType() const
Return the layer geometry type.
Definition ogrlayer.cpp:4688
OGRLayer::GetFIDColumn
virtual const char * GetFIDColumn() const
This method returns the name of the underlying database column being used as the FID column,...
Definition ogrlayer.cpp:4415
OGRLayer::SetNextByIndex
virtual OGRErr SetNextByIndex(GIntBig nIndex)
Move read cursor to the nIndex'th feature in the current resultset.
Definition ogrlayer.cpp:1033
OGRLayer::GetStyleTable
virtual OGRStyleTable * GetStyleTable()
Returns layer style table.
Definition ogrlayer.cpp:4516
OGRLayer::SetAttributeFilter
virtual OGRErr SetAttributeFilter(const char *)
Set a new attribute query.
Definition ogrlayer.cpp:751
OGRLayer::GetFeature
virtual OGRFeature * GetFeature(GIntBig nFID)
Fetch a feature by its identifier.
Definition ogrlayer.cpp:918
OGRLayer::GetSpatialFilter
virtual OGRGeometry * GetSpatialFilter()
This method returns the current spatial filter for this layer.
Definition ogrlayer.cpp:3200
OGRLayer::Rename
virtual OGRErr Rename(const char *pszNewName)
Rename layer.
Definition ogrlayer.cpp:4870
OGRLayer::SyncToDisk
virtual OGRErr SyncToDisk()
Flush pending changes to disk.
Definition ogrlayer.cpp:4271
OGRLayer::ReorderFields
virtual OGRErr ReorderFields(int *panMap)
Reorder all the fields of a layer.
Definition ogrlayer.cpp:2079
OGRLayer::AlterFieldDefn
virtual OGRErr AlterFieldDefn(int iField, OGRFieldDefn *poNewFieldDefn, int nFlagsIn)
Alter the definition of an existing field on a layer.
Definition ogrlayer.cpp:2312
OGRSpatialReference
This class represents an OpenGIS Spatial Reference System, and contains methods for converting betwee...
Definition ogr_spatialref.h:152
OGRStyleTable
This class represents a style table.
Definition ogr_featurestyle.h:69
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:936
CSLConstList
char ** CSLConstList
Type of a constant null-terminated list of nul terminated strings.
Definition cpl_port.h:1087
GIntBig
long long GIntBig
Large signed integer type (generally 64-bit integer type).
Definition cpl_port.h:205
OGRwkbGeometryType
OGRwkbGeometryType
List of well known binary geometry types.
Definition ogr_core.h:405
OGRErr
int OGRErr
Type for a OGR error.
Definition ogr_core.h:370
ogrsf_frmts.h
Classes related to registration of format support, and opening datasets.