GDAL
ogrlayerdecorator.h
1/******************************************************************************
2 *
3 * Project: OpenGIS Simple Features Reference Implementation
4 * Purpose: Defines OGRLayerDecorator 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 OGRLAYERDECORATOR_H_INCLUDED
14#define OGRLAYERDECORATOR_H_INCLUDED
15
16#ifndef DOXYGEN_SKIP
17
18#include "ogrsf_frmts.h"
19
20class CPL_DLL OGRLayerDecorator : virtual public OGRLayer
21{
22 CPL_DISALLOW_COPY_ASSIGN(OGRLayerDecorator)
23
24 protected:
25 OGRLayer *m_poDecoratedLayer;
26 int m_bHasOwnership;
27
28 public:
29 OGRLayerDecorator(OGRLayer *poDecoratedLayer, int bTakeOwnership);
30 ~OGRLayerDecorator() override;
31
32 OGRGeometry *GetSpatialFilter() override;
33 virtual OGRErr ISetSpatialFilter(int iGeomField,
34 const OGRGeometry *) override;
35
36 OGRErr SetAttributeFilter(const char *) override;
37
38 void ResetReading() override;
39 OGRFeature *GetNextFeature() override;
40 OGRErr SetNextByIndex(GIntBig nIndex) override;
41 OGRFeature *GetFeature(GIntBig nFID) override;
42 OGRErr ISetFeature(OGRFeature *poFeature) override;
43 OGRErr ISetFeatureUniqPtr(std::unique_ptr<OGRFeature> poFeature) override;
44 OGRErr ICreateFeature(OGRFeature *poFeature) override;
45 OGRErr ICreateFeatureUniqPtr(std::unique_ptr<OGRFeature> poFeature,
46 GIntBig *pnFID) override;
47 OGRErr IUpsertFeature(OGRFeature *poFeature) override;
48 OGRErr DeleteFeature(GIntBig nFID) override;
49 OGRErr IUpdateFeature(OGRFeature *poFeature, int nUpdatedFieldsCount,
50 const int *panUpdatedFieldsIdx,
51 int nUpdatedGeomFieldsCount,
52 const int *panUpdatedGeomFieldsIdx,
53 bool bUpdateStyleString) override;
54
55 GDALDataset *GetDataset() override;
56 virtual bool GetArrowStream(struct ArrowArrayStream *out_stream,
57 CSLConstList papszOptions = nullptr) override;
58
59 const char *GetName() const override;
60 OGRwkbGeometryType GetGeomType() const override;
62 const OGRFeatureDefn *GetLayerDefn() const override;
63
64 const OGRSpatialReference *GetSpatialRef() const override;
65
66 GIntBig GetFeatureCount(int bForce = TRUE) override;
67 OGRErr IGetExtent(int iGeomField, OGREnvelope *psExtent,
68 bool bForce = true) override;
69 OGRErr IGetExtent3D(int iGeomField, OGREnvelope3D *psExtent,
70 bool bForce = true) override;
71
72 int TestCapability(const char *) const override;
73
74 virtual OGRErr CreateField(const OGRFieldDefn *poField,
75 int bApproxOK = TRUE) override;
76 OGRErr DeleteField(int iField) override;
77 OGRErr ReorderFields(int *panMap) override;
78 virtual OGRErr AlterFieldDefn(int iField, OGRFieldDefn *poNewFieldDefn,
79 int nFlags) override;
80 virtual OGRErr
81 AlterGeomFieldDefn(int iGeomField,
82 const OGRGeomFieldDefn *poNewGeomFieldDefn,
83 int nFlags) override;
84
85 virtual OGRErr CreateGeomField(const OGRGeomFieldDefn *poField,
86 int bApproxOK = TRUE) override;
87
88 OGRErr SyncToDisk() override;
89
90 OGRStyleTable *GetStyleTable() override;
91 void SetStyleTableDirectly(OGRStyleTable *poStyleTable) override;
92
93 void SetStyleTable(OGRStyleTable *poStyleTable) override;
94
95 OGRErr StartTransaction() override;
96 OGRErr CommitTransaction() override;
97 OGRErr RollbackTransaction() override;
98
99 const char *GetFIDColumn() const override;
100 const char *GetGeometryColumn() const override;
101
102 OGRErr SetIgnoredFields(CSLConstList papszFields) override;
103
104 CSLConstList GetMetadata(const char *pszDomain = "") override;
105 CPLErr SetMetadata(CSLConstList papszMetadata,
106 const char *pszDomain = "") override;
107 virtual const char *GetMetadataItem(const char *pszName,
108 const char *pszDomain = "") override;
109 CPLErr SetMetadataItem(const char *pszName, const char *pszValue,
110 const char *pszDomain = "") override;
111 OGRErr Rename(const char *pszNewName) override;
112
113 OGRLayer *GetBaseLayer() const
114 {
115 return m_poDecoratedLayer;
116 }
117};
118
119#endif /* #ifndef DOXYGEN_SKIP */
120
121#endif // OGRLAYERDECORATOR_H_INCLUDED
A set of associated raster bands, usually from one file.
Definition gdal_dataset.h:77
virtual CPLErr SetMetadataItem(const char *pszName, const char *pszValue, const char *pszDomain="")
Set single metadata item.
Definition gdalmajorobject.cpp:366
virtual CSLConstList GetMetadata(const char *pszDomain="")
Fetch metadata.
Definition gdalmajorobject.cpp:228
virtual CPLErr SetMetadata(CSLConstList papszMetadata, const char *pszDomain="")
Set metadata.
Definition gdalmajorobject.cpp:271
virtual const char * GetMetadataItem(const char *pszName, const char *pszDomain="")
Fetch single metadata item.
Definition gdalmajorobject.cpp:322
Simple container for a bounding region in 3D.
Definition ogr_core.h:217
Simple container for a bounding region (rectangle)
Definition ogr_core.h:44
Definition of a feature class or feature layer.
Definition ogr_feature.h:521
A simple feature, including geometry and attributes.
Definition ogr_feature.h:1041
Definition of an attribute of an OGRFeatureDefn.
Definition ogr_feature.h:72
Definition of a geometry field of an OGRFeatureDefn.
Definition ogr_feature.h:335
Abstract base class for all geometry classes.
Definition ogr_geometry.h:357
This class represents a layer of simple features, with access methods.
Definition ogrsf_frmts.h:61
virtual OGRErr ISetSpatialFilter(int iGeomField, const OGRGeometry *)
Set a new spatial filter.
Definition ogrlayer.cpp:3579
virtual OGRErr ICreateFeatureUniqPtr(std::unique_ptr< OGRFeature > poFeature, GIntBig *pnFID=nullptr)
Create and write a new feature within a layer, transferring ownership of the feature to the layer.
Definition ogrlayer.cpp:1680
virtual OGRErr IGetExtent3D(int iGeomField, OGREnvelope3D *psExtent3D, bool bForce)
Fetch the 3D extent of this layer, on the specified geometry field.
Definition ogrlayer.cpp:612
virtual OGRErr DeleteFeature(GIntBig nFID)
Delete feature from layer.
Definition ogrlayer.cpp:4520
virtual void SetStyleTableDirectly(OGRStyleTable *poStyleTable)
Set layer style table.
Definition ogrlayer.cpp:4718
virtual OGRErr StartTransaction()
For datasources which support transactions, StartTransaction creates a transaction.
Definition ogrlayer.cpp:2781
virtual GIntBig GetFeatureCount(int bForce=TRUE)
Fetch the feature count in this layer.
Definition ogrlayer.cpp:204
virtual void SetStyleTable(OGRStyleTable *poStyleTable)
Set layer style table.
Definition ogrlayer.cpp:4740
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:1929
virtual OGRErr IUpsertFeature(OGRFeature *poFeature)
Rewrite/replace an existing feature or create a new feature within a layer.
Definition ogrlayer.cpp:1743
virtual bool GetArrowStream(struct ArrowArrayStream *out_stream, CSLConstList papszOptions=nullptr)
Get a Arrow C stream.
Definition ogrlayerarrow.cpp:2746
virtual OGRErr ICreateFeature(OGRFeature *poFeature)
Create and write a new feature within a layer.
Definition ogrlayer.cpp:1569
virtual OGRFeature * GetNextFeature()=0
Fetch the next available feature from this layer.
virtual OGRErr AlterGeomFieldDefn(int iGeomField, const OGRGeomFieldDefn *poNewGeomFieldDefn, int nFlagsIn)
Alter the definition of an existing geometry field on a layer.
Definition ogrlayer.cpp:2596
virtual GDALDataset * GetDataset()
Return the dataset associated with this layer.
Definition ogrlayer.cpp:8535
virtual OGRErr ISetFeatureUniqPtr(std::unique_ptr< OGRFeature >)
Rewrite/replace an existing feature, transferring ownership of the feature to the layer.
Definition ogrlayer.cpp:1507
virtual int TestCapability(const char *) const =0
Test if this layer supported the named capability.
virtual OGRErr ISetFeature(OGRFeature *poFeature)
Rewrite/replace an existing feature.
Definition ogrlayer.cpp:1369
virtual const char * GetName() const
Return the layer name.
Definition ogrlayer.cpp:4807
virtual OGRErr CreateField(const OGRFieldDefn *poField, int bApproxOK=TRUE)
Create a new field on a layer.
Definition ogrlayer.cpp:2079
virtual const char * GetGeometryColumn() const
This method returns the name of the underlying database column being used as the geometry column,...
Definition ogrlayer.cpp:4645
virtual OGRErr CommitTransaction()
For datasources which support transactions, CommitTransaction commits a transaction.
Definition ogrlayer.cpp:2840
virtual OGRErr IGetExtent(int iGeomField, OGREnvelope *psExtent, bool bForce)
Fetch the extent of this layer, on the specified geometry field.
Definition ogrlayer.cpp:376
virtual OGRErr CreateGeomField(const OGRGeomFieldDefn *poField, int bApproxOK=TRUE)
Create a new geometry field on a layer.
Definition ogrlayer.cpp:2699
virtual const OGRFeatureDefn * GetLayerDefn() const =0
Fetch the schema information for this layer.
virtual const OGRSpatialReference * GetSpatialRef() const
Fetch the spatial reference system for this layer.
Definition ogrlayer.cpp:3103
virtual void ResetReading()=0
Reset feature reading to start on the first feature.
virtual OGRErr DeleteField(int iField)
Delete an existing field on a layer.
Definition ogrlayer.cpp:2170
virtual OGRErr SetIgnoredFields(CSLConstList papszFields)
Set which fields can be omitted when retrieving features from the layer.
Definition ogrlayer.cpp:4946
virtual OGRErr RollbackTransaction()
For datasources which support transactions, RollbackTransaction will roll back a datasource to its st...
Definition ogrlayer.cpp:2915
virtual OGRwkbGeometryType GetGeomType() const
Return the layer geometry type.
Definition ogrlayer.cpp:4870
virtual const char * GetFIDColumn() const
This method returns the name of the underlying database column being used as the FID column,...
Definition ogrlayer.cpp:4597
virtual OGRErr SetNextByIndex(GIntBig nIndex)
Move read cursor to the nIndex'th feature in the current resultset.
Definition ogrlayer.cpp:1057
virtual OGRStyleTable * GetStyleTable()
Returns layer style table.
Definition ogrlayer.cpp:4698
virtual OGRErr SetAttributeFilter(const char *)
Set a new attribute query.
Definition ogrlayer.cpp:752
virtual OGRFeature * GetFeature(GIntBig nFID)
Fetch a feature by its identifier.
Definition ogrlayer.cpp:942
virtual OGRGeometry * GetSpatialFilter()
This method returns the current spatial filter for this layer.
Definition ogrlayer.cpp:3381
virtual OGRErr Rename(const char *pszNewName)
Rename layer.
Definition ogrlayer.cpp:5052
virtual OGRErr SyncToDisk()
Flush pending changes to disk.
Definition ogrlayer.cpp:4453
virtual OGRErr ReorderFields(int *panMap)
Reorder all the fields of a layer.
Definition ogrlayer.cpp:2260
virtual OGRErr AlterFieldDefn(int iField, OGRFieldDefn *poNewFieldDefn, int nFlagsIn)
Alter the definition of an existing field on a layer.
Definition ogrlayer.cpp:2493
This class represents an OpenGIS Spatial Reference System, and contains methods for converting betwee...
Definition ogr_spatialref.h:152
This class represents a style table.
Definition ogr_featurestyle.h:69
CPLErr
Error category / error level.
Definition cpl_error.h:45
#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:1101
char ** CSLConstList
Type of a constant null-terminated list of nul terminated strings.
Definition cpl_port.h:1252
long long GIntBig
Large signed integer type (generally 64-bit integer type).
Definition cpl_port.h:195
OGRwkbGeometryType
List of well known binary geometry types.
Definition ogr_core.h:423
int OGRErr
Type for a OGR error.
Definition ogr_core.h:388
Classes related to registration of format support, and opening datasets.