doc/gdal-doc-3.12.4/ogrsf__frmts_8h_source.html

/******************************************************************************

 *

 * Project:  OpenGIS Simple Features Reference Implementation

 * Purpose:  Classes related to format registration, and file opening.

 * Author:   Frank Warmerdam, warmerda@home.com

 *

 ******************************************************************************

 * Copyright (c) 1999,  Les Technologies SoftMap Inc.

 * Copyright (c) 2007-2014, Even Rouault <even dot rouault at spatialys.com>

 *

 * SPDX-License-Identifier: MIT

 ****************************************************************************/


#ifndef OGRSF_FRMTS_H_INCLUDED

#define OGRSF_FRMTS_H_INCLUDED


#include "cpl_progress.h"

#include "ogr_feature.h"

#include "ogr_featurestyle.h"

#include "gdal_priv.h"


#include <memory>

#include <deque>


#if !defined(GDAL_COMPILATION) && !defined(SUPPRESS_DEPRECATION_WARNINGS)

#define OGR_DEPRECATED(x) CPL_WARN_DEPRECATED(x)

#else

#define OGR_DEPRECATED(x)

#endif


#ifndef CPPCHECK_STATIC

#define CPPCHECK_STATIC

#endif


class OGRLayerAttrIndex;

class OGRSFDriver;


struct ArrowArrayStream;


/************************************************************************/

/*                               OGRLayer                               */

/************************************************************************/


/* Note: any virtual method added to this class must also be added in the */

/* OGRLayerDecorator and OGRMutexedLayer classes. */


class CPL_DLL OGRLayer : public GDALMajorObject

{

  private:

    struct Private;

    std::unique_ptr<Private> m_poPrivate;


    void ConvertGeomsIfNecessary(OGRFeature *poFeature);


    class CPL_DLL FeatureIterator

    {

        struct Private;

        std::unique_ptr<Private> m_poPrivate;


      public:

        FeatureIterator(OGRLayer *poLayer, bool bStart);

        FeatureIterator(

            FeatureIterator &&oOther) noexcept;  // declared but not defined.

                                                 // Needed for gcc 5.4 at least

        ~FeatureIterator();

        OGRFeatureUniquePtr &operator*();

        FeatureIterator &operator++();

        bool operator!=(const FeatureIterator &it) const;

    };


    friend inline FeatureIterator begin(OGRLayer *poLayer);

    friend inline FeatureIterator end(OGRLayer *poLayer);


    CPL_DISALLOW_COPY_ASSIGN(OGRLayer)


  protected:

    int m_bFilterIsEnvelope;

    OGRGeometry *m_poFilterGeom;

    OGRPreparedGeometry *m_pPreparedFilterGeom; /* m_poFilterGeom compiled as a

                                                   prepared geometry */

    OGREnvelope m_sFilterEnvelope;

    int m_iGeomFieldFilter;  // specify the index on which the spatial

                             // filter is active.


    int FilterGeometry(const OGRGeometry *);

    // int          FilterGeometry( OGRGeometry *, OGREnvelope*

    // psGeometryEnvelope);

    int InstallFilter(const OGRGeometry *);

    bool

    ValidateGeometryFieldIndexForSetSpatialFilter(int iGeomField,

                                                  const OGRGeometry *poGeomIn,

                                                  bool bIsSelectLayer = false);


    virtual OGRErr IGetExtent(int iGeomField, OGREnvelope *psExtent,

                              bool bForce) CPL_WARN_UNUSED_RESULT;


    virtual OGRErr IGetExtent3D(int iGeomField, OGREnvelope3D *psExtent3D,

                                bool bForce) CPL_WARN_UNUSED_RESULT;


    virtual OGRErr ISetSpatialFilter(int iGeomField, const OGRGeometry *);


    virtual OGRErr ISetFeature(OGRFeature *poFeature) CPL_WARN_UNUSED_RESULT;

    virtual OGRErr ICreateFeature(OGRFeature *poFeature) CPL_WARN_UNUSED_RESULT;

    virtual OGRErr IUpsertFeature(OGRFeature *poFeature) CPL_WARN_UNUSED_RESULT;

    virtual OGRErr

    IUpdateFeature(OGRFeature *poFeature, int nUpdatedFieldsCount,

                   const int *panUpdatedFieldsIdx, int nUpdatedGeomFieldsCount,

                   const int *panUpdatedGeomFieldsIdx,

                   bool bUpdateStyleString) CPL_WARN_UNUSED_RESULT;


    CPLStringList m_aosArrowArrayStreamOptions{};


    friend struct OGRGenSQLResultsLayerArrowStreamPrivateData;


    struct ArrowArrayStreamPrivateData

    {

        bool m_bArrowArrayStreamInProgress = false;

        bool m_bEOF = false;

        OGRLayer *m_poLayer = nullptr;

        std::vector<GIntBig> m_anQueriedFIDs{};

        size_t m_iQueriedFIDS = 0;

        std::deque<std::unique_ptr<OGRFeature>> m_oFeatureQueue{};

    };


    std::shared_ptr<ArrowArrayStreamPrivateData>

        m_poSharedArrowArrayStreamPrivateData{};


    struct ArrowArrayStreamPrivateDataSharedDataWrapper

    {

        std::shared_ptr<ArrowArrayStreamPrivateData> poShared{};

    };


    friend class OGRArrowArrayHelper;

    friend class OGRGenSQLResultsLayer;

