1 /****************************************************************************** 2 * $Id: ogr_api.h 3798cbe48457b7127606931896549f26507469db 2021-04-09 15:04:16 +0200 Even Rouault $ 3 * 4 * Project: OpenGIS Simple Features Reference Implementation 5 * Purpose: C API for OGR Geometry, Feature, Layers, DataSource and drivers. 6 * Author: Frank Warmerdam, warmerdam@pobox.com 7 * 8 ****************************************************************************** 9 * Copyright (c) 2002, Frank Warmerdam 10 * Copyright (c) 2008-2013, Even Rouault <even dot rouault at spatialys.com> 11 * 12 * Permission is hereby granted, free of charge, to any person obtaining a 13 * copy of this software and associated documentation files (the "Software"), 14 * to deal in the Software without restriction, including without limitation 15 * the rights to use, copy, modify, merge, publish, distribute, sublicense, 16 * and/or sell copies of the Software, and to permit persons to whom the 17 * Software is furnished to do so, subject to the following conditions: 18 * 19 * The above copyright notice and this permission notice shall be included 20 * in all copies or substantial portions of the Software. 21 * 22 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS 23 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 24 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 25 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 26 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 27 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 28 * DEALINGS IN THE SOFTWARE. 29 ****************************************************************************/ 30 31 #ifndef OGR_API_H_INCLUDED 32 #define OGR_API_H_INCLUDED 33 34 /** 35 * \file ogr_api.h 36 * 37 * C API and defines for OGRFeature, OGRGeometry, and OGRDataSource 38 * related classes. 39 * 40 * See also: ogr_geometry.h, ogr_feature.h, ogrsf_frmts.h, ogr_featurestyle.h 41 */ 42 43 #include "cpl_progress.h" 44 #include "cpl_minixml.h" 45 #include "ogr_core.h" 46 47 #include <stdbool.h> 48 #include <stddef.h> 49 50 CPL_C_START 51 52 /* -------------------------------------------------------------------- */ 53 /* Geometry related functions (ogr_geometry.h) */ 54 /* -------------------------------------------------------------------- */ 55 #ifndef DEFINEH_OGRGeometryH 56 /*! @cond Doxygen_Suppress */ 57 #define DEFINEH_OGRGeometryH 58 /*! @endcond */ 59 #ifdef DEBUG 60 typedef struct OGRGeometryHS *OGRGeometryH; 61 #else 62 /** Opaque type for a geometry */ 63 typedef void *OGRGeometryH; 64 #endif 65 #endif /* DEFINEH_OGRGeometryH */ 66 67 #ifndef DEFINED_OGRSpatialReferenceH 68 /*! @cond Doxygen_Suppress */ 69 #define DEFINED_OGRSpatialReferenceH 70 /*! @endcond */ 71 72 #ifndef DOXYGEN_XML 73 #ifdef DEBUG 74 typedef struct OGRSpatialReferenceHS *OGRSpatialReferenceH; 75 typedef struct OGRCoordinateTransformationHS *OGRCoordinateTransformationH; 76 #else 77 /** Opaque type for a spatial reference system */ 78 typedef void *OGRSpatialReferenceH; 79 /** Opaque type for a coordinate transformation object */ 80 typedef void *OGRCoordinateTransformationH; 81 #endif 82 #endif 83 84 #endif /* DEFINED_OGRSpatialReferenceH */ 85 86 struct _CPLXMLNode; 87 88 /* From base OGRGeometry class */ 89 90 OGRErr CPL_DLL OGR_G_CreateFromWkb( const void*, OGRSpatialReferenceH, 91 OGRGeometryH *, int ); 92 OGRErr CPL_DLL OGR_G_CreateFromWkbEx( const void*, OGRSpatialReferenceH, 93 OGRGeometryH *, size_t ); 94 OGRErr CPL_DLL OGR_G_CreateFromWkt( char **, OGRSpatialReferenceH, 95 OGRGeometryH * ); 96 OGRErr CPL_DLL OGR_G_CreateFromFgf( const void*, OGRSpatialReferenceH, 97 OGRGeometryH *, int, int * ); 98 void CPL_DLL OGR_G_DestroyGeometry( OGRGeometryH ); 99 OGRGeometryH CPL_DLL OGR_G_CreateGeometry( OGRwkbGeometryType ) CPL_WARN_UNUSED_RESULT; 100 OGRGeometryH CPL_DLL 101 OGR_G_ApproximateArcAngles( 102 double dfCenterX, double dfCenterY, double dfZ, 103 double dfPrimaryRadius, double dfSecondaryAxis, double dfRotation, 104 double dfStartAngle, double dfEndAngle, 105 double dfMaxAngleStepSizeDegrees ) CPL_WARN_UNUSED_RESULT; 106 107 OGRGeometryH CPL_DLL OGR_G_ForceToPolygon( OGRGeometryH ) CPL_WARN_UNUSED_RESULT; 108 OGRGeometryH CPL_DLL OGR_G_ForceToLineString( OGRGeometryH ) CPL_WARN_UNUSED_RESULT; 109 OGRGeometryH CPL_DLL OGR_G_ForceToMultiPolygon( OGRGeometryH ) CPL_WARN_UNUSED_RESULT; 110 OGRGeometryH CPL_DLL OGR_G_ForceToMultiPoint( OGRGeometryH ) CPL_WARN_UNUSED_RESULT; 111 OGRGeometryH CPL_DLL OGR_G_ForceToMultiLineString( OGRGeometryH ) CPL_WARN_UNUSED_RESULT; 112 OGRGeometryH CPL_DLL OGR_G_ForceTo( OGRGeometryH hGeom, 113 OGRwkbGeometryType eTargetType, 114 char** papszOptions ) CPL_WARN_UNUSED_RESULT; 115 OGRGeometryH CPL_DLL OGR_G_RemoveLowerDimensionSubGeoms( const OGRGeometryH hGeom ) CPL_WARN_UNUSED_RESULT; 116 117 int CPL_DLL OGR_G_GetDimension( OGRGeometryH ); 118 int CPL_DLL OGR_G_GetCoordinateDimension( OGRGeometryH ); 119 int CPL_DLL OGR_G_CoordinateDimension( OGRGeometryH ); 120 void CPL_DLL OGR_G_SetCoordinateDimension( OGRGeometryH, int ); 121 int CPL_DLL OGR_G_Is3D( OGRGeometryH ); 122 int CPL_DLL OGR_G_IsMeasured( OGRGeometryH ); 123 void CPL_DLL OGR_G_Set3D( OGRGeometryH, int ); 124 void CPL_DLL OGR_G_SetMeasured( OGRGeometryH, int ); 125 OGRGeometryH CPL_DLL OGR_G_Clone( OGRGeometryH ) CPL_WARN_UNUSED_RESULT; 126 void CPL_DLL OGR_G_GetEnvelope( OGRGeometryH, OGREnvelope * ); 127 void CPL_DLL OGR_G_GetEnvelope3D( OGRGeometryH, OGREnvelope3D * ); 128 OGRErr CPL_DLL OGR_G_ImportFromWkb( OGRGeometryH, const void*, int ); 129 OGRErr CPL_DLL OGR_G_ExportToWkb( OGRGeometryH, OGRwkbByteOrder, unsigned char*); 130 OGRErr CPL_DLL OGR_G_ExportToIsoWkb( OGRGeometryH, OGRwkbByteOrder, unsigned char*); 131 int CPL_DLL OGR_G_WkbSize( OGRGeometryH hGeom ); 132 size_t CPL_DLL OGR_G_WkbSizeEx( OGRGeometryH hGeom ); 133 OGRErr CPL_DLL OGR_G_ImportFromWkt( OGRGeometryH, char ** ); 134 OGRErr CPL_DLL OGR_G_ExportToWkt( OGRGeometryH, char ** ); 135 OGRErr CPL_DLL OGR_G_ExportToIsoWkt( OGRGeometryH, char ** ); 136 OGRwkbGeometryType CPL_DLL OGR_G_GetGeometryType( OGRGeometryH ); 137 const char CPL_DLL *OGR_G_GetGeometryName( OGRGeometryH ); 138 void CPL_DLL OGR_G_DumpReadable( OGRGeometryH, FILE *, const char * ); 139 void CPL_DLL OGR_G_FlattenTo2D( OGRGeometryH ); 140 void CPL_DLL OGR_G_CloseRings( OGRGeometryH ); 141 142 OGRGeometryH CPL_DLL OGR_G_CreateFromGML( const char * ) CPL_WARN_UNUSED_RESULT; 143 char CPL_DLL *OGR_G_ExportToGML( OGRGeometryH ) CPL_WARN_UNUSED_RESULT; 144 char CPL_DLL *OGR_G_ExportToGMLEx( OGRGeometryH, char** papszOptions ) CPL_WARN_UNUSED_RESULT; 145 146 OGRGeometryH CPL_DLL OGR_G_CreateFromGMLTree( const CPLXMLNode * ) CPL_WARN_UNUSED_RESULT; 147 CPLXMLNode CPL_DLL *OGR_G_ExportToGMLTree( OGRGeometryH ) CPL_WARN_UNUSED_RESULT; 148 CPLXMLNode CPL_DLL *OGR_G_ExportEnvelopeToGMLTree( OGRGeometryH ) CPL_WARN_UNUSED_RESULT; 149 150 char CPL_DLL *OGR_G_ExportToKML( OGRGeometryH, const char* pszAltitudeMode ) CPL_WARN_UNUSED_RESULT; 151 152 char CPL_DLL *OGR_G_ExportToJson( OGRGeometryH ) CPL_WARN_UNUSED_RESULT; 153 char CPL_DLL *OGR_G_ExportToJsonEx( OGRGeometryH, char** papszOptions ) CPL_WARN_UNUSED_RESULT; 154 /** Create a OGR geometry from a GeoJSON geometry object */ 155 OGRGeometryH CPL_DLL OGR_G_CreateGeometryFromJson( const char* ) CPL_WARN_UNUSED_RESULT; 156 /** Create a OGR geometry from a ESRI JSON geometry object */ 157 OGRGeometryH CPL_DLL OGR_G_CreateGeometryFromEsriJson( const char* ) CPL_WARN_UNUSED_RESULT; 158 159 void CPL_DLL OGR_G_AssignSpatialReference( OGRGeometryH, 160 OGRSpatialReferenceH ); 161 OGRSpatialReferenceH CPL_DLL OGR_G_GetSpatialReference( OGRGeometryH ); 162 OGRErr CPL_DLL OGR_G_Transform( OGRGeometryH, OGRCoordinateTransformationH ); 163 OGRErr CPL_DLL OGR_G_TransformTo( OGRGeometryH, OGRSpatialReferenceH ); 164 165 /** Opaque type for a geometry transformer. */ 166 typedef struct OGRGeomTransformer* OGRGeomTransformerH; 167 OGRGeomTransformerH CPL_DLL OGR_GeomTransformer_Create( OGRCoordinateTransformationH, 168 CSLConstList papszOptions ) CPL_WARN_UNUSED_RESULT; 169 OGRGeometryH CPL_DLL OGR_GeomTransformer_Transform(OGRGeomTransformerH hTransformer, OGRGeometryH hGeom ) CPL_WARN_UNUSED_RESULT; 170 void CPL_DLL OGR_GeomTransformer_Destroy(OGRGeomTransformerH hTransformer); 171 172 OGRGeometryH CPL_DLL OGR_G_Simplify( OGRGeometryH hThis, double tolerance ) CPL_WARN_UNUSED_RESULT; 173 OGRGeometryH CPL_DLL OGR_G_SimplifyPreserveTopology( OGRGeometryH hThis, double tolerance ) CPL_WARN_UNUSED_RESULT; 174 OGRGeometryH CPL_DLL OGR_G_DelaunayTriangulation( OGRGeometryH hThis, double dfTolerance, int bOnlyEdges ) CPL_WARN_UNUSED_RESULT; 175 176 void CPL_DLL OGR_G_Segmentize(OGRGeometryH hGeom, double dfMaxLength ); 177 int CPL_DLL OGR_G_Intersects( OGRGeometryH, OGRGeometryH ); 178 int CPL_DLL OGR_G_Equals( OGRGeometryH, OGRGeometryH ); 179 /*int CPL_DLL OGR_G_EqualsExact( OGRGeometryH, OGRGeometryH, double );*/ 180 int CPL_DLL OGR_G_Disjoint( OGRGeometryH, OGRGeometryH ); 181 int CPL_DLL OGR_G_Touches( OGRGeometryH, OGRGeometryH ); 182 int CPL_DLL OGR_G_Crosses( OGRGeometryH, OGRGeometryH ); 183 int CPL_DLL OGR_G_Within( OGRGeometryH, OGRGeometryH ); 184 int CPL_DLL OGR_G_Contains( OGRGeometryH, OGRGeometryH ); 185 int CPL_DLL OGR_G_Overlaps( OGRGeometryH, OGRGeometryH ); 186 187 OGRGeometryH CPL_DLL OGR_G_Boundary( OGRGeometryH ) CPL_WARN_UNUSED_RESULT; 188 OGRGeometryH CPL_DLL OGR_G_ConvexHull( OGRGeometryH ) CPL_WARN_UNUSED_RESULT; 189 OGRGeometryH CPL_DLL OGR_G_Buffer( OGRGeometryH, double, int ) CPL_WARN_UNUSED_RESULT; 190 OGRGeometryH CPL_DLL OGR_G_Intersection( OGRGeometryH, OGRGeometryH ) CPL_WARN_UNUSED_RESULT; 191 OGRGeometryH CPL_DLL OGR_G_Union( OGRGeometryH, OGRGeometryH ) CPL_WARN_UNUSED_RESULT; 192 OGRGeometryH CPL_DLL OGR_G_UnionCascaded( OGRGeometryH ) CPL_WARN_UNUSED_RESULT; 193 OGRGeometryH CPL_DLL OGR_G_PointOnSurface( OGRGeometryH ) CPL_WARN_UNUSED_RESULT; 194 /*OGRGeometryH CPL_DLL OGR_G_Polygonize( OGRGeometryH *, int);*/ 195 /*OGRGeometryH CPL_DLL OGR_G_Polygonizer_getCutEdges( OGRGeometryH *, int);*/ 196 /*OGRGeometryH CPL_DLL OGR_G_LineMerge( OGRGeometryH );*/ 197 198 OGRGeometryH CPL_DLL OGR_G_Difference( OGRGeometryH, OGRGeometryH ) CPL_WARN_UNUSED_RESULT; 199 OGRGeometryH CPL_DLL OGR_G_SymDifference( OGRGeometryH, OGRGeometryH ) CPL_WARN_UNUSED_RESULT; 200 double CPL_DLL OGR_G_Distance( OGRGeometryH, OGRGeometryH ); 201 double CPL_DLL OGR_G_Distance3D( OGRGeometryH, OGRGeometryH ); 202 double CPL_DLL OGR_G_Length( OGRGeometryH ); 203 double CPL_DLL OGR_G_Area( OGRGeometryH ); 204 int CPL_DLL OGR_G_Centroid( OGRGeometryH, OGRGeometryH ); 205 OGRGeometryH CPL_DLL OGR_G_Value( OGRGeometryH, double dfDistance ) CPL_WARN_UNUSED_RESULT; 206 207 void CPL_DLL OGR_G_Empty( OGRGeometryH ); 208 int CPL_DLL OGR_G_IsEmpty( OGRGeometryH ); 209 int CPL_DLL OGR_G_IsValid( OGRGeometryH ); 210 /*char CPL_DLL *OGR_G_IsValidReason( OGRGeometryH );*/ 211 OGRGeometryH CPL_DLL OGR_G_MakeValid( OGRGeometryH ) CPL_WARN_UNUSED_RESULT; 212 OGRGeometryH CPL_DLL OGR_G_Normalize( OGRGeometryH ) CPL_WARN_UNUSED_RESULT; 213 int CPL_DLL OGR_G_IsSimple( OGRGeometryH ); 214 int CPL_DLL OGR_G_IsRing( OGRGeometryH ); 215 216 OGRGeometryH CPL_DLL OGR_G_Polygonize( OGRGeometryH ) CPL_WARN_UNUSED_RESULT; 217 218 /*! @cond Doxygen_Suppress */ 219 /* backward compatibility (non-standard methods) */ 220 int CPL_DLL OGR_G_Intersect( OGRGeometryH, OGRGeometryH ) CPL_WARN_DEPRECATED("Non standard method. Use OGR_G_Intersects() instead"); 221 int CPL_DLL OGR_G_Equal( OGRGeometryH, OGRGeometryH ) CPL_WARN_DEPRECATED("Non standard method. Use OGR_G_Equals() instead"); 222 OGRGeometryH CPL_DLL OGR_G_SymmetricDifference( OGRGeometryH, OGRGeometryH ) CPL_WARN_DEPRECATED("Non standard method. Use OGR_G_SymDifference() instead"); 223 double CPL_DLL OGR_G_GetArea( OGRGeometryH ) CPL_WARN_DEPRECATED("Non standard method. Use OGR_G_Area() instead"); 224 OGRGeometryH CPL_DLL OGR_G_GetBoundary( OGRGeometryH ) CPL_WARN_DEPRECATED("Non standard method. Use OGR_G_Boundary() instead"); 225 /*! @endcond */ 226 227 /* Methods for getting/setting vertices in points, line strings and rings */ 228 int CPL_DLL OGR_G_GetPointCount( OGRGeometryH ); 229 int CPL_DLL OGR_G_GetPoints( OGRGeometryH hGeom, 230 void* pabyX, int nXStride, 231 void* pabyY, int nYStride, 232 void* pabyZ, int nZStride); 233 int CPL_DLL OGR_G_GetPointsZM( OGRGeometryH hGeom, 234 void* pabyX, int nXStride, 235 void* pabyY, int nYStride, 236 void* pabyZ, int nZStride, 237 void* pabyM, int nMStride); 238 double CPL_DLL OGR_G_GetX( OGRGeometryH, int ); 239 double CPL_DLL OGR_G_GetY( OGRGeometryH, int ); 240 double CPL_DLL OGR_G_GetZ( OGRGeometryH, int ); 241 double CPL_DLL OGR_G_GetM( OGRGeometryH, int ); 242 void CPL_DLL OGR_G_GetPoint( OGRGeometryH, int iPoint, 243 double *, double *, double * ); 244 void CPL_DLL OGR_G_GetPointZM( OGRGeometryH, int iPoint, 245 double *, double *, double *, double * ); 246 void CPL_DLL OGR_G_SetPointCount( OGRGeometryH hGeom, int nNewPointCount ); 247 void CPL_DLL OGR_G_SetPoint( OGRGeometryH, int iPoint, 248 double, double, double ); 249 void CPL_DLL OGR_G_SetPoint_2D( OGRGeometryH, int iPoint, 250 double, double ); 251 void CPL_DLL OGR_G_SetPointM( OGRGeometryH, int iPoint, 252 double, double, double ); 253 void CPL_DLL OGR_G_SetPointZM( OGRGeometryH, int iPoint, 254 double, double, double, double ); 255 void CPL_DLL OGR_G_AddPoint( OGRGeometryH, double, double, double ); 256 void CPL_DLL OGR_G_AddPoint_2D( OGRGeometryH, double, double ); 257 void CPL_DLL OGR_G_AddPointM( OGRGeometryH, double, double, double ); 258 void CPL_DLL OGR_G_AddPointZM( OGRGeometryH, double, double, double, double ); 259 void CPL_DLL OGR_G_SetPoints( OGRGeometryH hGeom, int nPointsIn, 260 const void* pabyX, int nXStride, 261 const void* pabyY, int nYStride, 262 const void* pabyZ, int nZStride ); 263 void CPL_DLL OGR_G_SetPointsZM( OGRGeometryH hGeom, int nPointsIn, 264 const void* pabyX, int nXStride, 265 const void* pabyY, int nYStride, 266 const void* pabyZ, int nZStride, 267 const void* pabyM, int nMStride ); 268 void CPL_DLL OGR_G_SwapXY( OGRGeometryH hGeom ); 269 270 /* Methods for getting/setting rings and members collections */ 271 272 int CPL_DLL OGR_G_GetGeometryCount( OGRGeometryH ); 273 OGRGeometryH CPL_DLL OGR_G_GetGeometryRef( OGRGeometryH, int ); 274 OGRErr CPL_DLL OGR_G_AddGeometry( OGRGeometryH, OGRGeometryH ); 275 OGRErr CPL_DLL OGR_G_AddGeometryDirectly( OGRGeometryH, OGRGeometryH ); 276 OGRErr CPL_DLL OGR_G_RemoveGeometry( OGRGeometryH, int, int ); 277 278 int CPL_DLL OGR_G_HasCurveGeometry( OGRGeometryH, int bLookForNonLinear ); 279 OGRGeometryH CPL_DLL OGR_G_GetLinearGeometry( OGRGeometryH hGeom, 280 double dfMaxAngleStepSizeDegrees, 281 char** papszOptions) CPL_WARN_UNUSED_RESULT; 282 OGRGeometryH CPL_DLL OGR_G_GetCurveGeometry( OGRGeometryH hGeom, 283 char** papszOptions ) CPL_WARN_UNUSED_RESULT; 284 285 OGRGeometryH CPL_DLL 286 OGRBuildPolygonFromEdges( OGRGeometryH hLinesAsCollection, 287 int bBestEffort, 288 int bAutoClose, 289 double dfTolerance, 290 OGRErr * peErr ) CPL_WARN_UNUSED_RESULT; 291 292 /*! @cond Doxygen_Suppress */ 293 OGRErr CPL_DLL OGRSetGenerate_DB2_V72_BYTE_ORDER( 294 int bGenerate_DB2_V72_BYTE_ORDER ); 295 296 int CPL_DLL OGRGetGenerate_DB2_V72_BYTE_ORDER(void); 297 /*! @endcond */ 298 299 void CPL_DLL OGRSetNonLinearGeometriesEnabledFlag(int bFlag); 300 int CPL_DLL OGRGetNonLinearGeometriesEnabledFlag(void); 301 302 /** Opaque type for a prepared geometry */ 303 typedef struct _OGRPreparedGeometry * OGRPreparedGeometryH; 304 305 int CPL_DLL OGRHasPreparedGeometrySupport(void); 306 OGRPreparedGeometryH CPL_DLL OGRCreatePreparedGeometry( OGRGeometryH hGeom ); 307 void CPL_DLL OGRDestroyPreparedGeometry( OGRPreparedGeometryH hPreparedGeom ); 308 int CPL_DLL OGRPreparedGeometryIntersects( OGRPreparedGeometryH hPreparedGeom, 309 OGRGeometryH hOtherGeom ); 310 int CPL_DLL OGRPreparedGeometryContains( OGRPreparedGeometryH hPreparedGeom, 311 OGRGeometryH hOtherGeom ); 312 313 /* -------------------------------------------------------------------- */ 314 /* Feature related (ogr_feature.h) */ 315 /* -------------------------------------------------------------------- */ 316 317 #ifndef DEFINE_OGRFeatureH 318 /*! @cond Doxygen_Suppress */ 319 #define DEFINE_OGRFeatureH 320 /*! @endcond */ 321 #ifdef DEBUG 322 typedef struct OGRFieldDefnHS *OGRFieldDefnH; 323 typedef struct OGRFeatureDefnHS *OGRFeatureDefnH; 324 typedef struct OGRFeatureHS *OGRFeatureH; 325 typedef struct OGRStyleTableHS *OGRStyleTableH; 326 #else 327 /** Opaque type for a field definition (OGRFieldDefn) */ 328 typedef void *OGRFieldDefnH; 329 /** Opaque type for a feature definition (OGRFeatureDefn) */ 330 typedef void *OGRFeatureDefnH; 331 /** Opaque type for a feature (OGRFeature) */ 332 typedef void *OGRFeatureH; 333 /** Opaque type for a style table (OGRStyleTable) */ 334 typedef void *OGRStyleTableH; 335 #endif 336 /** Opaque type for a geometry field definition (OGRGeomFieldDefn) */ 337 typedef struct OGRGeomFieldDefnHS *OGRGeomFieldDefnH; 338 339 /** Opaque type for a field domain definition (OGRFieldDomain) */ 340 typedef struct OGRFieldDomainHS *OGRFieldDomainH; 341 #endif /* DEFINE_OGRFeatureH */ 342 343 /* OGRFieldDefn */ 344 345 OGRFieldDefnH CPL_DLL OGR_Fld_Create( const char *, OGRFieldType ) CPL_WARN_UNUSED_RESULT; 346 void CPL_DLL OGR_Fld_Destroy( OGRFieldDefnH ); 347 348 void CPL_DLL OGR_Fld_SetName( OGRFieldDefnH, const char * ); 349 const char CPL_DLL *OGR_Fld_GetNameRef( OGRFieldDefnH ); 350 void CPL_DLL OGR_Fld_SetAlternativeName( OGRFieldDefnH, const char * ); 351 const char CPL_DLL *OGR_Fld_GetAlternativeNameRef( OGRFieldDefnH ); 352 OGRFieldType CPL_DLL OGR_Fld_GetType( OGRFieldDefnH ); 353 void CPL_DLL OGR_Fld_SetType( OGRFieldDefnH, OGRFieldType ); 354 OGRFieldSubType CPL_DLL OGR_Fld_GetSubType( OGRFieldDefnH ); 355 void CPL_DLL OGR_Fld_SetSubType( OGRFieldDefnH, OGRFieldSubType ); 356 OGRJustification CPL_DLL OGR_Fld_GetJustify( OGRFieldDefnH ); 357 void CPL_DLL OGR_Fld_SetJustify( OGRFieldDefnH, OGRJustification ); 358 int CPL_DLL OGR_Fld_GetWidth( OGRFieldDefnH ); 359 void CPL_DLL OGR_Fld_SetWidth( OGRFieldDefnH, int ); 360 int CPL_DLL OGR_Fld_GetPrecision( OGRFieldDefnH ); 361 void CPL_DLL OGR_Fld_SetPrecision( OGRFieldDefnH, int ); 362 void CPL_DLL OGR_Fld_Set( OGRFieldDefnH, const char *, OGRFieldType, 363 int, int, OGRJustification ); 364 int CPL_DLL OGR_Fld_IsIgnored( OGRFieldDefnH hDefn ); 365 void CPL_DLL OGR_Fld_SetIgnored( OGRFieldDefnH hDefn, int ); 366 int CPL_DLL OGR_Fld_IsNullable( OGRFieldDefnH hDefn ); 367 void CPL_DLL OGR_Fld_SetNullable( OGRFieldDefnH hDefn, int ); 368 int CPL_DLL OGR_Fld_IsUnique( OGRFieldDefnH hDefn ); 369 void CPL_DLL OGR_Fld_SetUnique( OGRFieldDefnH hDefn, int ); 370 const char CPL_DLL *OGR_Fld_GetDefault( OGRFieldDefnH hDefn ); 371 void CPL_DLL OGR_Fld_SetDefault( OGRFieldDefnH hDefn, const char* ); 372 int CPL_DLL OGR_Fld_IsDefaultDriverSpecific( OGRFieldDefnH hDefn ); 373 const char CPL_DLL* OGR_Fld_GetDomainName( OGRFieldDefnH hDefn ); 374 void CPL_DLL OGR_Fld_SetDomainName( OGRFieldDefnH hDefn, const char* ); 375 376 const char CPL_DLL *OGR_GetFieldTypeName( OGRFieldType ); 377 const char CPL_DLL *OGR_GetFieldSubTypeName( OGRFieldSubType ); 378 int CPL_DLL OGR_AreTypeSubTypeCompatible( OGRFieldType eType, 379 OGRFieldSubType eSubType ); 380 381 /* OGRGeomFieldDefnH */ 382 383 OGRGeomFieldDefnH CPL_DLL OGR_GFld_Create( const char *, OGRwkbGeometryType ) CPL_WARN_UNUSED_RESULT; 384 void CPL_DLL OGR_GFld_Destroy( OGRGeomFieldDefnH ); 385 386 void CPL_DLL OGR_GFld_SetName( OGRGeomFieldDefnH, const char * ); 387 const char CPL_DLL *OGR_GFld_GetNameRef( OGRGeomFieldDefnH ); 388 389 OGRwkbGeometryType CPL_DLL OGR_GFld_GetType( OGRGeomFieldDefnH ); 390 void CPL_DLL OGR_GFld_SetType( OGRGeomFieldDefnH, OGRwkbGeometryType ); 391 392 OGRSpatialReferenceH CPL_DLL OGR_GFld_GetSpatialRef( OGRGeomFieldDefnH ); 393 void CPL_DLL OGR_GFld_SetSpatialRef( OGRGeomFieldDefnH, 394 OGRSpatialReferenceH hSRS ); 395 396 int CPL_DLL OGR_GFld_IsNullable( OGRGeomFieldDefnH hDefn ); 397 void CPL_DLL OGR_GFld_SetNullable( OGRGeomFieldDefnH hDefn, int ); 398 399 int CPL_DLL OGR_GFld_IsIgnored( OGRGeomFieldDefnH hDefn ); 400 void CPL_DLL OGR_GFld_SetIgnored( OGRGeomFieldDefnH hDefn, int ); 401 402 /* OGRFeatureDefn */ 403 404 OGRFeatureDefnH CPL_DLL OGR_FD_Create( const char * ) CPL_WARN_UNUSED_RESULT; 405 void CPL_DLL OGR_FD_Destroy( OGRFeatureDefnH ); 406 void CPL_DLL OGR_FD_Release( OGRFeatureDefnH ); 407 const char CPL_DLL *OGR_FD_GetName( OGRFeatureDefnH ); 408 int CPL_DLL OGR_FD_GetFieldCount( OGRFeatureDefnH ); 409 OGRFieldDefnH CPL_DLL OGR_FD_GetFieldDefn( OGRFeatureDefnH, int ); 410 int CPL_DLL OGR_FD_GetFieldIndex( OGRFeatureDefnH, const char * ); 411 void CPL_DLL OGR_FD_AddFieldDefn( OGRFeatureDefnH, OGRFieldDefnH ); 412 OGRErr CPL_DLL OGR_FD_DeleteFieldDefn( OGRFeatureDefnH hDefn, int iField ); 413 OGRErr CPL_DLL OGR_FD_ReorderFieldDefns( OGRFeatureDefnH hDefn, int* panMap ); 414 OGRwkbGeometryType CPL_DLL OGR_FD_GetGeomType( OGRFeatureDefnH ); 415 void CPL_DLL OGR_FD_SetGeomType( OGRFeatureDefnH, OGRwkbGeometryType ); 416 int CPL_DLL OGR_FD_IsGeometryIgnored( OGRFeatureDefnH ); 417 void CPL_DLL OGR_FD_SetGeometryIgnored( OGRFeatureDefnH, int ); 418 int CPL_DLL OGR_FD_IsStyleIgnored( OGRFeatureDefnH ); 419 void CPL_DLL OGR_FD_SetStyleIgnored( OGRFeatureDefnH, int ); 420 int CPL_DLL OGR_FD_Reference( OGRFeatureDefnH ); 421 int CPL_DLL OGR_FD_Dereference( OGRFeatureDefnH ); 422 int CPL_DLL OGR_FD_GetReferenceCount( OGRFeatureDefnH ); 423 424 int CPL_DLL OGR_FD_GetGeomFieldCount( OGRFeatureDefnH hFDefn ); 425 OGRGeomFieldDefnH CPL_DLL OGR_FD_GetGeomFieldDefn( OGRFeatureDefnH hFDefn, 426 int i ); 427 int CPL_DLL OGR_FD_GetGeomFieldIndex( OGRFeatureDefnH hFDefn, 428 const char *pszName); 429 430 void CPL_DLL OGR_FD_AddGeomFieldDefn( OGRFeatureDefnH hFDefn, 431 OGRGeomFieldDefnH hGFldDefn); 432 OGRErr CPL_DLL OGR_FD_DeleteGeomFieldDefn( OGRFeatureDefnH hFDefn, 433 int iGeomField ); 434 int CPL_DLL OGR_FD_IsSame( OGRFeatureDefnH hFDefn, 435 OGRFeatureDefnH hOtherFDefn ); 436 /* OGRFeature */ 437 438 OGRFeatureH CPL_DLL OGR_F_Create( OGRFeatureDefnH ) CPL_WARN_UNUSED_RESULT; 439 void CPL_DLL OGR_F_Destroy( OGRFeatureH ); 440 OGRFeatureDefnH CPL_DLL OGR_F_GetDefnRef( OGRFeatureH ); 441 442 OGRErr CPL_DLL OGR_F_SetGeometryDirectly( OGRFeatureH, OGRGeometryH ); 443 OGRErr CPL_DLL OGR_F_SetGeometry( OGRFeatureH, OGRGeometryH ); 444 OGRGeometryH CPL_DLL OGR_F_GetGeometryRef( OGRFeatureH ); 445 OGRGeometryH CPL_DLL OGR_F_StealGeometry( OGRFeatureH ) CPL_WARN_UNUSED_RESULT; 446 OGRFeatureH CPL_DLL OGR_F_Clone( OGRFeatureH ) CPL_WARN_UNUSED_RESULT; 447 int CPL_DLL OGR_F_Equal( OGRFeatureH, OGRFeatureH ); 448 449 int CPL_DLL OGR_F_GetFieldCount( OGRFeatureH ); 450 OGRFieldDefnH CPL_DLL OGR_F_GetFieldDefnRef( OGRFeatureH, int ); 451 int CPL_DLL OGR_F_GetFieldIndex( OGRFeatureH, const char * ); 452 453 int CPL_DLL OGR_F_IsFieldSet( OGRFeatureH, int ); 454 void CPL_DLL OGR_F_UnsetField( OGRFeatureH, int ); 455 456 int CPL_DLL OGR_F_IsFieldNull( OGRFeatureH, int ); 457 int CPL_DLL OGR_F_IsFieldSetAndNotNull( OGRFeatureH, int ); 458 void CPL_DLL OGR_F_SetFieldNull( OGRFeatureH, int ); 459 460 OGRField CPL_DLL *OGR_F_GetRawFieldRef( OGRFeatureH, int ); 461 462 int CPL_DLL OGR_RawField_IsUnset( const OGRField* ); 463 int CPL_DLL OGR_RawField_IsNull( const OGRField* ); 464 void CPL_DLL OGR_RawField_SetUnset( OGRField* ); 465 void CPL_DLL OGR_RawField_SetNull( OGRField* ); 466 467 int CPL_DLL OGR_F_GetFieldAsInteger( OGRFeatureH, int ); 468 GIntBig CPL_DLL OGR_F_GetFieldAsInteger64( OGRFeatureH, int ); 469 double CPL_DLL OGR_F_GetFieldAsDouble( OGRFeatureH, int ); 470 const char CPL_DLL *OGR_F_GetFieldAsString( OGRFeatureH, int ); 471 const int CPL_DLL *OGR_F_GetFieldAsIntegerList( OGRFeatureH, int, int * ); 472 const GIntBig CPL_DLL *OGR_F_GetFieldAsInteger64List( OGRFeatureH, int, int * ); 473 const double CPL_DLL *OGR_F_GetFieldAsDoubleList( OGRFeatureH, int, int * ); 474 char CPL_DLL **OGR_F_GetFieldAsStringList( OGRFeatureH, int ); 475 GByte CPL_DLL *OGR_F_GetFieldAsBinary( OGRFeatureH, int, int * ); 476 int CPL_DLL OGR_F_GetFieldAsDateTime( OGRFeatureH, int, int *, int *, int *, 477 int *, int *, int *, int * ); 478 int CPL_DLL OGR_F_GetFieldAsDateTimeEx( OGRFeatureH hFeat, int iField, 479 int *pnYear, int *pnMonth, int *pnDay, 480 int *pnHour, int *pnMinute, float *pfSecond, 481 int *pnTZFlag ); 482 483 void CPL_DLL OGR_F_SetFieldInteger( OGRFeatureH, int, int ); 484 void CPL_DLL OGR_F_SetFieldInteger64( OGRFeatureH, int, GIntBig ); 485 void CPL_DLL OGR_F_SetFieldDouble( OGRFeatureH, int, double ); 486 void CPL_DLL OGR_F_SetFieldString( OGRFeatureH, int, const char * ); 487 void CPL_DLL OGR_F_SetFieldIntegerList( OGRFeatureH, int, int, const int * ); 488 void CPL_DLL OGR_F_SetFieldInteger64List( OGRFeatureH, int, int, const GIntBig * ); 489 void CPL_DLL OGR_F_SetFieldDoubleList( OGRFeatureH, int, int, const double * ); 490 void CPL_DLL OGR_F_SetFieldStringList( OGRFeatureH, int, CSLConstList ); 491 void CPL_DLL OGR_F_SetFieldRaw( OGRFeatureH, int, OGRField * ); 492 void CPL_DLL OGR_F_SetFieldBinary( OGRFeatureH, int, int, const void * ); 493 void CPL_DLL OGR_F_SetFieldDateTime( OGRFeatureH, int, 494 int, int, int, int, int, int, int ); 495 void CPL_DLL OGR_F_SetFieldDateTimeEx( OGRFeatureH, int, 496 int, int, int, int, int, float, int ); 497 498 int CPL_DLL OGR_F_GetGeomFieldCount( OGRFeatureH hFeat ); 499 OGRGeomFieldDefnH CPL_DLL OGR_F_GetGeomFieldDefnRef( OGRFeatureH hFeat, 500 int iField ); 501 int CPL_DLL OGR_F_GetGeomFieldIndex( OGRFeatureH hFeat, 502 const char *pszName); 503 504 OGRGeometryH CPL_DLL OGR_F_GetGeomFieldRef( OGRFeatureH hFeat, 505 int iField ); 506 OGRErr CPL_DLL OGR_F_SetGeomFieldDirectly( OGRFeatureH hFeat, 507 int iField, 508 OGRGeometryH hGeom ); 509 OGRErr CPL_DLL OGR_F_SetGeomField( OGRFeatureH hFeat, 510 int iField, OGRGeometryH hGeom ); 511 512 GIntBig CPL_DLL OGR_F_GetFID( OGRFeatureH ); 513 OGRErr CPL_DLL OGR_F_SetFID( OGRFeatureH, GIntBig ); 514 void CPL_DLL OGR_F_DumpReadable( OGRFeatureH, FILE * ); 515 OGRErr CPL_DLL OGR_F_SetFrom( OGRFeatureH, OGRFeatureH, int ); 516 OGRErr CPL_DLL OGR_F_SetFromWithMap( OGRFeatureH, OGRFeatureH, int , const int * ); 517 518 const char CPL_DLL *OGR_F_GetStyleString( OGRFeatureH ); 519 void CPL_DLL OGR_F_SetStyleString( OGRFeatureH, const char * ); 520 void CPL_DLL OGR_F_SetStyleStringDirectly( OGRFeatureH, char * ); 521 /** Return style table */ 522 OGRStyleTableH CPL_DLL OGR_F_GetStyleTable( OGRFeatureH ); 523 /** Set style table and take ownership */ 524 void CPL_DLL OGR_F_SetStyleTableDirectly( OGRFeatureH, OGRStyleTableH ); 525 /** Set style table */ 526 void CPL_DLL OGR_F_SetStyleTable( OGRFeatureH, OGRStyleTableH ); 527 528 const char CPL_DLL *OGR_F_GetNativeData( OGRFeatureH ); 529 void CPL_DLL OGR_F_SetNativeData( OGRFeatureH, const char* ); 530 const char CPL_DLL *OGR_F_GetNativeMediaType( OGRFeatureH ); 531 void CPL_DLL OGR_F_SetNativeMediaType( OGRFeatureH, const char* ); 532 533 void CPL_DLL OGR_F_FillUnsetWithDefault( OGRFeatureH hFeat, 534 int bNotNullableOnly, 535 char** papszOptions ); 536 int CPL_DLL OGR_F_Validate( OGRFeatureH, int nValidateFlags, int bEmitError ); 537 538 /* OGRFieldDomain */ 539 540 void CPL_DLL OGR_FldDomain_Destroy(OGRFieldDomainH); 541 const char CPL_DLL* OGR_FldDomain_GetName(OGRFieldDomainH); 542 const char CPL_DLL* OGR_FldDomain_GetDescription(OGRFieldDomainH); 543 OGRFieldDomainType CPL_DLL OGR_FldDomain_GetDomainType(OGRFieldDomainH); 544 OGRFieldType CPL_DLL OGR_FldDomain_GetFieldType(OGRFieldDomainH); 545 OGRFieldSubType CPL_DLL OGR_FldDomain_GetFieldSubType(OGRFieldDomainH); 546 OGRFieldDomainSplitPolicy CPL_DLL OGR_FldDomain_GetSplitPolicy(OGRFieldDomainH); 547 void CPL_DLL OGR_FldDomain_SetSplitPolicy(OGRFieldDomainH, OGRFieldDomainSplitPolicy); 548 OGRFieldDomainMergePolicy CPL_DLL OGR_FldDomain_GetMergePolicy(OGRFieldDomainH); 549 void CPL_DLL OGR_FldDomain_SetMergePolicy(OGRFieldDomainH, OGRFieldDomainMergePolicy); 550 551 OGRFieldDomainH CPL_DLL OGR_CodedFldDomain_Create(const char* pszName, 552 const char* pszDescription, 553 OGRFieldType eFieldType, 554 OGRFieldSubType eFieldSubType, 555 const OGRCodedValue* enumeration); 556 const OGRCodedValue CPL_DLL* OGR_CodedFldDomain_GetEnumeration(OGRFieldDomainH); 557 558 OGRFieldDomainH CPL_DLL OGR_RangeFldDomain_Create(const char* pszName, 559 const char* pszDescription, 560 OGRFieldType eFieldType, 561 OGRFieldSubType eFieldSubType, 562 const OGRField* psMin, 563 bool bMinIsInclusive, 564 const OGRField* psMax, 565 bool bMaxIsInclusive); 566 const OGRField CPL_DLL *OGR_RangeFldDomain_GetMin(OGRFieldDomainH, bool* pbIsInclusiveOut); 567 const OGRField CPL_DLL *OGR_RangeFldDomain_GetMax(OGRFieldDomainH, bool* pbIsInclusiveOut); 568 569 OGRFieldDomainH CPL_DLL OGR_GlobFldDomain_Create(const char* pszName, 570 const char* pszDescription, 571 OGRFieldType eFieldType, 572 OGRFieldSubType eFieldSubType, 573 const char* pszGlob); 574 const char CPL_DLL *OGR_GlobFldDomain_GetGlob(OGRFieldDomainH); 575 576 /* -------------------------------------------------------------------- */ 577 /* ogrsf_frmts.h */ 578 /* -------------------------------------------------------------------- */ 579 580 #ifdef DEBUG 581 typedef struct OGRLayerHS *OGRLayerH; 582 typedef struct OGRDataSourceHS *OGRDataSourceH; 583 typedef struct OGRDriverHS *OGRSFDriverH; 584 #else 585 /** Opaque type for a layer (OGRLayer) */ 586 typedef void *OGRLayerH; 587 /** Opaque type for a OGR datasource (OGRDataSource) */ 588 typedef void *OGRDataSourceH; 589 /** Opaque type for a OGR driver (OGRSFDriver) */ 590 typedef void *OGRSFDriverH; 591 #endif 592 593 /* OGRLayer */ 594 595 const char CPL_DLL* OGR_L_GetName( OGRLayerH ); 596 OGRwkbGeometryType CPL_DLL OGR_L_GetGeomType( OGRLayerH ); 597 OGRGeometryH CPL_DLL OGR_L_GetSpatialFilter( OGRLayerH ); 598 void CPL_DLL OGR_L_SetSpatialFilter( OGRLayerH, OGRGeometryH ); 599 void CPL_DLL OGR_L_SetSpatialFilterRect( OGRLayerH, 600 double, double, double, double ); 601 void CPL_DLL OGR_L_SetSpatialFilterEx( OGRLayerH, int iGeomField, 602 OGRGeometryH hGeom ); 603 void CPL_DLL OGR_L_SetSpatialFilterRectEx( OGRLayerH, int iGeomField, 604 double dfMinX, double dfMinY, 605 double dfMaxX, double dfMaxY ); 606 OGRErr CPL_DLL OGR_L_SetAttributeFilter( OGRLayerH, const char * ); 607 void CPL_DLL OGR_L_ResetReading( OGRLayerH ); 608 OGRFeatureH CPL_DLL OGR_L_GetNextFeature( OGRLayerH ) CPL_WARN_UNUSED_RESULT; 609 610 /*! @endcond */ 611 612 /** Conveniency macro to iterate over features of a layer. 613 * 614 * Typical usage is: 615 * <pre> 616 * OGR_FOR_EACH_FEATURE_BEGIN(hFeat, hLayer) 617 * { 618 * // Do something, including continue, break; 619 * // Do not explicitly destroy the feature (unless you use return or goto 620 * // outside of the loop, in which case use OGR_F_Destroy(hFeat)) 621 * } 622 * OGR_FOR_EACH_FEATURE_END(hFeat) 623 * </pre> 624 * 625 * In C++, you might want to use instead range-based loop: 626 * <pre> 627 * for( auto&& poFeature: poLayer ) 628 * { 629 * } 630 * </pre> 631 * 632 * @param hFeat variable name for OGRFeatureH. The variable will be declared 633 * inside the macro body. 634 * @param hLayer layer to iterate over. 635 * 636 * @since GDAL 2.3 637 */ 638 #define OGR_FOR_EACH_FEATURE_BEGIN(hFeat, hLayer) \ 639 { \ 640 OGRFeatureH hFeat = CPL_NULLPTR; \ 641 OGR_L_ResetReading(hLayer); \ 642 while( true) \ 643 { \ 644 if( hFeat ) \ 645 OGR_F_Destroy(hFeat); \ 646 hFeat = OGR_L_GetNextFeature(hLayer); \ 647 if( !hFeat ) \ 648 break; 649 650 /** End of iterator. */ 651 #define OGR_FOR_EACH_FEATURE_END(hFeat) \ 652 } \ 653 OGR_F_Destroy(hFeat); \ 654 } 655 656 OGRErr CPL_DLL OGR_L_SetNextByIndex( OGRLayerH, GIntBig ); 657 OGRFeatureH CPL_DLL OGR_L_GetFeature( OGRLayerH, GIntBig ) CPL_WARN_UNUSED_RESULT; 658 OGRErr CPL_DLL OGR_L_SetFeature( OGRLayerH, OGRFeatureH ) CPL_WARN_UNUSED_RESULT; 659 OGRErr CPL_DLL OGR_L_CreateFeature( OGRLayerH, OGRFeatureH ) CPL_WARN_UNUSED_RESULT; 660 OGRErr CPL_DLL OGR_L_DeleteFeature( OGRLayerH, GIntBig ) CPL_WARN_UNUSED_RESULT; 661 OGRFeatureDefnH CPL_DLL OGR_L_GetLayerDefn( OGRLayerH ); 662 OGRSpatialReferenceH CPL_DLL OGR_L_GetSpatialRef( OGRLayerH ); 663 int CPL_DLL OGR_L_FindFieldIndex( OGRLayerH, const char *, int bExactMatch ); 664 GIntBig CPL_DLL OGR_L_GetFeatureCount( OGRLayerH, int ); 665 OGRErr CPL_DLL OGR_L_GetExtent( OGRLayerH, OGREnvelope *, int ); 666 OGRErr CPL_DLL OGR_L_GetExtentEx( OGRLayerH, int iGeomField, 667 OGREnvelope *psExtent, int bForce ); 668 int CPL_DLL OGR_L_TestCapability( OGRLayerH, const char * ); 669 OGRErr CPL_DLL OGR_L_CreateField( OGRLayerH, OGRFieldDefnH, int ); 670 OGRErr CPL_DLL OGR_L_CreateGeomField( OGRLayerH hLayer, 671 OGRGeomFieldDefnH hFieldDefn, int bForce ); 672 OGRErr CPL_DLL OGR_L_DeleteField( OGRLayerH, int iField ); 673 OGRErr CPL_DLL OGR_L_ReorderFields( OGRLayerH, int* panMap ); 674 OGRErr CPL_DLL OGR_L_ReorderField( OGRLayerH, int iOldFieldPos, int iNewFieldPos ); 675 OGRErr CPL_DLL OGR_L_AlterFieldDefn( OGRLayerH, int iField, OGRFieldDefnH hNewFieldDefn, int nFlags ); 676 OGRErr CPL_DLL OGR_L_StartTransaction( OGRLayerH ) CPL_WARN_UNUSED_RESULT; 677 OGRErr CPL_DLL OGR_L_CommitTransaction( OGRLayerH ) CPL_WARN_UNUSED_RESULT; 678 OGRErr CPL_DLL OGR_L_RollbackTransaction( OGRLayerH ); 679 /*! @cond Doxygen_Suppress */ 680 int CPL_DLL OGR_L_Reference( OGRLayerH ); 681 int CPL_DLL OGR_L_Dereference( OGRLayerH ); 682 int CPL_DLL OGR_L_GetRefCount( OGRLayerH ); 683 /*! @endcond */ 684 OGRErr CPL_DLL OGR_L_SyncToDisk( OGRLayerH ); 685 /*! @cond Doxygen_Suppress */ 686 GIntBig CPL_DLL OGR_L_GetFeaturesRead( OGRLayerH ); 687 /*! @endcond */ 688 const char CPL_DLL *OGR_L_GetFIDColumn( OGRLayerH ); 689 const char CPL_DLL *OGR_L_GetGeometryColumn( OGRLayerH ); 690 /** Get style table */ 691 OGRStyleTableH CPL_DLL OGR_L_GetStyleTable( OGRLayerH ); 692 /** Set style table (and take ownership) */ 693 void CPL_DLL OGR_L_SetStyleTableDirectly( OGRLayerH, OGRStyleTableH ); 694 /** Set style table */ 695 void CPL_DLL OGR_L_SetStyleTable( OGRLayerH, OGRStyleTableH ); 696 OGRErr CPL_DLL OGR_L_SetIgnoredFields( OGRLayerH, const char** ); 697 OGRErr CPL_DLL OGR_L_Intersection( OGRLayerH, OGRLayerH, OGRLayerH, char**, GDALProgressFunc, void * ); 698 OGRErr CPL_DLL OGR_L_Union( OGRLayerH, OGRLayerH, OGRLayerH, char**, GDALProgressFunc, void * ); 699 OGRErr CPL_DLL OGR_L_SymDifference( OGRLayerH, OGRLayerH, OGRLayerH, char**, GDALProgressFunc, void * ); 700 OGRErr CPL_DLL OGR_L_Identity( OGRLayerH, OGRLayerH, OGRLayerH, char**, GDALProgressFunc, void * ); 701 OGRErr CPL_DLL OGR_L_Update( OGRLayerH, OGRLayerH, OGRLayerH, char**, GDALProgressFunc, void * ); 702 OGRErr CPL_DLL OGR_L_Clip( OGRLayerH, OGRLayerH, OGRLayerH, char**, GDALProgressFunc, void * ); 703 OGRErr CPL_DLL OGR_L_Erase( OGRLayerH, OGRLayerH, OGRLayerH, char**, GDALProgressFunc, void * ); 704 705 /* OGRDataSource */ 706 707 void CPL_DLL OGR_DS_Destroy( OGRDataSourceH ); 708 const char CPL_DLL *OGR_DS_GetName( OGRDataSourceH ); 709 int CPL_DLL OGR_DS_GetLayerCount( OGRDataSourceH ); 710 OGRLayerH CPL_DLL OGR_DS_GetLayer( OGRDataSourceH, int ); 711 OGRLayerH CPL_DLL OGR_DS_GetLayerByName( OGRDataSourceH, const char * ); 712 OGRErr CPL_DLL OGR_DS_DeleteLayer( OGRDataSourceH, int ); 713 OGRSFDriverH CPL_DLL OGR_DS_GetDriver( OGRDataSourceH ); 714 OGRLayerH CPL_DLL OGR_DS_CreateLayer( OGRDataSourceH, const char *, 715 OGRSpatialReferenceH, OGRwkbGeometryType, 716 char ** ); 717 OGRLayerH CPL_DLL OGR_DS_CopyLayer( OGRDataSourceH, OGRLayerH, const char *, 718 char ** ); 719 int CPL_DLL OGR_DS_TestCapability( OGRDataSourceH, const char * ); 720 OGRLayerH CPL_DLL OGR_DS_ExecuteSQL( OGRDataSourceH, const char *, 721 OGRGeometryH, const char * ); 722 void CPL_DLL OGR_DS_ReleaseResultSet( OGRDataSourceH, OGRLayerH ); 723 /*! @cond Doxygen_Suppress */ 724 int CPL_DLL OGR_DS_Reference( OGRDataSourceH ); 725 int CPL_DLL OGR_DS_Dereference( OGRDataSourceH ); 726 int CPL_DLL OGR_DS_GetRefCount( OGRDataSourceH ); 727 int CPL_DLL OGR_DS_GetSummaryRefCount( OGRDataSourceH ); 728 /*! @endcond */ 729 /** Flush pending changes to disk. See GDALDataset::FlushCache() */ 730 OGRErr CPL_DLL OGR_DS_SyncToDisk( OGRDataSourceH ); 731 /** Get style table */ 732 OGRStyleTableH CPL_DLL OGR_DS_GetStyleTable( OGRDataSourceH ); 733 /** Set style table (and take ownership) */ 734 void CPL_DLL OGR_DS_SetStyleTableDirectly( OGRDataSourceH, OGRStyleTableH ); 735 /** Set style table */ 736 void CPL_DLL OGR_DS_SetStyleTable( OGRDataSourceH, OGRStyleTableH ); 737 738 /* OGRSFDriver */ 739 740 const char CPL_DLL *OGR_Dr_GetName( OGRSFDriverH ); 741 OGRDataSourceH CPL_DLL OGR_Dr_Open( OGRSFDriverH, const char *, int ) CPL_WARN_UNUSED_RESULT; 742 int CPL_DLL OGR_Dr_TestCapability( OGRSFDriverH, const char * ); 743 OGRDataSourceH CPL_DLL OGR_Dr_CreateDataSource( OGRSFDriverH, const char *, 744 char ** ) CPL_WARN_UNUSED_RESULT; 745 OGRDataSourceH CPL_DLL OGR_Dr_CopyDataSource( OGRSFDriverH, OGRDataSourceH, 746 const char *, char ** ) CPL_WARN_UNUSED_RESULT; 747 OGRErr CPL_DLL OGR_Dr_DeleteDataSource( OGRSFDriverH, const char * ); 748 749 /* OGRSFDriverRegistrar */ 750 751 OGRDataSourceH CPL_DLL OGROpen( const char *, int, OGRSFDriverH * ) CPL_WARN_UNUSED_RESULT; 752 OGRDataSourceH CPL_DLL OGROpenShared( const char *, int, OGRSFDriverH * ) CPL_WARN_UNUSED_RESULT; 753 OGRErr CPL_DLL OGRReleaseDataSource( OGRDataSourceH ); 754 /*! @cond Doxygen_Suppress */ 755 void CPL_DLL OGRRegisterDriver( OGRSFDriverH ); 756 void CPL_DLL OGRDeregisterDriver( OGRSFDriverH ); 757 /*! @endcond */ 758 int CPL_DLL OGRGetDriverCount(void); 759 OGRSFDriverH CPL_DLL OGRGetDriver( int ); 760 OGRSFDriverH CPL_DLL OGRGetDriverByName( const char * ); 761 /*! @cond Doxygen_Suppress */ 762 int CPL_DLL OGRGetOpenDSCount(void); 763 OGRDataSourceH CPL_DLL OGRGetOpenDS( int iDS ); 764 /*! @endcond */ 765 766 void CPL_DLL OGRRegisterAll(void); 767 768 /** Clean-up all drivers (including raster ones starting with GDAL 2.0. 769 * See GDALDestroyDriverManager() */ 770 void CPL_DLL OGRCleanupAll(void); 771 772 /* -------------------------------------------------------------------- */ 773 /* ogrsf_featurestyle.h */ 774 /* -------------------------------------------------------------------- */ 775 776 #ifdef DEBUG 777 typedef struct OGRStyleMgrHS *OGRStyleMgrH; 778 typedef struct OGRStyleToolHS *OGRStyleToolH; 779 #else 780 /** Style manager opaque type */ 781 typedef void *OGRStyleMgrH; 782 /** Style tool opaque type */ 783 typedef void *OGRStyleToolH; 784 #endif 785 786 /* OGRStyleMgr */ 787 788 OGRStyleMgrH CPL_DLL OGR_SM_Create(OGRStyleTableH hStyleTable) CPL_WARN_UNUSED_RESULT; 789 void CPL_DLL OGR_SM_Destroy(OGRStyleMgrH hSM); 790 791 const char CPL_DLL *OGR_SM_InitFromFeature(OGRStyleMgrH hSM, 792 OGRFeatureH hFeat); 793 int CPL_DLL OGR_SM_InitStyleString(OGRStyleMgrH hSM, 794 const char *pszStyleString); 795 int CPL_DLL OGR_SM_GetPartCount(OGRStyleMgrH hSM, 796 const char *pszStyleString); 797 OGRStyleToolH CPL_DLL OGR_SM_GetPart(OGRStyleMgrH hSM, int nPartId, 798 const char *pszStyleString); 799 int CPL_DLL OGR_SM_AddPart(OGRStyleMgrH hSM, OGRStyleToolH hST); 800 int CPL_DLL OGR_SM_AddStyle(OGRStyleMgrH hSM, const char *pszStyleName, 801 const char *pszStyleString); 802 803 /* OGRStyleTool */ 804 805 OGRStyleToolH CPL_DLL OGR_ST_Create(OGRSTClassId eClassId) CPL_WARN_UNUSED_RESULT; 806 void CPL_DLL OGR_ST_Destroy(OGRStyleToolH hST); 807 808 OGRSTClassId CPL_DLL OGR_ST_GetType(OGRStyleToolH hST); 809 810 OGRSTUnitId CPL_DLL OGR_ST_GetUnit(OGRStyleToolH hST); 811 void CPL_DLL OGR_ST_SetUnit(OGRStyleToolH hST, OGRSTUnitId eUnit, 812 double dfGroundPaperScale); 813 814 const char CPL_DLL *OGR_ST_GetParamStr(OGRStyleToolH hST, int eParam, int *bValueIsNull); 815 int CPL_DLL OGR_ST_GetParamNum(OGRStyleToolH hST, int eParam, int *bValueIsNull); 816 double CPL_DLL OGR_ST_GetParamDbl(OGRStyleToolH hST, int eParam, int *bValueIsNull); 817 void CPL_DLL OGR_ST_SetParamStr(OGRStyleToolH hST, int eParam, const char *pszValue); 818 void CPL_DLL OGR_ST_SetParamNum(OGRStyleToolH hST, int eParam, int nValue); 819 void CPL_DLL OGR_ST_SetParamDbl(OGRStyleToolH hST, int eParam, double dfValue); 820 const char CPL_DLL *OGR_ST_GetStyleString(OGRStyleToolH hST); 821 822 int CPL_DLL OGR_ST_GetRGBFromString(OGRStyleToolH hST, const char *pszColor, 823 int *pnRed, int *pnGreen, int *pnBlue, 824 int *pnAlpha); 825 826 /* OGRStyleTable */ 827 828 OGRStyleTableH CPL_DLL OGR_STBL_Create( void ) CPL_WARN_UNUSED_RESULT; 829 void CPL_DLL OGR_STBL_Destroy( OGRStyleTableH hSTBL ); 830 int CPL_DLL OGR_STBL_AddStyle( OGRStyleTableH hStyleTable, 831 const char *pszName, 832 const char *pszStyleString); 833 int CPL_DLL OGR_STBL_SaveStyleTable( OGRStyleTableH hStyleTable, 834 const char *pszFilename ); 835 int CPL_DLL OGR_STBL_LoadStyleTable( OGRStyleTableH hStyleTable, 836 const char *pszFilename ); 837 const char CPL_DLL *OGR_STBL_Find( OGRStyleTableH hStyleTable, const char *pszName ); 838 void CPL_DLL OGR_STBL_ResetStyleStringReading( OGRStyleTableH hStyleTable ); 839 const char CPL_DLL *OGR_STBL_GetNextStyle( OGRStyleTableH hStyleTable); 840 const char CPL_DLL *OGR_STBL_GetLastStyleName( OGRStyleTableH hStyleTable); 841 842 CPL_C_END 843 844 #endif /* ndef OGR_API_H_INCLUDED */ 845