31#ifndef OGRSF_FRMTS_H_INCLUDED
32#define OGRSF_FRMTS_H_INCLUDED
34#include "cpl_progress.h"
48#if !defined(GDAL_COMPILATION) && !defined(SUPPRESS_DEPRECATION_WARNINGS)
49#define OGR_DEPRECATED(x) CPL_WARN_DEPRECATED(x)
51#define OGR_DEPRECATED(x)
55class OGRLayerAttrIndex;
74 std::unique_ptr<Private> m_poPrivate;
76 void ConvertGeomsIfNecessary(
OGRFeature *poFeature );
78 class CPL_DLL FeatureIterator
81 std::unique_ptr<Private> m_poPrivate;
83 FeatureIterator(
OGRLayer* poLayer,
bool bStart);
84 FeatureIterator(FeatureIterator&& oOther)
noexcept;
87 FeatureIterator& operator++();
88 bool operator!=(
const FeatureIterator& it)
const;
92 friend inline FeatureIterator
end(
OGRLayer* poLayer);
98 int m_bFilterIsEnvelope;
101 OGREnvelope m_sFilterEnvelope;
102 int m_iGeomFieldFilter;
109 OGRErr GetExtentInternal(
int iGeomField, OGREnvelope *psExtent,
int bForce );
129 FeatureIterator
begin();
132 FeatureIterator
end();
136 virtual void SetSpatialFilterRect(
double dfMinX,
double dfMinY,
137 double dfMaxX,
double dfMaxY );
139 virtual void SetSpatialFilter(
int iGeomField,
OGRGeometry * );
140 virtual void SetSpatialFilterRect(
int iGeomField,
141 double dfMinX,
double dfMinY,
142 double dfMaxX,
double dfMaxY );
144 virtual OGRErr SetAttributeFilter(
const char * );
156 virtual const
char *GetName();
159 virtual
int FindFieldIndex( const
char *pszFieldName,
int bExactMatch );
163 virtual
GIntBig GetFeatureCount(
int bForce = TRUE );
165 virtual
OGRErr GetExtent(
int iGeomField, OGREnvelope *psExtent,
168 virtual
int TestCapability( const
char * ) = 0;
171 int bApproxOK = TRUE );
172 virtual
OGRErr DeleteField(
int iField );
173 virtual
OGRErr ReorderFields(
int* panMap );
174 virtual
OGRErr AlterFieldDefn(
int iField,
OGRFieldDefn* poNewFieldDefn,
int nFlagsIn );
177 int bApproxOK = TRUE );
179 virtual
OGRErr SyncToDisk();
182 virtual
void SetStyleTableDirectly(
OGRStyleTable *poStyleTable );
188 virtual
OGRErr RollbackTransaction();
190 virtual const
char *GetFIDColumn();
191 virtual const
char *GetGeometryColumn();
193 virtual
OGRErr SetIgnoredFields( const
char **papszFields );
197 char** papszOptions =
nullptr,
198 GDALProgressFunc pfnProgress =
nullptr,
199 void * pProgressArg =
nullptr );
202 char** papszOptions =
nullptr,
203 GDALProgressFunc pfnProgress =
nullptr,
204 void * pProgressArg =
nullptr );
208 GDALProgressFunc pfnProgress,
209 void * pProgressArg );
212 char** papszOptions =
nullptr,
213 GDALProgressFunc pfnProgress =
nullptr,
214 void * pProgressArg =
nullptr );
217 char** papszOptions =
nullptr,
218 GDALProgressFunc pfnProgress =
nullptr,
219 void * pProgressArg =
nullptr );
222 char** papszOptions =
nullptr,
223 GDALProgressFunc pfnProgress =
nullptr,
224 void * pProgressArg =
nullptr );
227 char** papszOptions =
nullptr,
228 GDALProgressFunc pfnProgress =
nullptr,
229 void * pProgressArg =
nullptr );
233 int GetRefCount() const;
239 OGRErr ReorderField(
int iOldFieldPos,
int iNewFieldPos );
242 int AttributeFilterEvaluationNeedsGeometry();
245 OGRErr InitializeIndexSupport( const
char * );
246 OGRLayerAttrIndex *GetIndex() {
return m_poAttrIndex; }
247 int GetGeomFieldFilter()
const {
return m_iGeomFieldFilter; }
248 const char *GetAttrQueryString()
const {
return m_pszAttrQueryString; }
255 {
return reinterpret_cast<OGRLayerH>(poLayer); }
261 {
return reinterpret_cast<OGRLayer*
>(hLayer); }
266 OGRFeatureQuery *m_poAttrQuery;
267 char *m_pszAttrQueryString;
268 OGRLayerAttrIndex *m_poAttrIndex;
292inline OGRLayer::FeatureIterator
end(
OGRLayer* poLayer) {
return poLayer->
end(); }
322 virtual const char *GetName() OGR_DEPRECATED(
"Use GDALDataset class instead") = 0;
324 static void DestroyDataSource(
OGRDataSource * ) OGR_DEPRECATED(
"Use GDALDataset class instead");
356 virtual const char *GetName() OGR_DEPRECATED(
"Use GDALDriver class instead") = 0;
358 virtual OGRDataSource *Open(
const char *pszName,
int bUpdate=FALSE ) OGR_DEPRECATED(
"Use GDALDriver class instead") = 0;
360 virtual int TestCapability(
const char *pszCap ) OGR_DEPRECATED(
"Use GDALDriver class instead") = 0;
362 virtual OGRDataSource *CreateDataSource(
const char *pszName,
363 char ** =
nullptr ) OGR_DEPRECATED(
"Use GDALDriver class instead");
364 virtual OGRErr DeleteDataSource(
const char *pszName ) OGR_DEPRECATED(
"Use GDALDriver class instead");
394 const char * pszName,
395 char ** papszOptions );
397 const char * pszName );
401 static OGRSFDriverRegistrar *GetRegistrar() OGR_DEPRECATED(
"Use GDALDriverManager class instead");
404 void RegisterDriver(
OGRSFDriver * poDriver ) OGR_DEPRECATED(
"Use GDALDriverManager class instead");
407 int GetDriverCount(
void ) OGR_DEPRECATED(
"Use GDALDriverManager class instead");
409 GDALDriver *GetDriver(
int iDriver ) OGR_DEPRECATED(
"Use GDALDriverManager class instead");
411 GDALDriver *GetDriverByName(
const char * ) OGR_DEPRECATED(
"Use GDALDriverManager class instead");
414 int GetOpenDSCount() OGR_DEPRECATED(
"Use GDALDriverManager class instead");
416 OGRDataSource *GetOpenDS(
int ) OGR_DEPRECATED(
"Use GDALDriverManager class instead");
426void OGRRegisterAllInternal();
428void CPL_DLL RegisterOGRFileGDB();
429void CPL_DLL RegisterOGRShape();
430void CPL_DLL RegisterOGRDB2();
431void CPL_DLL RegisterOGRNTF();
432void CPL_DLL RegisterOGRFME();
433void CPL_DLL RegisterOGRSDTS();
434void CPL_DLL RegisterOGRTiger();
435void CPL_DLL RegisterOGRS57();
436void CPL_DLL RegisterOGRTAB();
437void CPL_DLL RegisterOGRMIF();
438void CPL_DLL RegisterOGROGDI();
439void CPL_DLL RegisterOGRODBC();
440void CPL_DLL RegisterOGRWAsP();
441void CPL_DLL RegisterOGRPG();
442void CPL_DLL RegisterOGRMSSQLSpatial();
443void CPL_DLL RegisterOGRMySQL();
444void CPL_DLL RegisterOGROCI();
445void CPL_DLL RegisterOGRDGN();
446void CPL_DLL RegisterOGRGML();
447void CPL_DLL RegisterOGRLIBKML();
448void CPL_DLL RegisterOGRKML();
449void CPL_DLL RegisterOGRGeoJSON();
450void CPL_DLL RegisterOGRGeoJSONSeq();
451void CPL_DLL RegisterOGRESRIJSON();
452void CPL_DLL RegisterOGRTopoJSON();
453void CPL_DLL RegisterOGRAVCBin();
454void CPL_DLL RegisterOGRAVCE00();
455void CPL_DLL RegisterOGRREC();
456void CPL_DLL RegisterOGRMEM();
457void CPL_DLL RegisterOGRVRT();
458void CPL_DLL RegisterOGRDODS();
459void CPL_DLL RegisterOGRSQLite();
460void CPL_DLL RegisterOGRCSV();
461void CPL_DLL RegisterOGRILI1();
462void CPL_DLL RegisterOGRILI2();
463void CPL_DLL RegisterOGRGRASS();
464void CPL_DLL RegisterOGRPGeo();
465void CPL_DLL RegisterOGRDXF();
466void CPL_DLL RegisterOGRCAD();
467void CPL_DLL RegisterOGRDWG();
468void CPL_DLL RegisterOGRDGNV8();
469void CPL_DLL RegisterOGRSDE();
470void CPL_DLL RegisterOGRIDB();
471void CPL_DLL RegisterOGRGMT();
472void CPL_DLL RegisterOGRBNA();
473void CPL_DLL RegisterOGRGPX();
474void CPL_DLL RegisterOGRGeoconcept();
475void CPL_DLL RegisterOGRIngres();
476void CPL_DLL RegisterOGRXPlane();
477void CPL_DLL RegisterOGRNAS();
478void CPL_DLL RegisterOGRGeoRSS();
479void CPL_DLL RegisterOGRGTM();
480void CPL_DLL RegisterOGRVFK();
481void CPL_DLL RegisterOGRPGDump();
482void CPL_DLL RegisterOGROSM();
483void CPL_DLL RegisterOGRGPSBabel();
484void CPL_DLL RegisterOGRSUA();
485void CPL_DLL RegisterOGROpenAir();
486void CPL_DLL RegisterOGRPDS();
487void CPL_DLL RegisterOGRWFS();
488void CPL_DLL RegisterOGRWFS3();
489void CPL_DLL RegisterOGRSOSI();
490void CPL_DLL RegisterOGRHTF();
491void CPL_DLL RegisterOGRAeronavFAA();
492void CPL_DLL RegisterOGRGeomedia();
493void CPL_DLL RegisterOGRMDB();
494void CPL_DLL RegisterOGREDIGEO();
495void CPL_DLL RegisterOGRGFT();
496void CPL_DLL RegisterOGRSVG();
497void CPL_DLL RegisterOGRCouchDB();
498void CPL_DLL RegisterOGRCloudant();
499void CPL_DLL RegisterOGRIdrisi();
500void CPL_DLL RegisterOGRARCGEN();
501void CPL_DLL RegisterOGRSEGUKOOA();
502void CPL_DLL RegisterOGRSEGY();
503void CPL_DLL RegisterOGRXLS();
504void CPL_DLL RegisterOGRODS();
505void CPL_DLL RegisterOGRXLSX();
506void CPL_DLL RegisterOGRElastic();
507void CPL_DLL RegisterOGRGeoPackage();
508void CPL_DLL RegisterOGRWalk();
509void CPL_DLL RegisterOGRCarto();
510void CPL_DLL RegisterOGRAmigoCloud();
511void CPL_DLL RegisterOGRSXF();
512void CPL_DLL RegisterOGROpenFileGDB();
513void CPL_DLL RegisterOGRSelafin();
514void CPL_DLL RegisterOGRJML();
515void CPL_DLL RegisterOGRPLSCENES();
516void CPL_DLL RegisterOGRCSW();
517void CPL_DLL RegisterOGRMongoDBv3();
518void CPL_DLL RegisterOGRMongoDB();
519void CPL_DLL RegisterOGRVDV();
520void CPL_DLL RegisterOGRGMLAS();
521void CPL_DLL RegisterOGRMVT();
522void CPL_DLL RegisterOGRNGW();
A set of associated raster bands, usually from one file.
Definition: gdal_priv.h:336
Format specific driver.
Definition: gdal_priv.h:1424
Object with metadata.
Definition: gdal_priv.h:133
Class for dataset open functions.
Definition: gdal_priv.h:266
LEGACY class.
Definition: ogrsf_frmts.h:318
Definition of a feature class or feature layer.
Definition: ogr_feature.h:260
A simple feature, including geometry and attributes.
Definition: ogr_feature.h:355
Definition of an attribute of an OGRFeatureDefn.
Definition: ogr_feature.h:93
Definition of a geometry field of an OGRFeatureDefn.
Definition: ogr_feature.h:183
Abstract base class for all geometry classes.
Definition: ogr_geometry.h:287
This class represents a layer of simple features, with access methods.
Definition: ogrsf_frmts.h:71
friend FeatureIterator begin(OGRLayer *poLayer)
Return begin of feature iterator.
Definition: ogrsf_frmts.h:287
virtual OGRFeature * GetNextFeature() CPL_WARN_UNUSED_RESULT=0
Fetch the next available feature from this layer.
static OGRLayerH ToHandle(OGRLayer *poLayer)
Convert a OGRLayer* to a OGRLayerH.
Definition: ogrsf_frmts.h:254
friend FeatureIterator end(OGRLayer *poLayer)
Return end of feature iterator.
Definition: ogrsf_frmts.h:292
virtual void ResetReading()=0
Reset feature reading to start on the first feature.
static OGRLayer * FromHandle(OGRLayerH hLayer)
Convert a OGRLayerH to a OGRLayer*.
Definition: ogrsf_frmts.h:260
LEGACY class.
Definition: ogrsf_frmts.h:386
LEGACY class.
Definition: ogrsf_frmts.h:351
This class represents an OpenGIS Spatial Reference System, and contains methods for converting betwee...
Definition: ogr_spatialref.h:157
This class represents a style table.
Definition: ogr_featurestyle.h:85
CPLErr
Error category.
Definition: cpl_error.h:53
#define CPL_C_END
Macro to end a block of C symbols.
Definition: cpl_port.h:339
#define CPL_C_START
Macro to start a block of C symbols.
Definition: cpl_port.h:337
#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:997
#define CPL_WARN_UNUSED_RESULT
Qualifier to warn when the return value of a function is not used.
Definition: cpl_port.h:939
long long GIntBig
Large signed integer type (generally 64-bit integer type).
Definition: cpl_port.h:248
void * OGRLayerH
Opaque type for a layer (OGRLayer)
Definition: ogr_api.h:509
OGRwkbGeometryType
List of well known binary geometry types.
Definition: ogr_core.h:318
int OGRErr
Simple container for a bounding region.
Definition: ogr_core.h:290
std::unique_ptr< OGRFeature, OGRFeatureUniquePtrDeleter > OGRFeatureUniquePtr
Unique pointer type for OGRFeature.
Definition: ogr_feature.h:780
Simple feature style classes.
struct _OGRPreparedGeometry OGRPreparedGeometry
Prepared geometry API (needs GEOS >= 3.1.0)
Definition: ogr_geometry.h:2924
OGRLayer::FeatureIterator begin(OGRLayer *poLayer)
Return begin of feature iterator.
Definition: ogrsf_frmts.h:287
OGRLayer::FeatureIterator end(OGRLayer *poLayer)
Return end of feature iterator.
Definition: ogrsf_frmts.h:292