    static void ReleaseArray(struct ArrowArray *array);

    static void ReleaseSchema(struct ArrowSchema *schema);

    static void ReleaseStream(struct ArrowArrayStream *stream);

    virtual int GetArrowSchema(struct ArrowArrayStream *,

                               struct ArrowSchema *out_schema);

    virtual int GetNextArrowArray(struct ArrowArrayStream *,

                                  struct ArrowArray *out_array);

    static int StaticGetArrowSchema(struct ArrowArrayStream *,

                                    struct ArrowSchema *out_schema);

    static int StaticGetNextArrowArray(struct ArrowArrayStream *,

                                       struct ArrowArray *out_array);

    static const char *GetLastErrorArrowArrayStream(struct ArrowArrayStream *);


    static struct ArrowSchema *

    CreateSchemaForWKBGeometryColumn(const OGRGeomFieldDefn *poFieldDefn,

                                     const char *pszArrowFormat,

                                     const char *pszExtensionName);


    virtual bool

    CanPostFilterArrowArray(const struct ArrowSchema *schema) const;

    void PostFilterArrowArray(const struct ArrowSchema *schema,

                              struct ArrowArray *array,

                              CSLConstList papszOptions) const;


    bool CreateFieldFromArrowSchemaInternal(const struct ArrowSchema *schema,

                                            const std::string &osFieldPrefix,

                                            CSLConstList papszOptions);


  public:

    OGRLayer();

    ~OGRLayer() override;


    FeatureIterator begin();


    FeatureIterator end();


    virtual OGRGeometry *GetSpatialFilter();


    OGRErr SetSpatialFilter(const OGRGeometry *);

    OGRErr SetSpatialFilterRect(double dfMinX, double dfMinY, double dfMaxX,

                                double dfMaxY);


    OGRErr SetSpatialFilter(int iGeomField, const OGRGeometry *);

    OGRErr SetSpatialFilterRect(int iGeomField, double dfMinX, double dfMinY,

                                double dfMaxX, double dfMaxY);


    virtual OGRErr SetAttributeFilter(const char *);


    virtual void ResetReading() = 0;

    virtual OGRFeature *GetNextFeature() CPL_WARN_UNUSED_RESULT = 0;

    virtual OGRErr SetNextByIndex(GIntBig nIndex);

    virtual OGRFeature *GetFeature(GIntBig nFID) CPL_WARN_UNUSED_RESULT;


    virtual GDALDataset *GetDataset();

    virtual bool GetArrowStream(struct ArrowArrayStream *out_stream,

                                CSLConstList papszOptions = nullptr);

    virtual bool IsArrowSchemaSupported(const struct ArrowSchema *schema,

                                        CSLConstList papszOptions,

                                        std::string &osErrorMsg) const;

    virtual bool

    CreateFieldFromArrowSchema(const struct ArrowSchema *schema,

                               CSLConstList papszOptions = nullptr);

    virtual bool WriteArrowBatch(const struct ArrowSchema *schema,

                                 struct ArrowArray *array,

                                 CSLConstList papszOptions = nullptr);


    OGRErr SetFeature(OGRFeature *poFeature) CPL_WARN_UNUSED_RESULT;

    OGRErr CreateFeature(OGRFeature *poFeature) CPL_WARN_UNUSED_RESULT;

    OGRErr UpsertFeature(OGRFeature *poFeature) CPL_WARN_UNUSED_RESULT;

    OGRErr UpdateFeature(OGRFeature *poFeature, int nUpdatedFieldsCount,

                         const int *panUpdatedFieldsIdx,

                         int nUpdatedGeomFieldsCount,

                         const int *panUpdatedGeomFieldsIdx,

                         bool bUpdateStyleString) CPL_WARN_UNUSED_RESULT;


    virtual OGRErr DeleteFeature(GIntBig nFID) CPL_WARN_UNUSED_RESULT;


    virtual const char *GetName() const;

    virtual OGRwkbGeometryType GetGeomType() const;

    virtual const OGRFeatureDefn *GetLayerDefn() const = 0;


    OGRFeatureDefn *GetLayerDefn()

    {

        return const_cast<OGRFeatureDefn *>(

            const_cast<const OGRLayer *>(this)->GetLayerDefn());

    }


    virtual int FindFieldIndex(const char *pszFieldName, int bExactMatch);


    virtual const OGRSpatialReference *GetSpatialRef() const;


    typedef std::vector<

        std::unique_ptr<OGRSpatialReference, OGRSpatialReferenceReleaser>>

        GetSupportedSRSListRetType;

    virtual const GetSupportedSRSListRetType &

    GetSupportedSRSList(int iGeomField);

    virtual OGRErr SetActiveSRS(int iGeomField,

                                const OGRSpatialReference *poSRS);


    virtual GIntBig GetFeatureCount(int bForce = TRUE);


    OGRErr GetExtent(OGREnvelope *psExtent,

                     bool bForce = true) CPL_WARN_UNUSED_RESULT;

    OGRErr GetExtent(int iGeomField, OGREnvelope *psExtent,

                     bool bForce = true) CPL_WARN_UNUSED_RESULT;


    OGRErr GetExtent3D(int iGeomField, OGREnvelope3D *psExtent,

                       bool bForce = true) CPL_WARN_UNUSED_RESULT;


    virtual int TestCapability(const char *) const = 0;


    virtual OGRErr Rename(const char *pszNewName) CPL_WARN_UNUSED_RESULT;


