OGR
ogrlayerpool.h
1 /******************************************************************************
2  * $Id: ogrlayerpool.h 32177 2015-12-14 07:25:30Z goatbar $
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 #include "ogrsf_frmts.h"
34 
35 typedef OGRLayer* (*OpenLayerFunc)(void* user_data);
36 typedef void (*FreeUserDataFunc)(void* user_data);
37 
38 class OGRLayerPool;
39 
40 /************************************************************************/
41 /* OGRAbstractProxiedLayer */
42 /************************************************************************/
43 
45 {
46  friend class OGRLayerPool;
47 
48  OGRAbstractProxiedLayer *poPrevLayer; /* Chain to a layer that was used more recently */
49  OGRAbstractProxiedLayer *poNextLayer; /* Chain to a layer that was used less recently */
50 
51  protected:
52  OGRLayerPool *poPool;
53 
54  virtual void CloseUnderlyingLayer() = 0;
55 
56  public:
58  virtual ~OGRAbstractProxiedLayer();
59 };
60 
61 /************************************************************************/
62 /* OGRLayerPool */
63 /************************************************************************/
64 
66 {
67  protected:
68  OGRAbstractProxiedLayer *poMRULayer; /* the most recently used layer */
69  OGRAbstractProxiedLayer *poLRULayer; /* the least recently used layer (still opened) */
70  int nMRUListSize; /* the size of the list */
71  int nMaxSimultaneouslyOpened;
72 
73  public:
74  OGRLayerPool(int nMaxSimultaneouslyOpened = 100);
75  ~OGRLayerPool();
76 
77  void SetLastUsedLayer(OGRAbstractProxiedLayer* poProxiedLayer);
78  void UnchainLayer(OGRAbstractProxiedLayer* poProxiedLayer);
79 
80  int GetMaxSimultaneouslyOpened() const { return nMaxSimultaneouslyOpened; }
81  int GetSize() const { return nMRUListSize; }
82 };
83 
84 /************************************************************************/
85 /* OGRProxiedLayer */
86 /************************************************************************/
87 
89 {
90  OpenLayerFunc pfnOpenLayer;
91  FreeUserDataFunc pfnFreeUserData;
92  void *pUserData;
93  OGRLayer *poUnderlyingLayer;
94  OGRFeatureDefn *poFeatureDefn;
95  OGRSpatialReference *poSRS;
96 
97  int OpenUnderlyingLayer();
98 
99  protected:
100 
101  virtual void CloseUnderlyingLayer();
102 
103  public:
104 
106  OpenLayerFunc pfnOpenLayer,
107  FreeUserDataFunc pfnFreeUserData,
108  void* pUserData);
109  virtual ~OGRProxiedLayer();
110 
111  OGRLayer *GetUnderlyingLayer();
112 
113  virtual OGRGeometry *GetSpatialFilter();
114  virtual void SetSpatialFilter( OGRGeometry * );
115  virtual void SetSpatialFilter( int iGeomField, OGRGeometry * );
116 
117  virtual OGRErr SetAttributeFilter( const char * );
118 
119  virtual void ResetReading();
120  virtual OGRFeature *GetNextFeature();
121  virtual OGRErr SetNextByIndex( GIntBig nIndex );
122  virtual OGRFeature *GetFeature( GIntBig nFID );
123  virtual OGRErr ISetFeature( OGRFeature *poFeature );
124  virtual OGRErr ICreateFeature( OGRFeature *poFeature );
125  virtual OGRErr DeleteFeature( GIntBig nFID );
126 
127  virtual const char *GetName();
129  virtual OGRFeatureDefn *GetLayerDefn();
130 
132 
133  virtual GIntBig GetFeatureCount( int bForce = TRUE );
134  virtual OGRErr GetExtent(int iGeomField, OGREnvelope *psExtent, int bForce = TRUE);
135  virtual OGRErr GetExtent(OGREnvelope *psExtent, int bForce = TRUE);
136 
137  virtual int TestCapability( const char * );
138 
139  virtual OGRErr CreateField( OGRFieldDefn *poField,
140  int bApproxOK = TRUE );
141  virtual OGRErr DeleteField( int iField );
142  virtual OGRErr ReorderFields( int* panMap );
143  virtual OGRErr AlterFieldDefn( int iField, OGRFieldDefn* poNewFieldDefn, int nFlags );
144 
145  virtual OGRErr SyncToDisk();
146 
147  virtual OGRStyleTable *GetStyleTable();
148  virtual void SetStyleTableDirectly( OGRStyleTable *poStyleTable );
149 
150  virtual void SetStyleTable(OGRStyleTable *poStyleTable);
151 
152  virtual OGRErr StartTransaction();
153  virtual OGRErr CommitTransaction();
154  virtual OGRErr RollbackTransaction();
155 
156  virtual const char *GetFIDColumn();
157  virtual const char *GetGeometryColumn();
158 
159  virtual OGRErr SetIgnoredFields( const char **papszFields );
160 };
161 
162 #endif // OGRLAYERPOOL_H_INCLUDED
virtual OGRErr ISetFeature(OGRFeature *poFeature) CPL_WARN_UNUSED_RESULT
Rewrite an existing feature.
Definition: ogrlayer.cpp:596
virtual void SetStyleTable(OGRStyleTable *poStyleTable)
Set layer style table.
Definition: ogrlayer.cpp:1660
virtual const char * GetFIDColumn()
This method returns the name of the underlying database column being used as the FID column...
Definition: ogrlayer.cpp:1583
virtual OGRFeatureDefn * GetLayerDefn()=0
Fetch the schema information for this layer.
virtual OGRErr SetAttributeFilter(const char *)
Set a new attribute query.
Definition: ogrlayer.cpp:340
virtual OGRErr ICreateFeature(OGRFeature *poFeature) CPL_WARN_UNUSED_RESULT
Create and write a new feature within a layer.
Definition: ogrlayer.cpp:635
virtual void SetSpatialFilter(OGRGeometry *)
Set a new spatial filter.
Definition: ogrlayer.cpp:1106
virtual OGRErr SetNextByIndex(GIntBig nIndex)
Move read cursor to the nIndex&#39;th feature in the current resultset.
Definition: ogrlayer.cpp:498
Definition: ogrlayerpool.h:44
virtual OGRErr SetIgnoredFields(const char **papszFields)
Set which fields can be omitted when retrieving features from the layer.
Definition: ogrlayer.cpp:1775
virtual OGRGeometry * GetSpatialFilter()
This method returns the current spatial filter for this layer.
Definition: ogrlayer.cpp:1079
virtual void SetStyleTableDirectly(OGRStyleTable *poStyleTable)
Set layer style table.
Definition: ogrlayer.cpp:1649
virtual const char * GetName()
Return the layer name.
Definition: ogrlayer.cpp:1711
virtual OGRErr AlterFieldDefn(int iField, OGRFieldDefn *poNewFieldDefn, int nFlagsIn)
Alter the definition of an existing field on a layer.
Definition: ogrlayer.cpp:838
Definition: ogr_feature.h:206
virtual OGRErr ReorderFields(int *panMap)
Reorder all the fields of a layer.
Definition: ogrlayer.cpp:731
virtual OGRFeature * GetFeature(GIntBig nFID) CPL_WARN_UNUSED_RESULT
Fetch a feature by its identifier.
Definition: ogrlayer.cpp:446
Definition: ogr_feature.h:62
virtual const char * GetGeometryColumn()
This method returns the name of the underlying database column being used as the geometry column...
Definition: ogrlayer.cpp:1610
OGRwkbGeometryType
Definition: ogr_core.h:333
virtual GIntBig GetFeatureCount(int bForce=TRUE)
Fetch the feature count in this layer.
Definition: ogrlayer.cpp:171
Definition: ogr_geometry.h:104
virtual int TestCapability(const char *)=0
Test if this layer supported the named capability.
virtual void ResetReading()=0
Reset feature reading to start on the first feature.
Definition: ogrlayerpool.h:65
Definition: ogr_spatialref.h:129
Definition: ogr_core.h:48
virtual OGRErr SyncToDisk()
Flush pending changes to disk.
Definition: ogrlayer.cpp:1508
Definition: ogrsf_frmts.h:66
Definition: ogrlayerpool.h:88
virtual OGRErr GetExtent(OGREnvelope *psExtent, int bForce=TRUE) CPL_WARN_UNUSED_RESULT
Fetch the extent of this layer.
Definition: ogrlayer.cpp:212
virtual OGRErr CreateField(OGRFieldDefn *poField, int bApproxOK=TRUE)
Create a new field on a layer.
Definition: ogrlayer.cpp:663
Definition: ogr_feature.h:274
virtual OGRFeature * GetNextFeature() CPL_WARN_UNUSED_RESULT=0
Fetch the next available feature from this layer.
Definition: ogr_featurestyle.h:82
virtual OGRErr DeleteField(int iField)
Delete an existing field on a layer.
Definition: ogrlayer.cpp:699
virtual OGRStyleTable * GetStyleTable()
Returns layer style table.
Definition: ogrlayer.cpp:1640
virtual OGRErr DeleteFeature(GIntBig nFID) CPL_WARN_UNUSED_RESULT
Delete feature from layer.
Definition: ogrlayer.cpp:1535
virtual OGRSpatialReference * GetSpatialRef()
Fetch the spatial reference system for this layer.
Definition: ogrlayer.cpp:1032
virtual OGRwkbGeometryType GetGeomType()
Return the layer geometry type.
Definition: ogrlayer.cpp:1738

Generated for GDAL by doxygen 1.8.12.