31#ifndef OGRSF_FRMTS_H_INCLUDED
32#define OGRSF_FRMTS_H_INCLUDED
34#include "cpl_progress.h"
49#if !defined(GDAL_COMPILATION) && !defined(SUPPRESS_DEPRECATION_WARNINGS)
50#define OGR_DEPRECATED(x) CPL_WARN_DEPRECATED(x)
52#define OGR_DEPRECATED(x)
56class OGRLayerAttrIndex;
59struct ArrowArrayStream;
77 std::unique_ptr<Private> m_poPrivate;
79 void ConvertGeomsIfNecessary(
OGRFeature *poFeature);
81 class CPL_DLL FeatureIterator
84 std::unique_ptr<Private> m_poPrivate;
87 FeatureIterator(
OGRLayer *poLayer,
bool bStart);
89 FeatureIterator &&oOther)
noexcept;
93 FeatureIterator &operator++();
94 bool operator!=(
const FeatureIterator &it)
const;
98 friend inline FeatureIterator
end(
OGRLayer *poLayer);
104 int m_bFilterIsEnvelope;
106 OGRPreparedGeometry *m_pPreparedFilterGeom;
109 int m_iGeomFieldFilter;
117 ValidateGeometryFieldIndexForSetSpatialFilter(
int iGeomField,
119 bool bIsSelectLayer =
false);
128 IUpdateFeature(
OGRFeature *poFeature,
int nUpdatedFieldsCount,
129 const int *panUpdatedFieldsIdx,
int nUpdatedGeomFieldsCount,
130 const int *panUpdatedGeomFieldsIdx,
136 struct ArrowArrayStreamPrivateData
138 bool m_bArrowArrayStreamInProgress =
false;
141 std::vector<GIntBig> m_anQueriedFIDs{};
142 size_t m_iQueriedFIDS = 0;
143 std::deque<std::unique_ptr<OGRFeature>> m_oFeatureQueue{};
146 std::shared_ptr<ArrowArrayStreamPrivateData>
147 m_poSharedArrowArrayStreamPrivateData{};
149 struct ArrowArrayStreamPrivateDataSharedDataWrapper
151 std::shared_ptr<ArrowArrayStreamPrivateData> poShared{};
155 friend class OGRArrowArrayHelper;
156 static void ReleaseArray(
struct ArrowArray *array);
157 static void ReleaseSchema(
struct ArrowSchema *schema);
158 static void ReleaseStream(
struct ArrowArrayStream *stream);
159 virtual int GetArrowSchema(
struct ArrowArrayStream *,
160 struct ArrowSchema *out_schema);
161 virtual int GetNextArrowArray(
struct ArrowArrayStream *,
162 struct ArrowArray *out_array);
163 static int StaticGetArrowSchema(
struct ArrowArrayStream *,
164 struct ArrowSchema *out_schema);
165 static int StaticGetNextArrowArray(
struct ArrowArrayStream *,
166 struct ArrowArray *out_array);
167 static const char *GetLastErrorArrowArrayStream(
struct ArrowArrayStream *);
169 static struct ArrowSchema *
171 const char *pszArrowFormat,
172 const char *pszExtensionName);
175 CanPostFilterArrowArray(
const struct ArrowSchema *schema)
const;
176 void PostFilterArrowArray(
const struct ArrowSchema *schema,
177 struct ArrowArray *array,
181 bool CreateFieldFromArrowSchemaInternal(
const struct ArrowSchema *schema,
182 const std::string &osFieldPrefix,
200 FeatureIterator
begin();
203 FeatureIterator
end();
207 virtual void SetSpatialFilterRect(
double dfMinX,
double dfMinY,
208 double dfMaxX,
double dfMaxY);
210 virtual void SetSpatialFilter(
int iGeomField,
OGRGeometry *);
211 virtual void SetSpatialFilterRect(
int iGeomField,
double dfMinX,
212 double dfMinY,
double dfMaxX,
215 virtual OGRErr SetAttributeFilter(
const char *);
223 virtual
bool GetArrowStream(struct ArrowArrayStream *out_stream,
225 virtual
bool IsArrowSchemaSupported(const struct ArrowSchema *schema,
227 std::
string &osErrorMsg) const;
229 CreateFieldFromArrowSchema(const struct ArrowSchema *schema,
231 virtual
bool WriteArrowBatch(const struct ArrowSchema *schema,
232 struct ArrowArray *array,
239 const
int *panUpdatedFieldsIdx,
240 int nUpdatedGeomFieldsCount,
241 const
int *panUpdatedGeomFieldsIdx,
246 virtual const
char *GetName();
249 virtual
int FindFieldIndex(const
char *pszFieldName,
int bExactMatch);
258 GetSupportedSRSList(
int iGeomField);
259 virtual
OGRErr SetActiveSRS(
int iGeomField,
262 virtual
GIntBig GetFeatureCount(
int bForce = TRUE);
271 virtual
int TestCapability(const
char *) = 0;
276 int bApproxOK = TRUE);
277 virtual
OGRErr DeleteField(
int iField);
278 virtual
OGRErr ReorderFields(
int *panMap);
282 AlterGeomFieldDefn(
int iGeomField,
287 int bApproxOK = TRUE);
289 virtual
OGRErr SyncToDisk();
292 virtual
void SetStyleTableDirectly(
OGRStyleTable *poStyleTable);
298 virtual
OGRErr RollbackTransaction();
300 virtual const
char *GetFIDColumn();
301 virtual const
char *GetGeometryColumn();
306 GetGeometryTypes(
int iGeomField,
int nFlagsGGT,
int &nEntryCountOut,
307 GDALProgressFunc pfnProgress,
void *pProgressData);
310 char **papszOptions =
nullptr,
311 GDALProgressFunc pfnProgress =
nullptr,
312 void *pProgressArg =
nullptr);
314 char **papszOptions =
nullptr,
315 GDALProgressFunc pfnProgress =
nullptr,
316 void *pProgressArg =
nullptr);
318 char **papszOptions, GDALProgressFunc pfnProgress,
321 char **papszOptions =
nullptr,
322 GDALProgressFunc pfnProgress =
nullptr,
323 void *pProgressArg =
nullptr);
325 char **papszOptions =
nullptr,
326 GDALProgressFunc pfnProgress =
nullptr,
327 void *pProgressArg =
nullptr);
329 char **papszOptions =
nullptr,
330 GDALProgressFunc pfnProgress =
nullptr,
331 void *pProgressArg =
nullptr);
333 char **papszOptions =
nullptr,
334 GDALProgressFunc pfnProgress =
nullptr,
335 void *pProgressArg =
nullptr);
339 int GetRefCount() const;
345 OGRErr ReorderField(
int iOldFieldPos,
int iNewFieldPos);
348 int AttributeFilterEvaluationNeedsGeometry();
351 OGRErr InitializeIndexSupport(const
char *);
353 OGRLayerAttrIndex *GetIndex()
355 return m_poAttrIndex;
358 int GetGeomFieldFilter()
const
360 return m_iGeomFieldFilter;
363 const char *GetAttrQueryString()
const
365 return m_pszAttrQueryString;
375 return reinterpret_cast<OGRLayerH>(poLayer);
383 return reinterpret_cast<OGRLayer *
>(hLayer);
387 bool FilterWKBGeometry(
const GByte *pabyWKB,
size_t nWKBSize,
388 bool bEnvelopeAlreadySet,
395 static constexpr const char *DEFAULT_ARROW_FID_NAME =
"OGC_FID";
400 static constexpr const char *DEFAULT_ARROW_GEOMETRY_NAME =
"wkb_geometry";
405 OGRFeatureQuery *m_poAttrQuery;
406 char *m_pszAttrQueryString;
407 OGRLayerAttrIndex *m_poAttrIndex;
428 return poLayer->
begin();
436 return poLayer->
end();
463 const auto poThis =
static_cast<BaseLayer *
>(
this);
466 OGRFeature *poFeature = poThis->GetNextRawFeature();
467 if (poFeature ==
nullptr)
470 if ((poThis->m_poFilterGeom ==
nullptr ||
472 (poThis->m_poAttrQuery ==
nullptr ||
473 poThis->m_poAttrQuery->Evaluate(poFeature)))
484#define DEFINE_GET_NEXT_FEATURE_THROUGH_RAW(BaseLayer) \
486 friend class OGRGetNextFeatureThroughRaw<BaseLayer>; \
489 OGRFeature *GetNextFeature() override \
491 return OGRGetNextFeatureThroughRaw<BaseLayer>::GetNextFeature(); \
522 virtual const char *GetName()
523 OGR_DEPRECATED(
"Use GDALDataset class instead") = 0;
526 OGR_DEPRECATED(
"Use GDALDataset class instead");
558 virtual const char *GetName()
559 OGR_DEPRECATED(
"Use GDALDriver class instead") = 0;
561 virtual OGRDataSource *Open(
const char *pszName,
int bUpdate = FALSE)
562 OGR_DEPRECATED(
"Use GDALDriver class instead") = 0;
564 virtual int TestCapability(
const char *pszCap)
565 OGR_DEPRECATED(
"Use GDALDriver class instead") = 0;
569 OGR_DEPRECATED(
"Use GDALDriver class instead");
570 virtual OGRErr DeleteDataSource(
const char *pszName)
571 OGR_DEPRECATED(
"Use GDALDriver class instead");
602 char **papszOptions);
608 OGR_DEPRECATED(
"Use GDALDriverManager class instead");
612 OGR_DEPRECATED(
"Use GDALDriverManager class instead");
615 int GetDriverCount(
void)
616 OGR_DEPRECATED(
"Use GDALDriverManager class instead");
619 OGR_DEPRECATED(
"Use GDALDriverManager class instead");
622 OGR_DEPRECATED(
"Use GDALDriverManager class instead");
625 int GetOpenDSCount() OGR_DEPRECATED(
"Use GDALDriverManager class instead");
628 OGR_DEPRECATED(
"Use GDALDriverManager class instead");
638void OGRRegisterAllInternal();
640void CPL_DLL RegisterOGRFileGDB();
641void DeclareDeferredOGRFileGDBPlugin();
642void CPL_DLL RegisterOGRShape();
643void CPL_DLL RegisterOGRNTF();
644void CPL_DLL RegisterOGRSDTS();
645void CPL_DLL RegisterOGRTiger();
646void CPL_DLL RegisterOGRS57();
647void CPL_DLL RegisterOGRTAB();
648void CPL_DLL RegisterOGRMIF();
649void CPL_DLL RegisterOGROGDI();
650void DeclareDeferredOGROGDIPlugin();
651void CPL_DLL RegisterOGRODBC();
652void DeclareDeferredOGRODBCPlugin();
653void CPL_DLL RegisterOGRWAsP();
654void CPL_DLL RegisterOGRPG();
655void DeclareDeferredOGRPGPlugin();
656void CPL_DLL RegisterOGRMSSQLSpatial();
657void DeclareDeferredOGRMSSQLSpatialPlugin();
658void CPL_DLL RegisterOGRMySQL();
659void DeclareDeferredOGRMySQLPlugin();
660void CPL_DLL RegisterOGROCI();
661void DeclareDeferredOGROCIPlugin();
662void CPL_DLL RegisterOGRDGN();
663void CPL_DLL RegisterOGRGML();
664void CPL_DLL RegisterOGRLIBKML();
665void DeclareDeferredOGRLIBKMLPlugin();
666void CPL_DLL RegisterOGRKML();
667void CPL_DLL RegisterOGRFlatGeobuf();
668void CPL_DLL RegisterOGRGeoJSON();
669void CPL_DLL RegisterOGRGeoJSONSeq();
670void CPL_DLL RegisterOGRESRIJSON();
671void CPL_DLL RegisterOGRTopoJSON();
672void CPL_DLL RegisterOGRAVCBin();
673void CPL_DLL RegisterOGRAVCE00();
674void CPL_DLL RegisterOGRMEM();
675void CPL_DLL RegisterOGRVRT();
676void CPL_DLL RegisterOGRSQLite();
677void CPL_DLL RegisterOGRCSV();
678void CPL_DLL RegisterOGRILI1();
679void CPL_DLL RegisterOGRILI2();
680void CPL_DLL RegisterOGRPGeo();
681void CPL_DLL RegisterOGRDXF();
682void CPL_DLL RegisterOGRCAD();
683void DeclareDeferredOGRCADPlugin();
684void CPL_DLL RegisterOGRDWG();
685void CPL_DLL RegisterOGRDGNV8();
686void DeclareDeferredOGRDWGPlugin();
687void DeclareDeferredOGRDGNV8Plugin();
688void CPL_DLL RegisterOGRIDB();
689void DeclareDeferredOGRIDBPlugin();
690void CPL_DLL RegisterOGRGMT();
691void CPL_DLL RegisterOGRGPX();
692void CPL_DLL RegisterOGRGeoconcept();
693void CPL_DLL RegisterOGRNAS();
694void CPL_DLL RegisterOGRGeoRSS();
695void CPL_DLL RegisterOGRVFK();
696void DeclareDeferredOGRVFKPlugin();
697void CPL_DLL RegisterOGRPGDump();
698void CPL_DLL RegisterOGROSM();
699void CPL_DLL RegisterOGRGPSBabel();
700void CPL_DLL RegisterOGRPDS();
701void CPL_DLL RegisterOGRWFS();
702void CPL_DLL RegisterOGROAPIF();
703void CPL_DLL RegisterOGRSOSI();
704void DeclareDeferredOGRSOSIPlugin();
705void CPL_DLL RegisterOGREDIGEO();
706void CPL_DLL RegisterOGRSVG();
707void CPL_DLL RegisterOGRIdrisi();
708void CPL_DLL RegisterOGRXLS();
709void DeclareDeferredOGRXLSPlugin();
710void CPL_DLL RegisterOGRODS();
711void CPL_DLL RegisterOGRXLSX();
712void CPL_DLL RegisterOGRElastic();
713void DeclareDeferredOGRElasticPlugin();
714void CPL_DLL RegisterOGRGeoPackage();
715void CPL_DLL RegisterOGRCarto();
716void DeclareDeferredOGRCartoPlugin();
717void CPL_DLL RegisterOGRAmigoCloud();
718void CPL_DLL RegisterOGRSXF();
719void CPL_DLL RegisterOGROpenFileGDB();
720void DeclareDeferredOGROpenFileGDBPlugin();
721void CPL_DLL RegisterOGRSelafin();
722void CPL_DLL RegisterOGRJML();
723void CPL_DLL RegisterOGRPLSCENES();
724void DeclareDeferredOGRPLSCENESPlugin();
725void CPL_DLL RegisterOGRCSW();
726void CPL_DLL RegisterOGRMongoDBv3();
727void DeclareDeferredOGRMongoDBv3Plugin();
728void CPL_DLL RegisterOGRVDV();
729void CPL_DLL RegisterOGRGMLAS();
730void DeclareDeferredOGRGMLASPlugin();
731void CPL_DLL RegisterOGRMVT();
732void CPL_DLL RegisterOGRNGW();
733void CPL_DLL RegisterOGRMapML();
734void CPL_DLL RegisterOGRLVBAG();
735void CPL_DLL RegisterOGRHANA();
736void DeclareDeferredOGRHANAPlugin();
737void CPL_DLL RegisterOGRParquet();
738void DeclareDeferredOGRParquetPlugin();
739void CPL_DLL RegisterOGRArrow();
740void DeclareDeferredOGRArrowPlugin();
741void CPL_DLL RegisterOGRGTFS();
742void CPL_DLL RegisterOGRPMTiles();
743void CPL_DLL RegisterOGRJSONFG();
744void CPL_DLL RegisterOGRMiraMon();
String list class designed around our use of C "char**" string lists.
Definition: cpl_string.h:449
A set of associated raster bands, usually from one file.
Definition: gdal_priv.h:490
Format specific driver.
Definition: gdal_priv.h:1949
Object with metadata.
Definition: gdal_priv.h:156
Class for dataset open functions.
Definition: gdal_priv.h:301
LEGACY class.
Definition: ogrsf_frmts.h:518
Simple container for a bounding region in 3D.
Definition: ogr_core.h:216
Simple container for a bounding region (rectangle)
Definition: ogr_core.h:61
Definition of a feature class or feature layer.
Definition: ogr_feature.h:517
A simple feature, including geometry and attributes.
Definition: ogr_feature.h:893
OGRGeometry * GetGeometryRef()
Fetch pointer to feature geometry.
Definition: ogrfeature.cpp:719
Definition of an attribute of an OGRFeatureDefn.
Definition: ogr_feature.h:111
Definition of a geometry field of an OGRFeatureDefn.
Definition: ogr_feature.h:346
Abstract base class for all geometry classes.
Definition: ogr_geometry.h:377
Template class offering a GetNextFeature() implementation relying on GetNextRawFeature()
Definition: ogrsf_frmts.h:454
OGRFeature * GetNextFeature()
Implement OGRLayer::GetNextFeature(), relying on BaseLayer::GetNextRawFeature()
Definition: ogrsf_frmts.h:461
This class represents a layer of simple features, with access methods.
Definition: ogrsf_frmts.h:74
friend FeatureIterator begin(OGRLayer *poLayer)
Return begin of feature iterator.
Definition: ogrsf_frmts.h:426
virtual OGRFeature * GetNextFeature()=0
Fetch the next available feature from this layer.
static OGRLayerH ToHandle(OGRLayer *poLayer)
Convert a OGRLayer* to a OGRLayerH.
Definition: ogrsf_frmts.h:373
std::vector< std::unique_ptr< OGRSpatialReference, OGRSpatialReferenceReleaser > > GetSupportedSRSListRetType
Return type of OGRLayer::GetSupportedSRSList()
Definition: ogrsf_frmts.h:256
friend FeatureIterator end(OGRLayer *poLayer)
Return end of feature iterator.
Definition: ogrsf_frmts.h:434
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:381
LEGACY class.
Definition: ogrsf_frmts.h:593
LEGACY class.
Definition: ogrsf_frmts.h:553
This class represents an OpenGIS Spatial Reference System, and contains methods for converting betwee...
Definition: ogr_spatialref.h:169
This class represents a style table.
Definition: ogr_featurestyle.h:86
CPLErr
Error category.
Definition: cpl_error.h:53
#define CPL_C_END
Macro to end a block of C symbols.
Definition: cpl_port.h:299
#define CPL_C_START
Macro to start a block of C symbols.
Definition: cpl_port.h:295
#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:1042
char ** CSLConstList
Type of a constant null-terminated list of nul terminated strings.
Definition: cpl_port.h:1183
#define CPL_WARN_UNUSED_RESULT
Qualifier to warn when the return value of a function is not used.
Definition: cpl_port.h:976
unsigned char GByte
Unsigned byte type.
Definition: cpl_port.h:185
long long GIntBig
Large signed integer type (generally 64-bit integer type).
Definition: cpl_port.h:215
void * OGRLayerH
Opaque type for a layer (OGRLayer)
Definition: ogr_api.h:688
OGRwkbGeometryType
List of well known binary geometry types.
Definition: ogr_core.h:416
int OGRErr
Type for a OGR error.
Definition: ogr_core.h:387
std::unique_ptr< OGRFeature, OGRFeatureUniquePtrDeleter > OGRFeatureUniquePtr
Unique pointer type for OGRFeature.
Definition: ogr_feature.h:1570
Simple feature style classes.
std::unique_ptr< OGRLayer > OGRLayerUniquePtr
Unique pointer type for OGRLayer.
Definition: ogrsf_frmts.h:442
OGRLayer::FeatureIterator begin(OGRLayer *poLayer)
Return begin of feature iterator.
Definition: ogrsf_frmts.h:426
OGRLayer::FeatureIterator end(OGRLayer *poLayer)
Return end of feature iterator.
Definition: ogrsf_frmts.h:434
Result item of OGR_L_GetGeometryTypes.
Definition: ogr_api.h:705