    virtual OGRErr CreateField(const OGRFieldDefn *poField,

                               int bApproxOK = TRUE) CPL_WARN_UNUSED_RESULT;

    virtual OGRErr DeleteField(int iField);

    virtual OGRErr ReorderFields(int *panMap);

    virtual OGRErr AlterFieldDefn(int iField, OGRFieldDefn *poNewFieldDefn,

                                  int nFlagsIn);

    virtual OGRErr

    AlterGeomFieldDefn(int iGeomField,

                       const OGRGeomFieldDefn *poNewGeomFieldDefn,

                       int nFlagsIn);


    virtual OGRErr CreateGeomField(const OGRGeomFieldDefn *poField,

                                   int bApproxOK = TRUE);


    virtual OGRErr SyncToDisk();


    virtual OGRStyleTable *GetStyleTable();

    virtual void SetStyleTableDirectly(OGRStyleTable *poStyleTable);


    virtual void SetStyleTable(OGRStyleTable *poStyleTable);


    virtual OGRErr StartTransaction() CPL_WARN_UNUSED_RESULT;

    virtual OGRErr CommitTransaction() CPL_WARN_UNUSED_RESULT;

    virtual OGRErr RollbackTransaction();


    // Keep field definitions in sync with transactions

    virtual void PrepareStartTransaction();

    // Rollback TO SAVEPOINT if osSavepointName is not empty, otherwise ROLLBACK

    virtual void FinishRollbackTransaction(const std::string &osSavepointName);


    virtual const char *GetFIDColumn() const;

    virtual const char *GetGeometryColumn() const;


    virtual OGRErr SetIgnoredFields(CSLConstList papszFields);


    virtual OGRGeometryTypeCounter *

    GetGeometryTypes(int iGeomField, int nFlagsGGT, int &nEntryCountOut,

                     GDALProgressFunc pfnProgress, void *pProgressData);


    OGRErr Intersection(OGRLayer *pLayerMethod, OGRLayer *pLayerResult,

                        char **papszOptions = nullptr,

                        GDALProgressFunc pfnProgress = nullptr,

                        void *pProgressArg = nullptr);

    OGRErr Union(OGRLayer *pLayerMethod, OGRLayer *pLayerResult,

                 char **papszOptions = nullptr,

                 GDALProgressFunc pfnProgress = nullptr,

                 void *pProgressArg = nullptr);

    OGRErr SymDifference(OGRLayer *pLayerMethod, OGRLayer *pLayerResult,

                         char **papszOptions, GDALProgressFunc pfnProgress,

                         void *pProgressArg);

    OGRErr Identity(OGRLayer *pLayerMethod, OGRLayer *pLayerResult,

                    char **papszOptions = nullptr,

                    GDALProgressFunc pfnProgress = nullptr,

                    void *pProgressArg = nullptr);

    OGRErr Update(OGRLayer *pLayerMethod, OGRLayer *pLayerResult,

                  char **papszOptions = nullptr,

                  GDALProgressFunc pfnProgress = nullptr,

                  void *pProgressArg = nullptr);

    OGRErr Clip(OGRLayer *pLayerMethod, OGRLayer *pLayerResult,

                char **papszOptions = nullptr,

                GDALProgressFunc pfnProgress = nullptr,

                void *pProgressArg = nullptr);

    OGRErr Erase(OGRLayer *pLayerMethod, OGRLayer *pLayerResult,

                 char **papszOptions = nullptr,

                 GDALProgressFunc pfnProgress = nullptr,

                 void *pProgressArg = nullptr);


    int Reference();

    int Dereference();

    int GetRefCount() const;

    GIntBig GetFeaturesRead();


    /* non virtual : convenience wrapper for ReorderFields() */

    OGRErr ReorderField(int iOldFieldPos, int iNewFieldPos);


    int AttributeFilterEvaluationNeedsGeometry();


    /* consider these private */

    OGRErr InitializeIndexSupport(const char *);


    OGRLayerAttrIndex *GetIndex()

    {

        return m_poAttrIndex;

    }


    int GetGeomFieldFilter() const

    {

        return m_iGeomFieldFilter;

    }


    const char *GetAttrQueryString() const

    {

        return m_pszAttrQueryString;

    }


    static inline OGRLayerH ToHandle(OGRLayer *poLayer)

    {

        return reinterpret_cast<OGRLayerH>(poLayer);

    }


    static inline OGRLayer *FromHandle(OGRLayerH hLayer)

    {

        return reinterpret_cast<OGRLayer *>(hLayer);

    }


    bool FilterWKBGeometry(const GByte *pabyWKB, size_t nWKBSize,

                           bool bEnvelopeAlreadySet,

                           OGREnvelope &sEnvelope) const;


    static bool FilterWKBGeometry(const GByte *pabyWKB, size_t nWKBSize,

                                  bool bEnvelopeAlreadySet,

                                  OGREnvelope &sEnvelope,

                                  const OGRGeometry *poFilterGeom,

                                  bool bFilterIsEnvelope,

                                  const OGREnvelope &sFilterEnvelope,

                                  OGRPreparedGeometry *&poPreparedFilterGeom);


    static constexpr const char *DEFAULT_ARROW_FID_NAME = "OGC_FID";


    static constexpr const char *DEFAULT_ARROW_GEOMETRY_NAME = "wkb_geometry";


  protected:


    enum class FieldChangeType : char

    {

        ADD_FIELD,

        ALTER_FIELD,

