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
20 class 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 ICreateFeature(OGRFeature *poFeature) override;
44 OGRErr IUpsertFeature(OGRFeature *poFeature) override;
45 OGRErr DeleteFeature(GIntBig nFID) override;
46 OGRErr IUpdateFeature(OGRFeature *poFeature, int nUpdatedFieldsCount,
47 const int *panUpdatedFieldsIdx,
48 int nUpdatedGeomFieldsCount,
49 const int *panUpdatedGeomFieldsIdx,
50 bool bUpdateStyleString) override;
51
52 GDALDataset *GetDataset() override;
53 virtual bool GetArrowStream(struct ArrowArrayStream *out_stream,
54 CSLConstList papszOptions = nullptr) override;
55
56 const char *GetName() const override;
57 OGRwkbGeometryType GetGeomType() const override;
58 using OGRLayer::GetLayerDefn;
59 const OGRFeatureDefn *GetLayerDefn() const override;
60
61 const OGRSpatialReference *GetSpatialRef() const override;
62
63 GIntBig GetFeatureCount(int bForce = TRUE) override;
64 OGRErr IGetExtent(int iGeomField, OGREnvelope *psExtent,
65 bool bForce = true) override;
66 OGRErr IGetExtent3D(int iGeomField, OGREnvelope3D *psExtent,
67 bool bForce = true) override;
68
69 int TestCapability(const char *) const override;
70
71 virtual OGRErr CreateField(const OGRFieldDefn *poField,
72 int bApproxOK = TRUE) override;
73 OGRErr DeleteField(int iField) override;
74 OGRErr ReorderFields(int *panMap) override;
75 virtual OGRErr AlterFieldDefn(int iField, OGRFieldDefn *poNewFieldDefn,
76 int nFlags) override;
77 virtual OGRErr
78 AlterGeomFieldDefn(int iGeomField,
79 const OGRGeomFieldDefn *poNewGeomFieldDefn,
80 int nFlags) override;
81
82 virtual OGRErr CreateGeomField(const OGRGeomFieldDefn *poField,
83 int bApproxOK = TRUE) override;
84
85 OGRErr SyncToDisk() override;
86
87 OGRStyleTable *GetStyleTable() override;
88 void SetStyleTableDirectly(OGRStyleTable *poStyleTable) override;
89
90 void SetStyleTable(OGRStyleTable *poStyleTable) override;
91
92 OGRErr StartTransaction() override;
93 OGRErr CommitTransaction() override;
94 OGRErr RollbackTransaction() override;
95
96 const char *GetFIDColumn() const override;
97 const char *GetGeometryColumn() const override;
98
99 OGRErr SetIgnoredFields(CSLConstList papszFields) override;
100
101 char **GetMetadata(const char *pszDomain = "") override;
102 CPLErr SetMetadata(char **papszMetadata,
103 const char *pszDomain = "") override;
104 virtual const char *GetMetadataItem(const char *pszName,
105 const char *pszDomain = "") override;
106 CPLErr SetMetadataItem(const char *pszName, const char *pszValue,
107 const char *pszDomain = "") override;
108 OGRErr Rename(const char *pszNewName) override;
109
110 OGRLayer *GetBaseLayer() const
111 {
112 return m_poDecoratedLayer;
113 }
114};
115
116#endif /* #ifndef DOXYGEN_SKIP */
117
118#endif // OGRLAYERDECORATOR_H_INCLUDED
GDALDataset
A set of associated raster bands, usually from one file.
Definition gdal_dataset.h:76
GDALMajorObject::SetMetadataItem
virtual CPLErr SetMetadataItem(const char *pszName, const char *pszValue, const char *pszDomain="")
Set single metadata item.
Definition gdalmajorobject.cpp:366
GDALMajorObject::SetMetadata
virtual CPLErr SetMetadata(char **papszMetadata, const char *pszDomain="")
Set metadata.
Definition gdalmajorobject.cpp:271
GDALMajorObject::GetMetadata
virtual char ** GetMetadata(const char *pszDomain="")
Fetch metadata.
Definition gdalmajorobject.cpp:228
GDALMajorObject::GetMetadataItem
virtual const char * GetMetadataItem(const char *pszName, const char *pszDomain="")
Fetch single metadata item.
Definition gdalmajorobject.cpp:322
OGREnvelope3D
Simple container for a bounding region in 3D.
Definition ogr_core.h:199
OGREnvelope
Simple container for a bounding region (rectangle)
Definition ogr_core.h:44
OGRFeatureDefn
Definition of a feature class or feature layer.
Definition ogr_feature.h:504
OGRFeature
A simple feature, including geometry and attributes.
Definition ogr_feature.h:934
OGRFieldDefn
Definition of an attribute of an OGRFeatureDefn.
Definition ogr_feature.h:69
OGRGeomFieldDefn
Definition of a geometry field of an OGRFeatureDefn.
Definition ogr_feature.h:332
OGRGeometry
Abstract base class for all geometry classes.
Definition ogr_geometry.h:357
OGRLayer
This class represents a layer of simple features, with access methods.
Definition ogrsf_frmts.h:61
OGRLayer::ISetSpatialFilter
virtual OGRErr ISetSpatialFilter(int iGeomField, const OGRGeometry *)
Set a new spatial filter.
Definition ogrlayer.cpp:3398
OGRLayer::IGetExtent3D
virtual OGRErr IGetExtent3D(int iGeomField, OGREnvelope3D *psExtent3D, bool bForce)
Fetch the 3D extent of this layer, on the specified geometry field.
Definition ogrlayer.cpp:613
OGRLayer::DeleteFeature
virtual OGRErr DeleteFeature(GIntBig nFID)
Delete feature from layer.
Definition ogrlayer.cpp:4338
OGRLayer::SetStyleTableDirectly
virtual void SetStyleTableDirectly(OGRStyleTable *poStyleTable)
Set layer style table.
Definition ogrlayer.cpp:4536
OGRLayer::StartTransaction
virtual OGRErr StartTransaction()
For datasources which support transactions, StartTransaction creates a transaction.
Definition ogrlayer.cpp:2600
OGRLayer::GetFeatureCount
virtual GIntBig GetFeatureCount(int bForce=TRUE)
Fetch the feature count in this layer.
Definition ogrlayer.cpp:205
OGRLayer::SetStyleTable
virtual void SetStyleTable(OGRStyleTable *poStyleTable)
Set layer style table.
Definition ogrlayer.cpp:4558
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:1748
OGRLayer::IUpsertFeature
virtual OGRErr IUpsertFeature(OGRFeature *poFeature)
Rewrite/replace an existing feature or create a new feature within a layer.
Definition ogrlayer.cpp:1562
OGRLayer::GetArrowStream
virtual bool GetArrowStream(struct ArrowArrayStream *out_stream, CSLConstList papszOptions=nullptr)
Get a Arrow C stream.
Definition ogrlayerarrow.cpp:2584
OGRLayer::ICreateFeature
virtual OGRErr ICreateFeature(OGRFeature *poFeature)
Create and write a new feature within a layer.
Definition ogrlayer.cpp:1462
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:2415
OGRLayer::GetDataset
virtual GDALDataset * GetDataset()
Return the dataset associated with this layer.
Definition ogrlayer.cpp:8353
OGRLayer::TestCapability
virtual int TestCapability(const char *) const =0
Test if this layer supported the named capability.
OGRLayer::ISetFeature
virtual OGRErr ISetFeature(OGRFeature *poFeature)
Rewrite/replace an existing feature.
Definition ogrlayer.cpp:1343
OGRLayer::GetName
virtual const char * GetName() const
Return the layer name.
Definition ogrlayer.cpp:4625
OGRLayer::CreateField
virtual OGRErr CreateField(const OGRFieldDefn *poField, int bApproxOK=TRUE)
Create a new field on a layer.
Definition ogrlayer.cpp:1898
OGRLayer::GetGeometryColumn
virtual const char * GetGeometryColumn() const
This method returns the name of the underlying database column being used as the geometry column,...
Definition ogrlayer.cpp:4463
OGRLayer::CommitTransaction
virtual OGRErr CommitTransaction()
For datasources which support transactions, CommitTransaction commits a transaction.
Definition ogrlayer.cpp:2659
OGRLayer::IGetExtent
virtual OGRErr IGetExtent(int iGeomField, OGREnvelope *psExtent, bool bForce)
Fetch the extent of this layer, on the specified geometry field.
Definition ogrlayer.cpp:377
OGRLayer::CreateGeomField
virtual OGRErr CreateGeomField(const OGRGeomFieldDefn *poField, int bApproxOK=TRUE)
Create a new geometry field on a layer.
Definition ogrlayer.cpp:2518
OGRLayer::GetLayerDefn
virtual const OGRFeatureDefn * GetLayerDefn() const =0
Fetch the schema information for this layer.
OGRLayer::GetSpatialRef
virtual const OGRSpatialReference * GetSpatialRef() const
Fetch the spatial reference system for this layer.
Definition ogrlayer.cpp:2922
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:1989
OGRLayer::SetIgnoredFields
virtual OGRErr SetIgnoredFields(CSLConstList papszFields)
Set which fields can be omitted when retrieving features from the layer.
Definition ogrlayer.cpp:4764
OGRLayer::RollbackTransaction
virtual OGRErr RollbackTransaction()
For datasources which support transactions, RollbackTransaction will roll back a datasource to its st...
Definition ogrlayer.cpp:2734
OGRLayer::GetGeomType
virtual OGRwkbGeometryType GetGeomType() const
Return the layer geometry type.
Definition ogrlayer.cpp:4688
OGRLayer::GetFIDColumn
virtual const char * GetFIDColumn() const
This method returns the name of the underlying database column being used as the FID column,...
Definition ogrlayer.cpp:4415
OGRLayer::SetNextByIndex
virtual OGRErr SetNextByIndex(GIntBig nIndex)
Move read cursor to the nIndex'th feature in the current resultset.
Definition ogrlayer.cpp:1033
OGRLayer::GetStyleTable
virtual OGRStyleTable * GetStyleTable()
Returns layer style table.
Definition ogrlayer.cpp:4516
OGRLayer::SetAttributeFilter
virtual OGRErr SetAttributeFilter(const char *)
Set a new attribute query.
Definition ogrlayer.cpp:751
OGRLayer::GetFeature
virtual OGRFeature * GetFeature(GIntBig nFID)
Fetch a feature by its identifier.
Definition ogrlayer.cpp:918
OGRLayer::GetSpatialFilter
virtual OGRGeometry * GetSpatialFilter()
This method returns the current spatial filter for this layer.
Definition ogrlayer.cpp:3200
OGRLayer::Rename
virtual OGRErr Rename(const char *pszNewName)
Rename layer.
Definition ogrlayer.cpp:4870
OGRLayer::SyncToDisk
virtual OGRErr SyncToDisk()
Flush pending changes to disk.
Definition ogrlayer.cpp:4271
OGRLayer::ReorderFields
virtual OGRErr ReorderFields(int *panMap)
Reorder all the fields of a layer.
Definition ogrlayer.cpp:2079
OGRLayer::AlterFieldDefn
virtual OGRErr AlterFieldDefn(int iField, OGRFieldDefn *poNewFieldDefn, int nFlagsIn)
Alter the definition of an existing field on a layer.
Definition ogrlayer.cpp:2312
OGRSpatialReference
This class represents an OpenGIS Spatial Reference System, and contains methods for converting betwee...
Definition ogr_spatialref.h:152
OGRStyleTable
This class represents a style table.
Definition ogr_featurestyle.h:69
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:936
CSLConstList
char ** CSLConstList
Type of a constant null-terminated list of nul terminated strings.
Definition cpl_port.h:1087
GIntBig
long long GIntBig
Large signed integer type (generally 64-bit integer type).
Definition cpl_port.h:205
OGRwkbGeometryType
OGRwkbGeometryType
List of well known binary geometry types.
Definition ogr_core.h:405
OGRErr
int OGRErr
Type for a OGR error.
Definition ogr_core.h:370
ogrsf_frmts.h
Classes related to registration of format support, and opening datasets.