OGR
ogrlayerpool.h
1 /******************************************************************************
2  * $Id: ogrlayerpool.h 24642 2012-07-01 20:45:46Z 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, Even Rouault <even dot rouault at mines dash 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  virtual OGRGeometry *GetSpatialFilter();
112  virtual void SetSpatialFilter( OGRGeometry * );
113 
114  virtual OGRErr SetAttributeFilter( const char * );
115 
116  virtual void ResetReading();
117  virtual OGRFeature *GetNextFeature();
118  virtual OGRErr SetNextByIndex( long nIndex );
119  virtual OGRFeature *GetFeature( long nFID );
120  virtual OGRErr SetFeature( OGRFeature *poFeature );
121  virtual OGRErr CreateFeature( OGRFeature *poFeature );
122  virtual OGRErr DeleteFeature( long nFID );
123 
124  virtual const char *GetName();
126  virtual OGRFeatureDefn *GetLayerDefn();
127 
129 
130  virtual int GetFeatureCount( int bForce = TRUE );
131  virtual OGRErr GetExtent(OGREnvelope *psExtent, int bForce = TRUE);
132 
133  virtual int TestCapability( const char * );
134 
135  /* Deprecated (and un-implemented method) --> we won't decorate it ! */
136  /* virtual const char *GetInfo( const char * ); */
137 
138  virtual OGRErr CreateField( OGRFieldDefn *poField,
139  int bApproxOK = TRUE );
140  virtual OGRErr DeleteField( int iField );
141  virtual OGRErr ReorderFields( int* panMap );
142  virtual OGRErr AlterFieldDefn( int iField, OGRFieldDefn* poNewFieldDefn, int nFlags );
143 
144  virtual OGRErr SyncToDisk();
145 
146  virtual OGRStyleTable *GetStyleTable();
147  virtual void SetStyleTableDirectly( OGRStyleTable *poStyleTable );
148 
149  virtual void SetStyleTable(OGRStyleTable *poStyleTable);
150 
151  virtual OGRErr StartTransaction();
152  virtual OGRErr CommitTransaction();
153  virtual OGRErr RollbackTransaction();
154 
155  virtual const char *GetFIDColumn();
156  virtual const char *GetGeometryColumn();
157 
158  virtual OGRErr SetIgnoredFields( const char **papszFields );
159 };
160 
161 #endif // _OGRLAYERPOOL_H_INCLUDED

Generated for GDAL by doxygen 1.8.4.