        DELETE_FIELD

    };


    // Store changes to the fields that happened inside a transaction

    template <typename T> struct FieldDefnChange

    {


        FieldDefnChange(std::unique_ptr<T> &&poFieldDefnIn, int iFieldIn,

                        FieldChangeType eChangeTypeIn,

                        const std::string &osSavepointNameIn = "")

            : poFieldDefn(std::move(poFieldDefnIn)), iField(iFieldIn),

              eChangeType(eChangeTypeIn), osSavepointName(osSavepointNameIn)

        {

        }


        std::unique_ptr<T> poFieldDefn;

        int iField;

        FieldChangeType eChangeType;

        std::string osSavepointName;

    };


    std::vector<FieldDefnChange<OGRFieldDefn>> m_apoFieldDefnChanges{};

    std::vector<FieldDefnChange<OGRGeomFieldDefn>> m_apoGeomFieldDefnChanges{};


    OGRStyleTable *m_poStyleTable;

    OGRFeatureQuery *m_poAttrQuery;

    char *m_pszAttrQueryString;

    OGRLayerAttrIndex *m_poAttrIndex;


    int m_nRefCount;


    GIntBig m_nFeaturesRead;

};


inline OGRLayer::FeatureIterator begin(OGRLayer *poLayer)

{

    return poLayer->begin();

}


inline OGRLayer::FeatureIterator end(OGRLayer *poLayer)

{

    return poLayer->end();

}


using OGRLayerUniquePtr = std::unique_ptr<OGRLayer>;


/************************************************************************/

/*                     OGRGetNextFeatureThroughRaw                      */

/************************************************************************/


template <class BaseLayer> class OGRGetNextFeatureThroughRaw

{

  protected:

    ~OGRGetNextFeatureThroughRaw() = default;


  public:


    OGRFeature *GetNextFeature()

    {

        const auto poThis = static_cast<BaseLayer *>(this);

        while (true)

        {

            OGRFeature *poFeature = poThis->GetNextRawFeature();

            if (poFeature == nullptr)

                return nullptr;


            if ((poThis->m_poFilterGeom == nullptr ||

                 poThis->FilterGeometry(poFeature->GetGeometryRef())) &&

                (poThis->m_poAttrQuery == nullptr ||

                 poThis->m_poAttrQuery->Evaluate(poFeature)))

            {

                return poFeature;

            }

            else

                delete poFeature;

        }

    }


};


#define DEFINE_GET_NEXT_FEATURE_THROUGH_RAW(BaseLayer)                         \

  private:                                                                     \

    friend class OGRGetNextFeatureThroughRaw<BaseLayer>;                       \

                                                                               \

  public:                                                                      \

    OGRFeature *GetNextFeature() override                                      \

    {                                                                          \

        return OGRGetNextFeatureThroughRaw<BaseLayer>::GetNextFeature();       \

    }


/************************************************************************/

/*                            OGRDataSource                             */

/************************************************************************/


class CPL_DLL OGRDataSource : public GDALDataset

{

  public:

    OGRDataSource();

    ~OGRDataSource() override;


    virtual const char *GetName()

        OGR_DEPRECATED("Use GDALDataset class instead") = 0;


    static void DestroyDataSource(OGRDataSource *)

        OGR_DEPRECATED("Use GDALDataset class instead");

};


/************************************************************************/

/*                             OGRSFDriver                              */

/************************************************************************/


class CPL_DLL OGRSFDriver : public GDALDriver

{

  public:

    ~OGRSFDriver() override;


    virtual const char *GetName()

        OGR_DEPRECATED("Use GDALDriver class instead") = 0;


    virtual OGRDataSource *Open(const char *pszName, int bUpdate = FALSE)

        OGR_DEPRECATED("Use GDALDriver class instead") = 0;


    virtual int TestCapability(const char *pszCap)

        OGR_DEPRECATED("Use GDALDriver class instead") = 0;


    virtual OGRDataSource *CreateDataSource(const char *pszName,

                                            char ** = nullptr)

        OGR_DEPRECATED("Use GDALDriver class instead");

    virtual OGRErr DeleteDataSource(const char *pszName)

        OGR_DEPRECATED("Use GDALDriver class instead");

};


/************************************************************************/

/*                         OGRSFDriverRegistrar                         */

/************************************************************************/


class CPL_DLL OGRSFDriverRegistrar

{


    OGRSFDriverRegistrar();

    ~OGRSFDriverRegistrar();


    static GDALDataset *OpenWithDriverArg(GDALDriver *poDriver,

                                          GDALOpenInfo *poOpenInfo);

    static GDALDataset *CreateVectorOnly(GDALDriver *poDriver,

                                         const char *pszName,

                                         char **papszOptions);

    static CPLErr DeleteDataSource(GDALDriver *poDriver, const char *pszName);


  public:

    static OGRSFDriverRegistrar *GetRegistrar()

        OGR_DEPRECATED("Use GDALDriverManager class instead");


    CPPCHECK_STATIC void RegisterDriver(OGRSFDriver *poDriver)

        OGR_DEPRECATED("Use GDALDriverManager class instead");


    CPPCHECK_STATIC int GetDriverCount(void)

        OGR_DEPRECATED("Use GDALDriverManager class instead");


    CPPCHECK_STATIC GDALDriver *GetDriver(int iDriver)

        OGR_DEPRECATED("Use GDALDriverManager class instead");


