GDAL

ogrlayerdecorator.h
1/******************************************************************************
2 * $Id$
3 *
4 * Project: OpenGIS Simple Features Reference Implementation
5 * Purpose: Defines OGRLayerDecorator class
6 * Author: Even Rouault, even dot rouault at spatialys.com
7 *
8 ******************************************************************************
9 * Copyright (c) 2012-2013, Even Rouault <even dot rouault at spatialys.com>
10 *
11 * SPDX-License-Identifier: MIT
12 ****************************************************************************/
13
14#ifndef OGRLAYERDECORATOR_H_INCLUDED
15#define OGRLAYERDECORATOR_H_INCLUDED
16
17#ifndef DOXYGEN_SKIP
18
19#include "ogrsf_frmts.h"
20
21 class CPL_DLL OGRLayerDecorator : public OGRLayer
22{
23 CPL_DISALLOW_COPY_ASSIGN(OGRLayerDecorator)
24
25 protected:
26 OGRLayer *m_poDecoratedLayer;
27 int m_bHasOwnership;
28
29 public:
30 OGRLayerDecorator(OGRLayer *poDecoratedLayer, int bTakeOwnership);
31 virtual ~OGRLayerDecorator();
32
33 virtual OGRGeometry *GetSpatialFilter() override;
34 virtual void SetSpatialFilter(OGRGeometry *) override;
35 virtual void SetSpatialFilterRect(double dfMinX, double dfMinY,
36 double dfMaxX, double dfMaxY) override;
37 virtual void SetSpatialFilter(int iGeomField, OGRGeometry *) override;
38 virtual void SetSpatialFilterRect(int iGeomField, double dfMinX,
39 double dfMinY, double dfMaxX,
40 double dfMaxY) override;
41
42 virtual OGRErr SetAttributeFilter(const char *) override;
43
44 virtual void ResetReading() override;
45 virtual OGRFeature *GetNextFeature() override;
46 virtual OGRErr SetNextByIndex(GIntBig nIndex) override;
47 virtual OGRFeature *GetFeature(GIntBig nFID) override;
48 virtual OGRErr ISetFeature(OGRFeature *poFeature) override;
49 virtual OGRErr ICreateFeature(OGRFeature *poFeature) override;
50 virtual OGRErr IUpsertFeature(OGRFeature *poFeature) override;
51 virtual OGRErr DeleteFeature(GIntBig nFID) override;
52 OGRErr IUpdateFeature(OGRFeature *poFeature, int nUpdatedFieldsCount,
53 const int *panUpdatedFieldsIdx,
54 int nUpdatedGeomFieldsCount,
55 const int *panUpdatedGeomFieldsIdx,
56 bool bUpdateStyleString) override;
57
58 virtual GDALDataset *GetDataset() override;
59 virtual bool GetArrowStream(struct ArrowArrayStream *out_stream,
60 CSLConstList papszOptions = nullptr) override;
61
62 virtual const char *GetName() override;
63 virtual OGRwkbGeometryType GetGeomType() override;
64 virtual OGRFeatureDefn *GetLayerDefn() override;
65
66 virtual OGRSpatialReference *GetSpatialRef() override;
67
68 virtual GIntBig GetFeatureCount(int bForce = TRUE) override;
69 virtual OGRErr GetExtent(int iGeomField, OGREnvelope *psExtent,
70 int bForce = TRUE) override;
71 virtual OGRErr GetExtent(OGREnvelope *psExtent, int bForce = TRUE) override;
72
73 virtual int TestCapability(const char *) override;
74
75 virtual OGRErr CreateField(const OGRFieldDefn *poField,
76 int bApproxOK = TRUE) override;
77 virtual OGRErr DeleteField(int iField) override;
78 virtual OGRErr ReorderFields(int *panMap) override;
79 virtual OGRErr AlterFieldDefn(int iField, OGRFieldDefn *poNewFieldDefn,
80 int nFlags) override;
81 virtual OGRErr
82 AlterGeomFieldDefn(int iGeomField,
83 const OGRGeomFieldDefn *poNewGeomFieldDefn,
84 int nFlags) override;
85
86 virtual OGRErr CreateGeomField(const OGRGeomFieldDefn *poField,
87 int bApproxOK = TRUE) override;
88
89 virtual OGRErr SyncToDisk() override;
90
91 virtual OGRStyleTable *GetStyleTable() override;
92 virtual void SetStyleTableDirectly(OGRStyleTable *poStyleTable) override;
93
94 virtual void SetStyleTable(OGRStyleTable *poStyleTable) override;
95
96 virtual OGRErr StartTransaction() override;
97 virtual OGRErr CommitTransaction() override;
98 virtual OGRErr RollbackTransaction() override;
99
100 virtual const char *GetFIDColumn() override;
101 virtual const char *GetGeometryColumn() override;
102
103 virtual OGRErr SetIgnoredFields(CSLConstList papszFields) override;
104
105 virtual char **GetMetadata(const char *pszDomain = "") override;
106 virtual CPLErr SetMetadata(char **papszMetadata,
107 const char *pszDomain = "") override;
108 virtual const char *GetMetadataItem(const char *pszName,
109 const char *pszDomain = "") override;
110 virtual CPLErr SetMetadataItem(const char *pszName, const char *pszValue,
111 const char *pszDomain = "") override;
112 virtual OGRErr Rename(const char *pszNewName) override;
113
114 OGRLayer *GetBaseLayer() const
115 {
116 return m_poDecoratedLayer;
117 }
118};
119
120#endif /* #ifndef DOXYGEN_SKIP */
121
122#endif // OGRLAYERDECORATOR_H_INCLUDED
GDALDataset
A set of associated raster bands, usually from one file.
Definition: gdal_priv.h:495
GDALMajorObject::SetMetadataItem
virtual CPLErr SetMetadataItem(const char *pszName, const char *pszValue, const char *pszDomain="")
Set single metadata item.
Definition: gdalmajorobject.cpp:369
GDALMajorObject::SetMetadata
virtual CPLErr SetMetadata(char **papszMetadata, const char *pszDomain="")
Set metadata.
Definition: gdalmajorobject.cpp:274
GDALMajorObject::GetMetadata
virtual char ** GetMetadata(const char *pszDomain="")
Fetch metadata.
Definition: gdalmajorobject.cpp:231
GDALMajorObject::GetMetadataItem
virtual const char * GetMetadataItem(const char *pszName, const char *pszDomain="")
Fetch single metadata item.
Definition: gdalmajorobject.cpp:325
OGREnvelope
Simple container for a bounding region (rectangle)
Definition: ogr_core.h:45
OGRFeatureDefn
Definition of a feature class or feature layer.
Definition: ogr_feature.h:501
OGRFeature
A simple feature, including geometry and attributes.
Definition: ogr_feature.h:877
OGRFieldDefn
Definition of an attribute of an OGRFeatureDefn.
Definition: ogr_feature.h:95
OGRGeomFieldDefn
Definition of a geometry field of an OGRFeatureDefn.
Definition: ogr_feature.h:330
OGRGeometry
Abstract base class for all geometry classes.
Definition: ogr_geometry.h:361
OGRLayer
This class represents a layer of simple features, with access methods.
Definition: ogrsf_frmts.h:58
OGRLayer::SetSpatialFilter
virtual void SetSpatialFilter(OGRGeometry *)
Set a new spatial filter.
Definition: ogrlayer.cpp:1472
OGRLayer::DeleteFeature
virtual OGRErr DeleteFeature(GIntBig nFID)
Delete feature from layer.
Definition: ogrlayer.cpp:1988
OGRLayer::SetStyleTableDirectly
virtual void SetStyleTableDirectly(OGRStyleTable *poStyleTable)
Set layer style table.
Definition: ogrlayer.cpp:2105
OGRLayer::StartTransaction
virtual OGRErr StartTransaction()
For datasources which support transactions, StartTransaction creates a transaction.
Definition: ogrlayer.cpp:1225
OGRLayer::GetName
virtual const char * GetName()
Return the layer name.
Definition: ogrlayer.cpp:2168
OGRLayer::GetFeatureCount
virtual GIntBig GetFeatureCount(int bForce=TRUE)
Fetch the feature count in this layer.
Definition: ogrlayer.cpp:158
OGRLayer::SetStyleTable
virtual void SetStyleTable(OGRStyleTable *poStyleTable)
Set layer style table.
Definition: ogrlayer.cpp:2116
OGRLayer::GetExtent
virtual OGRErr GetExtent(OGREnvelope *psExtent, int bForce=TRUE)
Fetch the extent of this layer.
Definition: ogrlayer.cpp:196
OGRLayer::IUpdateFeature
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:886
OGRLayer::IUpsertFeature
virtual OGRErr IUpsertFeature(OGRFeature *poFeature)
Rewrite/replace an existing feature or create a new feature within a layer.
Definition: ogrlayer.cpp:818
OGRLayer::GetArrowStream
virtual bool GetArrowStream(struct ArrowArrayStream *out_stream, CSLConstList papszOptions=nullptr)
Get a Arrow C stream.
Definition: ogrlayerarrow.cpp:2445
OGRLayer::ICreateFeature
virtual OGRErr ICreateFeature(OGRFeature *poFeature)
Create and write a new feature within a layer.
Definition: ogrlayer.cpp:778
OGRLayer::GetNextFeature
virtual OGRFeature * GetNextFeature()=0
Fetch the next available feature from this layer.
OGRLayer::AlterGeomFieldDefn
virtual OGRErr AlterGeomFieldDefn(int iGeomField, const OGRGeomFieldDefn *poNewGeomFieldDefn, int nFlagsIn)
Alter the definition of an existing geometry field on a layer.
Definition: ogrlayer.cpp:1154
OGRLayer::GetDataset
virtual GDALDataset * GetDataset()
Return the dataset associated with this layer.
Definition: ogrlayer.cpp:5782
OGRLayer::ISetFeature
virtual OGRErr ISetFeature(OGRFeature *poFeature)
Rewrite/replace an existing feature.
Definition: ogrlayer.cpp:738
OGRLayer::CreateField
virtual OGRErr CreateField(const OGRFieldDefn *poField, int bApproxOK=TRUE)
Create a new field on a layer.
Definition: ogrlayer.cpp:943
OGRLayer::CommitTransaction
virtual OGRErr CommitTransaction()
For datasources which support transactions, CommitTransaction commits a transaction.
Definition: ogrlayer.cpp:1252
OGRLayer::GetSpatialRef
virtual OGRSpatialReference * GetSpatialRef()
Fetch the spatial reference system for this layer.
Definition: ogrlayer.cpp:1354
OGRLayer::GetLayerDefn
virtual OGRFeatureDefn * GetLayerDefn()=0
Fetch the schema information for this layer.
OGRLayer::GetGeomType
virtual OGRwkbGeometryType GetGeomType()
Return the layer geometry type.
Definition: ogrlayer.cpp:2195
OGRLayer::CreateGeomField
virtual OGRErr CreateGeomField(const OGRGeomFieldDefn *poField, int bApproxOK=TRUE)
Create a new geometry field on a layer.
Definition: ogrlayer.cpp:1189
OGRLayer::ResetReading
virtual void ResetReading()=0
Reset feature reading to start on the first feature.
OGRLayer::DeleteField
virtual OGRErr DeleteField(int iField)
Delete an existing field on a layer.
Definition: ogrlayer.cpp:978
OGRLayer::SetIgnoredFields
virtual OGRErr SetIgnoredFields(CSLConstList papszFields)
Set which fields can be omitted when retrieving features from the layer.
Definition: ogrlayer.cpp:2232
OGRLayer::RollbackTransaction
virtual OGRErr RollbackTransaction()
For datasources which support transactions, RollbackTransaction will roll back a datasource to its st...
Definition: ogrlayer.cpp:1279
OGRLayer::SetNextByIndex
virtual OGRErr SetNextByIndex(GIntBig nIndex)
Move read cursor to the nIndex'th feature in the current resultset.
Definition: ogrlayer.cpp:583
OGRLayer::GetStyleTable
virtual OGRStyleTable * GetStyleTable()
Returns layer style table.
Definition: ogrlayer.cpp:2096
OGRLayer::SetAttributeFilter
virtual OGRErr SetAttributeFilter(const char *)
Set a new attribute query.
Definition: ogrlayer.cpp:421
OGRLayer::SetSpatialFilterRect
virtual void SetSpatialFilterRect(double dfMinX, double dfMinY, double dfMaxX, double dfMaxY)
Set a new rectangular spatial filter.
Definition: ogrlayer.cpp:1548
OGRLayer::GetFeature
virtual OGRFeature * GetFeature(GIntBig nFID)
Fetch a feature by its identifier.
Definition: ogrlayer.cpp:529
OGRLayer::GetSpatialFilter
virtual OGRGeometry * GetSpatialFilter()
This method returns the current spatial filter for this layer.
Definition: ogrlayer.cpp:1403
OGRLayer::Rename
virtual OGRErr Rename(const char *pszNewName)
Rename layer.
Definition: ogrlayer.cpp:2316
OGRLayer::SyncToDisk
virtual OGRErr SyncToDisk()
Flush pending changes to disk.
Definition: ogrlayer.cpp:1961
OGRLayer::ReorderFields
virtual OGRErr ReorderFields(int *panMap)
Reorder all the fields of a layer.
Definition: ogrlayer.cpp:1010
OGRLayer::TestCapability
virtual int TestCapability(const char *)=0
Test if this layer supported the named capability.
OGRLayer::GetFIDColumn
virtual const char * GetFIDColumn()
This method returns the name of the underlying database column being used as the FID column,...
Definition: ogrlayer.cpp:2039
OGRLayer::AlterFieldDefn
virtual OGRErr AlterFieldDefn(int iField, OGRFieldDefn *poNewFieldDefn, int nFlagsIn)
Alter the definition of an existing field on a layer.
Definition: ogrlayer.cpp:1117
OGRLayer::GetGeometryColumn
virtual const char * GetGeometryColumn()
This method returns the name of the underlying database column being used as the geometry column,...
Definition: ogrlayer.cpp:2066
OGRSpatialReference
This class represents an OpenGIS Spatial Reference System, and contains methods for converting betwee...
Definition: ogr_spatialref.h:153
OGRStyleTable
This class represents a style table.
Definition: ogr_featurestyle.h:70
CPLErr
CPLErr
Error category.
Definition: cpl_error.h:37
CPL_DISALLOW_COPY_ASSIGN
#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:1030
CSLConstList
char ** CSLConstList
Type of a constant null-terminated list of nul terminated strings.
Definition: cpl_port.h:1179
GIntBig
long long GIntBig
Large signed integer type (generally 64-bit integer type).
Definition: cpl_port.h:199
OGRwkbGeometryType
OGRwkbGeometryType
List of well known binary geometry types.
Definition: ogr_core.h:407
OGRErr
int OGRErr
Type for a OGR error.
Definition: ogr_core.h:371
ogrsf_frmts.h
Classes related to registration of format support, and opening datasets.