GDAL
ogrlayerdecorator.h
1 /******************************************************************************
2  * $Id: ogrlayerdecorator.h 32467 2015-12-26 10:54:09Z rouault $
3  *
4  * Project: OpenGIS Simple Features Reference Implementation
5  * Purpose: Defines OGRLayerDecorator 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 OGRLAYERDECORATOR_H_INCLUDED
31 #define OGRLAYERDECORATOR_H_INCLUDED
32 
33 #include "ogrsf_frmts.h"
34 
35 class CPL_DLL OGRLayerDecorator : public OGRLayer
36 {
37  protected:
38  OGRLayer *m_poDecoratedLayer;
39  int m_bHasOwnership;
40 
41  public:
42 
43  OGRLayerDecorator(OGRLayer* poDecoratedLayer,
44  int bTakeOwnership);
45  virtual ~OGRLayerDecorator();
46 
47  virtual OGRGeometry *GetSpatialFilter();
48  virtual void SetSpatialFilter( OGRGeometry * );
49  virtual void SetSpatialFilterRect( double dfMinX, double dfMinY,
50  double dfMaxX, double dfMaxY );
51  virtual void SetSpatialFilter( int iGeomField, OGRGeometry * );
52  virtual void SetSpatialFilterRect( int iGeomField, double dfMinX, double dfMinY,
53  double dfMaxX, double dfMaxY );
54 
55  virtual OGRErr SetAttributeFilter( const char * );
56 
57  virtual void ResetReading();
58  virtual OGRFeature *GetNextFeature();
59  virtual OGRErr SetNextByIndex( GIntBig nIndex );
60  virtual OGRFeature *GetFeature( GIntBig nFID );
61  virtual OGRErr ISetFeature( OGRFeature *poFeature );
62  virtual OGRErr ICreateFeature( OGRFeature *poFeature );
63  virtual OGRErr DeleteFeature( GIntBig nFID );
64 
65  virtual const char *GetName();
67  virtual OGRFeatureDefn *GetLayerDefn();
68 
70 
71  virtual GIntBig GetFeatureCount( int bForce = TRUE );
72  virtual OGRErr GetExtent(int iGeomField, OGREnvelope *psExtent, int bForce = TRUE);
73  virtual OGRErr GetExtent(OGREnvelope *psExtent, int bForce = TRUE);
74 
75  virtual int TestCapability( const char * );
76 
77  virtual OGRErr CreateField( OGRFieldDefn *poField,
78  int bApproxOK = TRUE );
79  virtual OGRErr DeleteField( int iField );
80  virtual OGRErr ReorderFields( int* panMap );
81  virtual OGRErr AlterFieldDefn( int iField, OGRFieldDefn* poNewFieldDefn, int nFlags );
82 
83  virtual OGRErr CreateGeomField( OGRGeomFieldDefn *poField,
84  int bApproxOK = TRUE );
85 
86  virtual OGRErr SyncToDisk();
87 
88  virtual OGRStyleTable *GetStyleTable();
89  virtual void SetStyleTableDirectly( OGRStyleTable *poStyleTable );
90 
91  virtual void SetStyleTable(OGRStyleTable *poStyleTable);
92 
93  virtual OGRErr StartTransaction();
94  virtual OGRErr CommitTransaction();
95  virtual OGRErr RollbackTransaction();
96 
97  virtual const char *GetFIDColumn();
98  virtual const char *GetGeometryColumn();
99 
100  virtual OGRErr SetIgnoredFields( const char **papszFields );
101 
102  virtual char **GetMetadata( const char * pszDomain = "" );
103  virtual CPLErr SetMetadata( char ** papszMetadata,
104  const char * pszDomain = "" );
105  virtual const char *GetMetadataItem( const char * pszName,
106  const char * pszDomain = "" );
107  virtual CPLErr SetMetadataItem( const char * pszName,
108  const char * pszValue,
109  const char * pszDomain = "" );
110 
111  OGRLayer* GetBaseLayer() { return m_poDecoratedLayer; }
112 };
113 
114 #endif // OGRLAYERDECORATOR_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'th feature in the current resultset.
Definition: ogrlayer.cpp:498
Definition of a geometry field of an OGRFeatureDefn.
Definition: ogr_feature.h:143
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
Definition: ogrlayerdecorator.h:35
virtual OGRErr CreateGeomField(OGRGeomFieldDefn *poField, int bApproxOK=TRUE)
Create a new geometry field on a layer.
Definition: ogrlayer.cpp:872
virtual char ** GetMetadata(const char *pszDomain="")
Fetch metadata.
Definition: gdalmajorobject.cpp:243
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 of a feature class or feature layer.
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
virtual void SetSpatialFilterRect(double dfMinX, double dfMinY, double dfMaxX, double dfMaxY)
Set a new rectangular spatial filter.
Definition: ogrlayer.cpp:1176
Definition of an attribute of an OGRFeatureDefn.
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
virtual const char * GetMetadataItem(const char *pszName, const char *pszDomain="")
Fetch single metadata item.
Definition: gdalmajorobject.cpp:331
OGRwkbGeometryType
List of well known binary geometry types.
Definition: ogr_core.h:333
virtual GIntBig GetFeatureCount(int bForce=TRUE)
Fetch the feature count in this layer.
Definition: ogrlayer.cpp:171
Abstract base class for all geometry classes.
Definition: ogr_geometry.h:104
Classes related to registration of format support, and opening datasets.
virtual CPLErr SetMetadata(char **papszMetadata, const char *pszDomain="")
Set metadata.
Definition: gdalmajorobject.cpp:286
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.
This class represents an OpenGIS Spatial Reference System, and contains methods for converting betwee...
Definition: ogr_spatialref.h:129
Simple container for a bounding region.
Definition: ogr_core.h:48
virtual OGRErr SyncToDisk()
Flush pending changes to disk.
Definition: ogrlayer.cpp:1508
This class represents a layer of simple features, with access methods.
Definition: ogrsf_frmts.h:66
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
A simple feature, including geometry and attributes.
Definition: ogr_feature.h:274
virtual OGRFeature * GetNextFeature() CPL_WARN_UNUSED_RESULT=0
Fetch the next available feature from this layer.
This class represents a style table.
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 CPLErr SetMetadataItem(const char *pszName, const char *pszValue, const char *pszDomain="")
Set single metadata item.
Definition: gdalmajorobject.cpp:374
virtual OGRwkbGeometryType GetGeomType()
Return the layer geometry type.
Definition: ogrlayer.cpp:1738

Generated for GDAL by doxygen 1.8.6.