    CPPCHECK_STATIC GDALDriver *GetDriverByName(const char *)

        OGR_DEPRECATED("Use GDALDriverManager class instead");


    CPPCHECK_STATIC int GetOpenDSCount()

        OGR_DEPRECATED("Use GDALDriverManager class instead");


    CPPCHECK_STATIC OGRDataSource *GetOpenDS(int)

        OGR_DEPRECATED("Use GDALDriverManager class instead");

};


/* -------------------------------------------------------------------- */

/*      Various available registration methods.                         */

/* -------------------------------------------------------------------- */

CPL_C_START


void OGRRegisterAllInternal();


void CPL_DLL RegisterOGRFileGDB();

void DeclareDeferredOGRFileGDBPlugin();

void CPL_DLL RegisterOGRShape();

void CPL_DLL RegisterOGRS57();

void CPL_DLL RegisterOGRTAB();

void CPL_DLL RegisterOGRMIF();

void CPL_DLL RegisterOGRODBC();

void DeclareDeferredOGRODBCPlugin();

void CPL_DLL RegisterOGRWAsP();

void CPL_DLL RegisterOGRPG();

void DeclareDeferredOGRPGPlugin();

void CPL_DLL RegisterOGRMSSQLSpatial();

void DeclareDeferredOGRMSSQLSpatialPlugin();

void CPL_DLL RegisterOGRMySQL();

void DeclareDeferredOGRMySQLPlugin();

void CPL_DLL RegisterOGROCI();

void DeclareDeferredOGROCIPlugin();

void CPL_DLL RegisterOGRDGN();

void CPL_DLL RegisterOGRGML();

void CPL_DLL RegisterOGRLIBKML();

void DeclareDeferredOGRLIBKMLPlugin();

void CPL_DLL RegisterOGRKML();

void CPL_DLL RegisterOGRFlatGeobuf();

void CPL_DLL RegisterOGRGeoJSON();

void CPL_DLL RegisterOGRGeoJSONSeq();

void CPL_DLL RegisterOGRESRIJSON();

void CPL_DLL RegisterOGRTopoJSON();

void CPL_DLL RegisterOGRAVCBin();

void CPL_DLL RegisterOGRAVCE00();

void CPL_DLL RegisterOGRVRT();

void CPL_DLL RegisterOGRSQLite();

void CPL_DLL RegisterOGRCSV();

void CPL_DLL RegisterOGRILI1();

void CPL_DLL RegisterOGRILI2();

void CPL_DLL RegisterOGRPGeo();

void CPL_DLL RegisterOGRDXF();

void CPL_DLL RegisterOGRCAD();

void DeclareDeferredOGRCADPlugin();

void CPL_DLL RegisterOGRDWG();

void CPL_DLL RegisterOGRDGNV8();

void DeclareDeferredOGRDWGPlugin();

void DeclareDeferredOGRDGNV8Plugin();

void CPL_DLL RegisterOGRIDB();

void DeclareDeferredOGRIDBPlugin();

void CPL_DLL RegisterOGRGMT();

void CPL_DLL RegisterOGRGPX();

void CPL_DLL RegisterOGRNAS();

void CPL_DLL RegisterOGRGeoRSS();

void CPL_DLL RegisterOGRVFK();

void DeclareDeferredOGRVFKPlugin();

void CPL_DLL RegisterOGRPGDump();

void CPL_DLL RegisterOGROSM();

void CPL_DLL RegisterOGRGPSBabel();

void CPL_DLL RegisterOGRPDS();

void CPL_DLL RegisterOGRWFS();

void CPL_DLL RegisterOGROAPIF();

void CPL_DLL RegisterOGRSOSI();

void DeclareDeferredOGRSOSIPlugin();

void CPL_DLL RegisterOGREDIGEO();

void CPL_DLL RegisterOGRIdrisi();

void CPL_DLL RegisterOGRXLS();

void DeclareDeferredOGRXLSPlugin();

void CPL_DLL RegisterOGRODS();

void CPL_DLL RegisterOGRXLSX();

void CPL_DLL RegisterOGRElastic();

void DeclareDeferredOGRElasticPlugin();

void CPL_DLL RegisterOGRGeoPackage();

void CPL_DLL RegisterOGRCarto();

void DeclareDeferredOGRCartoPlugin();

void CPL_DLL RegisterOGRAmigoCloud();

void CPL_DLL RegisterOGRSXF();

void CPL_DLL RegisterOGROpenFileGDB();

void DeclareDeferredOGROpenFileGDBPlugin();

void CPL_DLL RegisterOGRSelafin();

void CPL_DLL RegisterOGRJML();

void CPL_DLL RegisterOGRPLSCENES();

void DeclareDeferredOGRPLSCENESPlugin();

void CPL_DLL RegisterOGRCSW();

void CPL_DLL RegisterOGRMongoDBv3();

void DeclareDeferredOGRMongoDBv3Plugin();

void CPL_DLL RegisterOGRVDV();

void CPL_DLL RegisterOGRGMLAS();

void DeclareDeferredOGRGMLASPlugin();

void CPL_DLL RegisterOGRMVT();

void CPL_DLL RegisterOGRNGW();

void CPL_DLL RegisterOGRMapML();

void CPL_DLL RegisterOGRLVBAG();

void CPL_DLL RegisterOGRHANA();

void DeclareDeferredOGRHANAPlugin();

void CPL_DLL RegisterOGRParquet();

void DeclareDeferredOGRParquetPlugin();

