GDAL
ogrlayerdecorator.h
1 /******************************************************************************
2  * $Id: ogrlayerdecorator.h 36501 2016-11-25 14:09:24Z 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 #ifndef DOXYGEN_SKIP
34 
35 #include "ogrsf_frmts.h"
36 
37 class CPL_DLL OGRLayerDecorator : public OGRLayer
38 {
39  protected:
40  OGRLayer *m_poDecoratedLayer;
41  int m_bHasOwnership;
42 
43  public:
44 
45  OGRLayerDecorator(OGRLayer* poDecoratedLayer,
46  int bTakeOwnership);
47  virtual ~OGRLayerDecorator();
48 
49  virtual OGRGeometry *GetSpatialFilter() override;
50  virtual void SetSpatialFilter( OGRGeometry * ) override;
51  virtual void SetSpatialFilterRect( double dfMinX, double dfMinY,
52  double dfMaxX, double dfMaxY ) override;
53  virtual void SetSpatialFilter( int iGeomField, OGRGeometry * ) override;
54  virtual void SetSpatialFilterRect( int iGeomField, double dfMinX, double dfMinY,
55  double dfMaxX, double dfMaxY ) override;
56 
57  virtual OGRErr SetAttributeFilter( const char * ) override;
58 
59  virtual void ResetReading() override;
60  virtual OGRFeature *GetNextFeature() override;
61  virtual OGRErr SetNextByIndex( GIntBig nIndex ) override;
62  virtual OGRFeature *GetFeature( GIntBig nFID ) override;
63  virtual OGRErr ISetFeature( OGRFeature *poFeature ) override;
64  virtual OGRErr ICreateFeature( OGRFeature *poFeature ) override;
65  virtual OGRErr DeleteFeature( GIntBig nFID ) override;
66 
67  virtual const char *GetName() override;
68  virtual OGRwkbGeometryType GetGeomType() override;
69  virtual OGRFeatureDefn *GetLayerDefn() override;
70 
71  virtual OGRSpatialReference *GetSpatialRef() override;
72 
73  virtual GIntBig GetFeatureCount( int bForce = TRUE ) override;
74  virtual OGRErr GetExtent(int iGeomField, OGREnvelope *psExtent, int bForce = TRUE) override;
75  virtual OGRErr GetExtent(OGREnvelope *psExtent, int bForce = TRUE) override;
76 
77  virtual int TestCapability( const char * ) override;
78 
79  virtual OGRErr CreateField( OGRFieldDefn *poField,
80  int bApproxOK = TRUE ) override;
81  virtual OGRErr DeleteField( int iField ) override;
82  virtual OGRErr ReorderFields( int* panMap ) override;
83  virtual OGRErr AlterFieldDefn( int iField, OGRFieldDefn* poNewFieldDefn, int nFlags ) override;
84 
85  virtual OGRErr CreateGeomField( OGRGeomFieldDefn *poField,
86  int bApproxOK = TRUE ) override;
87 
88  virtual OGRErr SyncToDisk() override;
89 
90  virtual OGRStyleTable *GetStyleTable() override;
91  virtual void SetStyleTableDirectly( OGRStyleTable *poStyleTable ) override;
92 
93  virtual void SetStyleTable(OGRStyleTable *poStyleTable) override;
94 
95  virtual OGRErr StartTransaction() override;
96  virtual OGRErr CommitTransaction() override;
97  virtual OGRErr RollbackTransaction() override;
98 
99  virtual const char *GetFIDColumn() override;
100  virtual const char *GetGeometryColumn() override;
101 
102  virtual OGRErr SetIgnoredFields( const char **papszFields ) override;
103 
104  virtual char **GetMetadata( const char * pszDomain = "" ) override;
105  virtual CPLErr SetMetadata( char ** papszMetadata,
106  const char * pszDomain = "" ) override;
107  virtual const char *GetMetadataItem( const char * pszName,
108  const char * pszDomain = "" ) override;
109  virtual CPLErr SetMetadataItem( const char * pszName,
110  const char * pszValue,
111  const char * pszDomain = "" ) override;
112 
113  OGRLayer* GetBaseLayer() { return m_poDecoratedLayer; }
114 };
115 
116 #endif /* #ifndef DOXYGEN_SKIP */
117 
118 #endif // OGRLAYERDECORATOR_H_INCLUDED
virtual OGRErr ISetFeature(OGRFeature *poFeature) CPL_WARN_UNUSED_RESULT
Rewrite an existing feature.
Definition: ogrlayer.cpp:595
virtual void SetStyleTable(OGRStyleTable *poStyleTable)
Set layer style table.
Definition: ogrlayer.cpp:1665
virtual const char * GetFIDColumn()
This method returns the name of the underlying database column being used as the FID column...
Definition: ogrlayer.cpp:1588
virtual OGRFeatureDefn * GetLayerDefn()=0
Fetch the schema information for this layer.
virtual OGRErr SetAttributeFilter(const char *)
Set a new attribute query.
Definition: ogrlayer.cpp:337
virtual OGRErr ICreateFeature(OGRFeature *poFeature) CPL_WARN_UNUSED_RESULT
Create and write a new feature within a layer.
Definition: ogrlayer.cpp:634
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:497
Definition of a geometry field of an OGRFeatureDefn.
Definition: ogr_feature.h:141
virtual OGRErr SetIgnoredFields(const char **papszFields)
Set which fields can be omitted when retrieving features from the layer.
Definition: ogrlayer.cpp:1780
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:1654
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:249
virtual const char * GetName()
Return the layer name.
Definition: ogrlayer.cpp:1716
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:207
virtual OGRErr ReorderFields(int *panMap)
Reorder all the fields of a layer.
Definition: ogrlayer.cpp:730
virtual OGRFeature * GetFeature(GIntBig nFID) CPL_WARN_UNUSED_RESULT
Fetch a feature by its identifier.
Definition: ogrlayer.cpp:445
virtual void SetSpatialFilterRect(double dfMinX, double dfMinY, double dfMaxX, double dfMaxY)
Set a new rectangular spatial filter.
Definition: ogrlayer.cpp:1175
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:1615
virtual const char * GetMetadataItem(const char *pszName, const char *pszDomain="")
Fetch single metadata item.
Definition: gdalmajorobject.cpp:344
OGRwkbGeometryType
List of well known binary geometry types.
Definition: ogr_core.h:301
virtual GIntBig GetFeatureCount(int bForce=TRUE)
Fetch the feature count in this layer.
Definition: ogrlayer.cpp:166
Abstract base class for all geometry classes.
Definition: ogr_geometry.h:118
Classes related to registration of format support, and opening datasets.
virtual OGRErr RollbackTransaction()
For datasources which support transactions, RollbackTransaction will roll back a datasource to its st...
Definition: ogrlayer.cpp:962
virtual CPLErr SetMetadata(char **papszMetadata, const char *pszDomain="")
Set metadata.
Definition: gdalmajorobject.cpp:292
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:132
virtual OGRErr SyncToDisk()
Flush pending changes to disk.
Definition: ogrlayer.cpp:1511
This class represents a layer of simple features, with access methods.
Definition: ogrsf_frmts.h:68
virtual OGRErr GetExtent(OGREnvelope *psExtent, int bForce=TRUE) CPL_WARN_UNUSED_RESULT
Fetch the extent of this layer.
Definition: ogrlayer.cpp:207
virtual OGRErr CreateField(OGRFieldDefn *poField, int bApproxOK=TRUE)
Create a new field on a layer.
Definition: ogrlayer.cpp:662
virtual OGRErr CommitTransaction() CPL_WARN_UNUSED_RESULT
For datasources which support transactions, CommitTransaction commits a transaction.
Definition: ogrlayer.cpp:935
A simple feature, including geometry and attributes.
Definition: ogr_feature.h:279
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:83
virtual OGRErr DeleteField(int iField)
Delete an existing field on a layer.
Definition: ogrlayer.cpp:698
long long GIntBig
Large signed integer type (generally 64-bit integer type).
Definition: cpl_port.h:250
virtual OGRStyleTable * GetStyleTable()
Returns layer style table.
Definition: ogrlayer.cpp:1645
virtual OGRErr DeleteFeature(GIntBig nFID) CPL_WARN_UNUSED_RESULT
Delete feature from layer.
Definition: ogrlayer.cpp:1538
virtual OGRSpatialReference * GetSpatialRef()
Fetch the spatial reference system for this layer.
Definition: ogrlayer.cpp:1032
int OGRErr
Simple container for a bounding region.
Definition: ogr_core.h:274
virtual CPLErr SetMetadataItem(const char *pszName, const char *pszValue, const char *pszDomain="")
Set single metadata item.
Definition: gdalmajorobject.cpp:388
virtual OGRwkbGeometryType GetGeomType()
Return the layer geometry type.
Definition: ogrlayer.cpp:1743
CPLErr
Error category.
Definition: cpl_error.h:52
virtual OGRErr StartTransaction() CPL_WARN_UNUSED_RESULT
For datasources which support transactions, StartTransaction creates a transaction.
Definition: ogrlayer.cpp:908

Generated for GDAL by doxygen 1.8.8.