void CPL_DLL RegisterOGRArrow();

void DeclareDeferredOGRArrowPlugin();

void CPL_DLL RegisterOGRGTFS();

void CPL_DLL RegisterOGRPMTiles();

void CPL_DLL RegisterOGRJSONFG();

void CPL_DLL RegisterOGRMiraMon();

void CPL_DLL RegisterOGRXODR();

void DeclareDeferredOGRXODRPlugin();

void CPL_DLL RegisterOGRADBC();

void DeclareDeferredOGRADBCPlugin();

void CPL_DLL RegisterOGRAIVector();

// @endcond


CPL_C_END


#endif /* ndef OGRSF_FRMTS_H_INCLUDED */

CPLStringList
String list class designed around our use of C "char**" string lists.
Definition cpl_string.h:454

GDALDataset
A set of associated raster bands, usually from one file.
Definition gdal_dataset.h:76

GDALDriver
Format specific driver.
Definition gdal_driver.h:63

GDALMajorObject::GDALMajorObject
GDALMajorObject(const GDALMajorObject &)=default
Copy constructor.

GDALOpenInfo
Class for dataset open functions.
Definition gdal_openinfo.h:28

OGRDataSource
LEGACY class.
Definition ogrsf_frmts.h:565

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

OGRFeature::GetGeometryRef
OGRGeometry * GetGeometryRef()
Fetch pointer to feature geometry.
Definition ogrfeature.cpp:737

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

OGRGetNextFeatureThroughRaw
Template class offering a GetNextFeature() implementation relying on GetNextRawFeature().
Definition ogrsf_frmts.h:501

OGRGetNextFeatureThroughRaw::GetNextFeature
OGRFeature * GetNextFeature()
Implement OGRLayer::GetNextFeature(), relying on BaseLayer::GetNextRawFeature().
Definition ogrsf_frmts.h:508

OGRLayer::ISetSpatialFilter
virtual OGRErr ISetSpatialFilter(int iGeomField, const OGRGeometry *)
Set a new spatial filter.
Definition ogrlayer.cpp:3398

OGRLayer::UpsertFeature
OGRErr UpsertFeature(OGRFeature *poFeature)
Rewrite/replace an existing feature or create a new feature within a layer.
Definition ogrlayer.cpp:1533

OGRLayer::begin
friend FeatureIterator begin(OGRLayer *poLayer)
Return begin of feature iterator.
Definition ogrsf_frmts.h:470

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::SetActiveSRS
virtual OGRErr SetActiveSRS(int iGeomField, const OGRSpatialReference *poSRS)
Change the active SRS.
Definition ogrlayer.cpp:8286

OGRLayer::Dereference
int Dereference()
Decrement layer reference count.
Definition ogrlayer.cpp:130

OGRLayer::DeleteFeature
virtual OGRErr DeleteFeature(GIntBig nFID)
Delete feature from layer.
Definition ogrlayer.cpp:4338

OGRLayer::Erase
OGRErr Erase(OGRLayer *pLayerMethod, OGRLayer *pLayerResult, char **papszOptions=nullptr, GDALProgressFunc pfnProgress=nullptr, void *pProgressArg=nullptr)
Remove areas that are covered by the method layer.
Definition ogrlayer.cpp:7665

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::GetSupportedSRSList
virtual const GetSupportedSRSListRetType & GetSupportedSRSList(int iGeomField)
Get the list of SRS supported.
Definition ogrlayer.cpp:8205

OGRLayer::GetFeatureCount
virtual GIntBig GetFeatureCount(int bForce=TRUE)
Fetch the feature count in this layer.
Definition ogrlayer.cpp:205

OGRLayer::CreateSchemaForWKBGeometryColumn
static struct ArrowSchema * CreateSchemaForWKBGeometryColumn(const OGRGeomFieldDefn *poFieldDefn, const char *pszArrowFormat, const char *pszExtensionName)
Return a ArrowSchema* corresponding to the WKB encoding of a geometry column.
Definition ogrlayerarrow.cpp:723

OGRLayer::SetStyleTable
virtual void SetStyleTable(OGRStyleTable *poStyleTable)
Set layer style table.
Definition ogrlayer.cpp:4558

OGRLayer::Identity
OGRErr Identity(OGRLayer *pLayerMethod, OGRLayer *pLayerResult, char **papszOptions=nullptr, GDALProgressFunc pfnProgress=nullptr, void *pProgressArg=nullptr)
Identify the features of this layer with the ones from the identity layer.
Definition ogrlayer.cpp:6589

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::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::Intersection
OGRErr Intersection(OGRLayer *pLayerMethod, OGRLayer *pLayerResult, char **papszOptions=nullptr, GDALProgressFunc pfnProgress=nullptr, void *pProgressArg=nullptr)
Intersection of two layers.
Definition ogrlayer.cpp:5204

OGRLayer::GetDataset
virtual GDALDataset * GetDataset()
Return the dataset associated with this layer.
Definition ogrlayer.cpp:8353

OGRLayer::GetExtent3D
OGRErr GetExtent3D(int iGeomField, OGREnvelope3D *psExtent, bool bForce=true)
Fetch the 3D extent of this layer, on the specified geometry field.
Definition ogrlayer.cpp:560

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::ReleaseStream
static void ReleaseStream(struct ArrowArrayStream *stream)
Release a ArrowArrayStream.
Definition ogrlayerarrow.cpp:2410

OGRLayer::GetNextArrowArray
virtual int GetNextArrowArray(struct ArrowArrayStream *, struct ArrowArray *out_array)
Default implementation of the ArrowArrayStream::get_next() callback.
Definition ogrlayerarrow.cpp:1936

OGRLayer::SetFeature
OGRErr SetFeature(OGRFeature *poFeature)
Rewrite/replace an existing feature.
Definition ogrlayer.cpp:1315

OGRLayer::CreateField
virtual OGRErr CreateField(const OGRFieldDefn *poField, int bApproxOK=TRUE)
Create a new field on a layer.
Definition ogrlayer.cpp:1898

OGRLayer::Update
OGRErr Update(OGRLayer *pLayerMethod, OGRLayer *pLayerResult, char **papszOptions=nullptr, GDALProgressFunc pfnProgress=nullptr, void *pProgressArg=nullptr)
Update this layer with features from the update layer.
Definition ogrlayer.cpp:7007

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::ToHandle
static OGRLayerH ToHandle(OGRLayer *poLayer)
Convert a OGRLayer* to a OGRLayerH.
Definition ogrsf_frmts.h:382

OGRLayer::GetSupportedSRSListRetType
std::vector< std::unique_ptr< OGRSpatialReference, OGRSpatialReferenceReleaser > > GetSupportedSRSListRetType
Return type of OGRLayer::GetSupportedSRSList().
Definition ogrsf_frmts.h:258

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::GetGeometryTypes
virtual OGRGeometryTypeCounter * GetGeometryTypes(int iGeomField, int nFlagsGGT, int &nEntryCountOut, GDALProgressFunc pfnProgress, void *pProgressData)
Get actual geometry types found in features.
Definition ogrlayer.cpp:8049

OGRLayer::end
friend FeatureIterator end(OGRLayer *poLayer)
Return end of feature iterator.
Definition ogrsf_frmts.h:478

OGRLayer::SymDifference
OGRErr SymDifference(OGRLayer *pLayerMethod, OGRLayer *pLayerResult, char **papszOptions, GDALProgressFunc pfnProgress, void *pProgressArg)
Symmetrical difference of two layers.
Definition ogrlayer.cpp:6159

OGRLayer::ReleaseArray
static void ReleaseArray(struct ArrowArray *array)
Release a ArrowArray.
Definition ogrlayerarrow.cpp:884

OGRLayer::Clip
OGRErr Clip(OGRLayer *pLayerMethod, OGRLayer *pLayerResult, char **papszOptions=nullptr, GDALProgressFunc pfnProgress=nullptr, void *pProgressArg=nullptr)
Clip off areas that are not covered by the method layer.
Definition ogrlayer.cpp:7356

OGRLayer::CreateGeomField
virtual OGRErr CreateGeomField(const OGRGeomFieldDefn *poField, int bApproxOK=TRUE)
Create a new geometry field on a layer.
Definition ogrlayer.cpp:2518

OGRLayer::GetExtent
OGRErr GetExtent(OGREnvelope *psExtent, bool bForce=true)
Fetch the extent of this layer.
Definition ogrlayer.cpp:295

OGRLayer::CreateFieldFromArrowSchema
virtual bool CreateFieldFromArrowSchema(const struct ArrowSchema *schema, CSLConstList papszOptions=nullptr)
Creates a field from an ArrowSchema.
Definition ogrlayerarrow.cpp:6421

OGRLayer::ResetReading
virtual void ResetReading()=0
Reset feature reading to start on the first feature.

OGRLayer::CreateFeature
OGRErr CreateFeature(OGRFeature *poFeature)
Create and write a new feature within a layer.
Definition ogrlayer.cpp:1432

OGRLayer::IsArrowSchemaSupported
virtual bool IsArrowSchemaSupported(const struct ArrowSchema *schema, CSLConstList papszOptions, std::string &osErrorMsg) const
Returns whether the provided ArrowSchema is supported for writing.
Definition ogrlayerarrow.cpp:6003

OGRLayer::DeleteField
virtual OGRErr DeleteField(int iField)
Delete an existing field on a layer.
Definition ogrlayer.cpp:1989

OGRLayer::GetLayerDefn
virtual const OGRFeatureDefn * GetLayerDefn() const =0
Fetch the schema information for this layer.

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::PostFilterArrowArray
void PostFilterArrowArray(const struct ArrowSchema *schema, struct ArrowArray *array, CSLConstList papszOptions) const
Remove rows that aren't selected by the spatial or attribute filter.
Definition ogrlayerarrow.cpp:5258

OGRLayer::ReorderField
OGRErr ReorderField(int iOldFieldPos, int iNewFieldPos)
Reorder an existing field on a layer.
Definition ogrlayer.cpp:2175

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::SetSpatialFilter
OGRErr SetSpatialFilter(const OGRGeometry *)
Set a new spatial filter.
Definition ogrlayer.cpp:3312

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::TestCapability
virtual int TestCapability(const char *) const =0
Test if this layer supported the named capability.

OGRLayer::GetFeature
virtual OGRFeature * GetFeature(GIntBig nFID)
Fetch a feature by its identifier.
Definition ogrlayer.cpp:918

OGRLayer::StaticGetArrowSchema
static int StaticGetArrowSchema(struct ArrowArrayStream *, struct ArrowSchema *out_schema)
Default implementation of the ArrowArrayStream::get_schema() callback.
Definition ogrlayerarrow.cpp:826

OGRLayer::ReleaseSchema
static void ReleaseSchema(struct ArrowSchema *schema)
Release a ArrowSchema.
Definition ogrlayerarrow.cpp:313

OGRLayer::GetArrowSchema
virtual int GetArrowSchema(struct ArrowArrayStream *, struct ArrowSchema *out_schema)
Default implementation of the ArrowArrayStream::get_schema() callback.
Definition ogrlayerarrow.cpp:377

OGRLayer::UpdateFeature
OGRErr UpdateFeature(OGRFeature *poFeature, int nUpdatedFieldsCount, const int *panUpdatedFieldsIdx, int nUpdatedGeomFieldsCount, const int *panUpdatedGeomFieldsIdx, bool bUpdateStyleString)
Update (part of) an existing feature.
Definition ogrlayer.cpp:1675

OGRLayer::WriteArrowBatch
virtual bool WriteArrowBatch(const struct ArrowSchema *schema, struct ArrowArray *array, CSLConstList papszOptions=nullptr)
Writes a batch of rows from an ArrowArray.
Definition ogrlayerarrow.cpp:7648

OGRLayer::GetLastErrorArrowArrayStream
static const char * GetLastErrorArrowArrayStream(struct ArrowArrayStream *)
Default implementation of the ArrowArrayStream::get_last_error() callback.
Definition ogrlayerarrow.cpp:2436

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::Union
OGRErr Union(OGRLayer *pLayerMethod, OGRLayer *pLayerResult, char **papszOptions=nullptr, GDALProgressFunc pfnProgress=nullptr, void *pProgressArg=nullptr)
Union of two layers.
Definition ogrlayer.cpp:5622

OGRLayer::GetRefCount
int GetRefCount() const
Fetch reference count.
Definition ogrlayer.cpp:160

OGRLayer::DEFAULT_ARROW_GEOMETRY_NAME
static constexpr const char * DEFAULT_ARROW_GEOMETRY_NAME
Field name used by GetArrowSchema() for the name of the (single) geometry column (returned by GetGeom...
Definition ogrsf_frmts.h:416

OGRLayer::GetNextFeature
virtual OGRFeature * GetNextFeature()=0
Fetch the next available feature from this layer.

OGRLayer::Reference
int Reference()
Increment layer reference count.
Definition ogrlayer.cpp:100

OGRLayer::DEFAULT_ARROW_FID_NAME
static constexpr const char * DEFAULT_ARROW_FID_NAME
Field name used by GetArrowSchema() for a FID column when GetFIDColumn() is not set.
Definition ogrsf_frmts.h:411

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::StaticGetNextArrowArray
static int StaticGetNextArrowArray(struct ArrowArrayStream *, struct ArrowArray *out_array)
Default implementation of the ArrowArrayStream::get_next() callback.
Definition ogrlayerarrow.cpp:2383

OGRLayer::FromHandle
static OGRLayer * FromHandle(OGRLayerH hLayer)
Convert a OGRLayerH to a OGRLayer*.
Definition ogrsf_frmts.h:389

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

OGRLayer::SetSpatialFilterRect
OGRErr SetSpatialFilterRect(double dfMinX, double dfMinY, double dfMaxX, double dfMaxY)
Set a new rectangular spatial filter.
Definition ogrlayer.cpp:3544

OGRLayer::CanPostFilterArrowArray
virtual bool CanPostFilterArrowArray(const struct ArrowSchema *schema) const
Whether the PostFilterArrowArray() can work on the schema to remove rows that aren't selected by the ...
Definition ogrlayerarrow.cpp:3022

OGRSFDriver
LEGACY class.
Definition ogrsf_frmts.h:602

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_C_END
#define CPL_C_END
Macro to end a block of C symbols.
Definition cpl_port.h:289

CPL_C_START
#define CPL_C_START
Macro to start a block of C symbols.
Definition cpl_port.h:285

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

CPL_WARN_UNUSED_RESULT
#define CPL_WARN_UNUSED_RESULT
Qualifier to warn when the return value of a function is not used.
Definition cpl_port.h:870

GByte
unsigned char GByte
Unsigned byte type.
Definition cpl_port.h:175

GIntBig
long long GIntBig
Large signed integer type (generally 64-bit integer type).
Definition cpl_port.h:205

OGRLayerH
void * OGRLayerH
Opaque type for a layer (OGRLayer).
Definition gdal_fwd.h:157

gdal_priv.h
This file is legacy since GDAL 3.12, but will be kept at least in the whole GDAL 3....

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

ogr_feature.h
Simple feature classes.

OGRFeatureUniquePtr
std::unique_ptr< OGRFeature, OGRFeatureUniquePtrDeleter > OGRFeatureUniquePtr
Unique pointer type for OGRFeature.
Definition ogr_feature.h:1604

ogr_featurestyle.h
Simple feature style classes.

OGRLayerUniquePtr
std::unique_ptr< OGRLayer > OGRLayerUniquePtr
Unique pointer type for OGRLayer.
Definition ogrsf_frmts.h:486

begin
OGRLayer::FeatureIterator begin(OGRLayer *poLayer)
Return begin of feature iterator.
Definition ogrsf_frmts.h:470

end
OGRLayer::FeatureIterator end(OGRLayer *poLayer)
Return end of feature iterator.
Definition ogrsf_frmts.h:478

OGRGeometryTypeCounter
Result item of OGR_L_GetGeometryTypes.
Definition ogr_api.h:622