GDAL
ogr_api.h
Go to the documentation of this file.
1 /******************************************************************************
2  * $Id: ogr_api.h 7c7402f4226a5d821bfd6bf38af0e682c8720ba7 2020-04-27 13:06:52 +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 
43 #include "cpl_progress.h"
44 #include "cpl_minixml.h"
45 #include "ogr_core.h"
46 
48 
49 /* -------------------------------------------------------------------- */
50 /* Geometry related functions (ogr_geometry.h) */
51 /* -------------------------------------------------------------------- */
52 #ifndef DEFINEH_OGRGeometryH
54 #define DEFINEH_OGRGeometryH
56 #ifdef DEBUG
57 typedef struct OGRGeometryHS *OGRGeometryH;
58 #else
60 typedef void *OGRGeometryH;
61 #endif
62 #endif /* DEFINEH_OGRGeometryH */
63 
64 #ifndef DEFINED_OGRSpatialReferenceH
66 #define DEFINED_OGRSpatialReferenceH
69 #ifndef DOXYGEN_XML
70 #ifdef DEBUG
71 typedef struct OGRSpatialReferenceHS *OGRSpatialReferenceH;
72 typedef struct OGRCoordinateTransformationHS *OGRCoordinateTransformationH;
73 #else
75 typedef void *OGRSpatialReferenceH;
78 #endif
79 #endif
80 
81 #endif /* DEFINED_OGRSpatialReferenceH */
82 
83 struct _CPLXMLNode;
84 
85 /* From base OGRGeometry class */
86 
87 OGRErr CPL_DLL OGR_G_CreateFromWkb( const void*, OGRSpatialReferenceH,
88  OGRGeometryH *, int );
90  OGRGeometryH * );
91 OGRErr CPL_DLL OGR_G_CreateFromFgf( const void*, OGRSpatialReferenceH,
92  OGRGeometryH *, int, int * );
93 void CPL_DLL OGR_G_DestroyGeometry( OGRGeometryH );
95 OGRGeometryH CPL_DLL
97  double dfCenterX, double dfCenterY, double dfZ,
98  double dfPrimaryRadius, double dfSecondaryAxis, double dfRotation,
99  double dfStartAngle, double dfEndAngle,
100  double dfMaxAngleStepSizeDegrees ) CPL_WARN_UNUSED_RESULT;
101 
108  OGRwkbGeometryType eTargetType,
109  char** papszOptions ) CPL_WARN_UNUSED_RESULT;
111 
112 int CPL_DLL OGR_G_GetDimension( OGRGeometryH );
115 void CPL_DLL OGR_G_SetCoordinateDimension( OGRGeometryH, int );
116 int CPL_DLL OGR_G_Is3D( OGRGeometryH );
117 int CPL_DLL OGR_G_IsMeasured( OGRGeometryH );
118 void CPL_DLL OGR_G_Set3D( OGRGeometryH, int );
119 void CPL_DLL OGR_G_SetMeasured( OGRGeometryH, int );
121 void CPL_DLL OGR_G_GetEnvelope( OGRGeometryH, OGREnvelope * );
123 OGRErr CPL_DLL OGR_G_ImportFromWkb( OGRGeometryH, const void*, int );
124 OGRErr CPL_DLL OGR_G_ExportToWkb( OGRGeometryH, OGRwkbByteOrder, unsigned char*);
125 OGRErr CPL_DLL OGR_G_ExportToIsoWkb( OGRGeometryH, OGRwkbByteOrder, unsigned char*);
126 int CPL_DLL OGR_G_WkbSize( OGRGeometryH hGeom );
127 OGRErr CPL_DLL OGR_G_ImportFromWkt( OGRGeometryH, char ** );
128 OGRErr CPL_DLL OGR_G_ExportToWkt( OGRGeometryH, char ** );
129 OGRErr CPL_DLL OGR_G_ExportToIsoWkt( OGRGeometryH, char ** );
131 const char CPL_DLL *OGR_G_GetGeometryName( OGRGeometryH );
132 void CPL_DLL OGR_G_DumpReadable( OGRGeometryH, FILE *, const char * );
133 void CPL_DLL OGR_G_FlattenTo2D( OGRGeometryH );
134 void CPL_DLL OGR_G_CloseRings( OGRGeometryH );
135 
138 char CPL_DLL *OGR_G_ExportToGMLEx( OGRGeometryH, char** papszOptions ) CPL_WARN_UNUSED_RESULT;
139 
143 
144 char CPL_DLL *OGR_G_ExportToKML( OGRGeometryH, const char* pszAltitudeMode ) CPL_WARN_UNUSED_RESULT;
145 
147 char CPL_DLL *OGR_G_ExportToJsonEx( OGRGeometryH, char** papszOptions ) CPL_WARN_UNUSED_RESULT;
152 
158 
160 typedef struct OGRGeomTransformer* OGRGeomTransformerH;
162  CSLConstList papszOptions ) CPL_WARN_UNUSED_RESULT;
164 void CPL_DLL OGR_GeomTransformer_Destroy(OGRGeomTransformerH hTransformer);
165 
166 OGRGeometryH CPL_DLL OGR_G_Simplify( OGRGeometryH hThis, double tolerance ) CPL_WARN_UNUSED_RESULT;
168 OGRGeometryH CPL_DLL OGR_G_DelaunayTriangulation( OGRGeometryH hThis, double dfTolerance, int bOnlyEdges ) CPL_WARN_UNUSED_RESULT;
169 
170 void CPL_DLL OGR_G_Segmentize(OGRGeometryH hGeom, double dfMaxLength );
172 int CPL_DLL OGR_G_Equals( OGRGeometryH, OGRGeometryH );
173 /*int CPL_DLL OGR_G_EqualsExact( OGRGeometryH, OGRGeometryH, double );*/
175 int CPL_DLL OGR_G_Touches( OGRGeometryH, OGRGeometryH );
176 int CPL_DLL OGR_G_Crosses( OGRGeometryH, OGRGeometryH );
177 int CPL_DLL OGR_G_Within( OGRGeometryH, OGRGeometryH );
180 
188 /*OGRGeometryH CPL_DLL OGR_G_Polygonize( OGRGeometryH *, int);*/
189 /*OGRGeometryH CPL_DLL OGR_G_Polygonizer_getCutEdges( OGRGeometryH *, int);*/
190 /*OGRGeometryH CPL_DLL OGR_G_LineMerge( OGRGeometryH );*/
191 
194 double CPL_DLL OGR_G_Distance( OGRGeometryH, OGRGeometryH );
195 double CPL_DLL OGR_G_Distance3D( OGRGeometryH, OGRGeometryH );
196 double CPL_DLL OGR_G_Length( OGRGeometryH );
197 double CPL_DLL OGR_G_Area( OGRGeometryH );
199 OGRGeometryH CPL_DLL OGR_G_Value( OGRGeometryH, double dfDistance ) CPL_WARN_UNUSED_RESULT;
200 
201 void CPL_DLL OGR_G_Empty( OGRGeometryH );
202 int CPL_DLL OGR_G_IsEmpty( OGRGeometryH );
203 int CPL_DLL OGR_G_IsValid( OGRGeometryH );
204 /*char CPL_DLL *OGR_G_IsValidReason( OGRGeometryH );*/
206 int CPL_DLL OGR_G_IsSimple( OGRGeometryH );
207 int CPL_DLL OGR_G_IsRing( OGRGeometryH );
208 
210 
212 /* backward compatibility (non-standard methods) */
213 int CPL_DLL OGR_G_Intersect( OGRGeometryH, OGRGeometryH ) CPL_WARN_DEPRECATED("Non standard method. Use OGR_G_Intersects() instead");
214 int CPL_DLL OGR_G_Equal( OGRGeometryH, OGRGeometryH ) CPL_WARN_DEPRECATED("Non standard method. Use OGR_G_Equals() instead");
215 OGRGeometryH CPL_DLL OGR_G_SymmetricDifference( OGRGeometryH, OGRGeometryH ) CPL_WARN_DEPRECATED("Non standard method. Use OGR_G_SymDifference() instead");
216 double CPL_DLL OGR_G_GetArea( OGRGeometryH ) CPL_WARN_DEPRECATED("Non standard method. Use OGR_G_Area() instead");
217 OGRGeometryH CPL_DLL OGR_G_GetBoundary( OGRGeometryH ) CPL_WARN_DEPRECATED("Non standard method. Use OGR_G_Boundary() instead");
220 /* Methods for getting/setting vertices in points, line strings and rings */
221 int CPL_DLL OGR_G_GetPointCount( OGRGeometryH );
222 int CPL_DLL OGR_G_GetPoints( OGRGeometryH hGeom,
223  void* pabyX, int nXStride,
224  void* pabyY, int nYStride,
225  void* pabyZ, int nZStride);
226 int CPL_DLL OGR_G_GetPointsZM( OGRGeometryH hGeom,
227  void* pabyX, int nXStride,
228  void* pabyY, int nYStride,
229  void* pabyZ, int nZStride,
230  void* pabyM, int nMStride);
231 double CPL_DLL OGR_G_GetX( OGRGeometryH, int );
232 double CPL_DLL OGR_G_GetY( OGRGeometryH, int );
233 double CPL_DLL OGR_G_GetZ( OGRGeometryH, int );
234 double CPL_DLL OGR_G_GetM( OGRGeometryH, int );
235 void CPL_DLL OGR_G_GetPoint( OGRGeometryH, int iPoint,
236  double *, double *, double * );
237 void CPL_DLL OGR_G_GetPointZM( OGRGeometryH, int iPoint,
238  double *, double *, double *, double * );
239 void CPL_DLL OGR_G_SetPointCount( OGRGeometryH hGeom, int nNewPointCount );
240 void CPL_DLL OGR_G_SetPoint( OGRGeometryH, int iPoint,
241  double, double, double );
242 void CPL_DLL OGR_G_SetPoint_2D( OGRGeometryH, int iPoint,
243  double, double );
244 void CPL_DLL OGR_G_SetPointM( OGRGeometryH, int iPoint,
245  double, double, double );
246 void CPL_DLL OGR_G_SetPointZM( OGRGeometryH, int iPoint,
247  double, double, double, double );
248 void CPL_DLL OGR_G_AddPoint( OGRGeometryH, double, double, double );
249 void CPL_DLL OGR_G_AddPoint_2D( OGRGeometryH, double, double );
250 void CPL_DLL OGR_G_AddPointM( OGRGeometryH, double, double, double );
251 void CPL_DLL OGR_G_AddPointZM( OGRGeometryH, double, double, double, double );
252 void CPL_DLL OGR_G_SetPoints( OGRGeometryH hGeom, int nPointsIn,
253  const void* pabyX, int nXStride,
254  const void* pabyY, int nYStride,
255  const void* pabyZ, int nZStride );
256 void CPL_DLL OGR_G_SetPointsZM( OGRGeometryH hGeom, int nPointsIn,
257  const void* pabyX, int nXStride,
258  const void* pabyY, int nYStride,
259  const void* pabyZ, int nZStride,
260  const void* pabyM, int nMStride );
261 void CPL_DLL OGR_G_SwapXY( OGRGeometryH hGeom );
262 
263 /* Methods for getting/setting rings and members collections */
264 
265 int CPL_DLL OGR_G_GetGeometryCount( OGRGeometryH );
269 OGRErr CPL_DLL OGR_G_RemoveGeometry( OGRGeometryH, int, int );
270 
271 int CPL_DLL OGR_G_HasCurveGeometry( OGRGeometryH, int bLookForNonLinear );
273  double dfMaxAngleStepSizeDegrees,
274  char** papszOptions) CPL_WARN_UNUSED_RESULT;
276  char** papszOptions ) CPL_WARN_UNUSED_RESULT;
277 
278 OGRGeometryH CPL_DLL
279 OGRBuildPolygonFromEdges( OGRGeometryH hLinesAsCollection,
280  int bBestEffort,
281  int bAutoClose,
282  double dfTolerance,
283  OGRErr * peErr ) CPL_WARN_UNUSED_RESULT;
284 
286 OGRErr CPL_DLL OGRSetGenerate_DB2_V72_BYTE_ORDER(
287  int bGenerate_DB2_V72_BYTE_ORDER );
288 
289 int CPL_DLL OGRGetGenerate_DB2_V72_BYTE_ORDER(void);
292 void CPL_DLL OGRSetNonLinearGeometriesEnabledFlag(int bFlag);
293 int CPL_DLL OGRGetNonLinearGeometriesEnabledFlag(void);
294 
295 /* -------------------------------------------------------------------- */
296 /* Feature related (ogr_feature.h) */
297 /* -------------------------------------------------------------------- */
298 
299 #ifndef DEFINE_OGRFeatureH
301 #define DEFINE_OGRFeatureH
303 #ifdef DEBUG
304 typedef struct OGRFieldDefnHS *OGRFieldDefnH;
305 typedef struct OGRFeatureDefnHS *OGRFeatureDefnH;
306 typedef struct OGRFeatureHS *OGRFeatureH;
307 typedef struct OGRStyleTableHS *OGRStyleTableH;
308 #else
310 typedef void *OGRFieldDefnH;
312 typedef void *OGRFeatureDefnH;
314 typedef void *OGRFeatureH;
316 typedef void *OGRStyleTableH;
317 #endif
319 typedef struct OGRGeomFieldDefnHS *OGRGeomFieldDefnH;
320 #endif /* DEFINE_OGRFeatureH */
321 
322 /* OGRFieldDefn */
323 
325 void CPL_DLL OGR_Fld_Destroy( OGRFieldDefnH );
326 
327 void CPL_DLL OGR_Fld_SetName( OGRFieldDefnH, const char * );
328 const char CPL_DLL *OGR_Fld_GetNameRef( OGRFieldDefnH );
335 int CPL_DLL OGR_Fld_GetWidth( OGRFieldDefnH );
336 void CPL_DLL OGR_Fld_SetWidth( OGRFieldDefnH, int );
337 int CPL_DLL OGR_Fld_GetPrecision( OGRFieldDefnH );
338 void CPL_DLL OGR_Fld_SetPrecision( OGRFieldDefnH, int );
339 void CPL_DLL OGR_Fld_Set( OGRFieldDefnH, const char *, OGRFieldType,
340  int, int, OGRJustification );
341 int CPL_DLL OGR_Fld_IsIgnored( OGRFieldDefnH hDefn );
342 void CPL_DLL OGR_Fld_SetIgnored( OGRFieldDefnH hDefn, int );
343 int CPL_DLL OGR_Fld_IsNullable( OGRFieldDefnH hDefn );
344 void CPL_DLL OGR_Fld_SetNullable( OGRFieldDefnH hDefn, int );
345 const char CPL_DLL *OGR_Fld_GetDefault( OGRFieldDefnH hDefn );
346 void CPL_DLL OGR_Fld_SetDefault( OGRFieldDefnH hDefn, const char* );
348 
349 const char CPL_DLL *OGR_GetFieldTypeName( OGRFieldType );
350 const char CPL_DLL *OGR_GetFieldSubTypeName( OGRFieldSubType );
351 int CPL_DLL OGR_AreTypeSubTypeCompatible( OGRFieldType eType,
352  OGRFieldSubType eSubType );
353 
354 /* OGRGeomFieldDefnH */
355 
357 void CPL_DLL OGR_GFld_Destroy( OGRGeomFieldDefnH );
358 
359 void CPL_DLL OGR_GFld_SetName( OGRGeomFieldDefnH, const char * );
360 const char CPL_DLL *OGR_GFld_GetNameRef( OGRGeomFieldDefnH );
361 
364 
367  OGRSpatialReferenceH hSRS );
368 
369 int CPL_DLL OGR_GFld_IsNullable( OGRGeomFieldDefnH hDefn );
370 void CPL_DLL OGR_GFld_SetNullable( OGRGeomFieldDefnH hDefn, int );
371 
372 int CPL_DLL OGR_GFld_IsIgnored( OGRGeomFieldDefnH hDefn );
373 void CPL_DLL OGR_GFld_SetIgnored( OGRGeomFieldDefnH hDefn, int );
374 
375 /* OGRFeatureDefn */
376 
378 void CPL_DLL OGR_FD_Destroy( OGRFeatureDefnH );
379 void CPL_DLL OGR_FD_Release( OGRFeatureDefnH );
380 const char CPL_DLL *OGR_FD_GetName( OGRFeatureDefnH );
383 int CPL_DLL OGR_FD_GetFieldIndex( OGRFeatureDefnH, const char * );
385 OGRErr CPL_DLL OGR_FD_DeleteFieldDefn( OGRFeatureDefnH hDefn, int iField );
386 OGRErr CPL_DLL OGR_FD_ReorderFieldDefns( OGRFeatureDefnH hDefn, int* panMap );
390 void CPL_DLL OGR_FD_SetGeometryIgnored( OGRFeatureDefnH, int );
392 void CPL_DLL OGR_FD_SetStyleIgnored( OGRFeatureDefnH, int );
393 int CPL_DLL OGR_FD_Reference( OGRFeatureDefnH );
394 int CPL_DLL OGR_FD_Dereference( OGRFeatureDefnH );
396 
397 int CPL_DLL OGR_FD_GetGeomFieldCount( OGRFeatureDefnH hFDefn );
399  int i );
400 int CPL_DLL OGR_FD_GetGeomFieldIndex( OGRFeatureDefnH hFDefn,
401  const char *pszName);
402 
403 void CPL_DLL OGR_FD_AddGeomFieldDefn( OGRFeatureDefnH hFDefn,
404  OGRGeomFieldDefnH hGFldDefn);
406  int iGeomField );
407 int CPL_DLL OGR_FD_IsSame( OGRFeatureDefnH hFDefn,
408  OGRFeatureDefnH hOtherFDefn );
409 /* OGRFeature */
410 
412 void CPL_DLL OGR_F_Destroy( OGRFeatureH );
414 
420 int CPL_DLL OGR_F_Equal( OGRFeatureH, OGRFeatureH );
421 
422 int CPL_DLL OGR_F_GetFieldCount( OGRFeatureH );
424 int CPL_DLL OGR_F_GetFieldIndex( OGRFeatureH, const char * );
425 
426 int CPL_DLL OGR_F_IsFieldSet( OGRFeatureH, int );
427 void CPL_DLL OGR_F_UnsetField( OGRFeatureH, int );
428 
429 int CPL_DLL OGR_F_IsFieldNull( OGRFeatureH, int );
430 int CPL_DLL OGR_F_IsFieldSetAndNotNull( OGRFeatureH, int );
431 void CPL_DLL OGR_F_SetFieldNull( OGRFeatureH, int );
432 
433 OGRField CPL_DLL *OGR_F_GetRawFieldRef( OGRFeatureH, int );
434 
435 int CPL_DLL OGR_RawField_IsUnset( const OGRField* );
436 int CPL_DLL OGR_RawField_IsNull( const OGRField* );
437 void CPL_DLL OGR_RawField_SetUnset( OGRField* );
438 void CPL_DLL OGR_RawField_SetNull( OGRField* );
439 
440 int CPL_DLL OGR_F_GetFieldAsInteger( OGRFeatureH, int );
442 double CPL_DLL OGR_F_GetFieldAsDouble( OGRFeatureH, int );
443 const char CPL_DLL *OGR_F_GetFieldAsString( OGRFeatureH, int );
444 const int CPL_DLL *OGR_F_GetFieldAsIntegerList( OGRFeatureH, int, int * );
445 const GIntBig CPL_DLL *OGR_F_GetFieldAsInteger64List( OGRFeatureH, int, int * );
446 const double CPL_DLL *OGR_F_GetFieldAsDoubleList( OGRFeatureH, int, int * );
447 char CPL_DLL **OGR_F_GetFieldAsStringList( OGRFeatureH, int );
448 GByte CPL_DLL *OGR_F_GetFieldAsBinary( OGRFeatureH, int, int * );
449 int CPL_DLL OGR_F_GetFieldAsDateTime( OGRFeatureH, int, int *, int *, int *,
450  int *, int *, int *, int * );
451 int CPL_DLL OGR_F_GetFieldAsDateTimeEx( OGRFeatureH hFeat, int iField,
452  int *pnYear, int *pnMonth, int *pnDay,
453  int *pnHour, int *pnMinute, float *pfSecond,
454  int *pnTZFlag );
455 
456 void CPL_DLL OGR_F_SetFieldInteger( OGRFeatureH, int, int );
457 void CPL_DLL OGR_F_SetFieldInteger64( OGRFeatureH, int, GIntBig );
458 void CPL_DLL OGR_F_SetFieldDouble( OGRFeatureH, int, double );
459 void CPL_DLL OGR_F_SetFieldString( OGRFeatureH, int, const char * );
460 void CPL_DLL OGR_F_SetFieldIntegerList( OGRFeatureH, int, int, const int * );
461 void CPL_DLL OGR_F_SetFieldInteger64List( OGRFeatureH, int, int, const GIntBig * );
462 void CPL_DLL OGR_F_SetFieldDoubleList( OGRFeatureH, int, int, const double * );
464 void CPL_DLL OGR_F_SetFieldRaw( OGRFeatureH, int, OGRField * );
465 void CPL_DLL OGR_F_SetFieldBinary( OGRFeatureH, int, int, const void * );
466 void CPL_DLL OGR_F_SetFieldDateTime( OGRFeatureH, int,
467  int, int, int, int, int, int, int );
468 void CPL_DLL OGR_F_SetFieldDateTimeEx( OGRFeatureH, int,
469  int, int, int, int, int, float, int );
470 
471 int CPL_DLL OGR_F_GetGeomFieldCount( OGRFeatureH hFeat );
473  int iField );
474 int CPL_DLL OGR_F_GetGeomFieldIndex( OGRFeatureH hFeat,
475  const char *pszName);
476 
478  int iField );
480  int iField,
481  OGRGeometryH hGeom );
482 OGRErr CPL_DLL OGR_F_SetGeomField( OGRFeatureH hFeat,
483  int iField, OGRGeometryH hGeom );
484 
485 GIntBig CPL_DLL OGR_F_GetFID( OGRFeatureH );
487 void CPL_DLL OGR_F_DumpReadable( OGRFeatureH, FILE * );
489 OGRErr CPL_DLL OGR_F_SetFromWithMap( OGRFeatureH, OGRFeatureH, int , const int * );
490 
491 const char CPL_DLL *OGR_F_GetStyleString( OGRFeatureH );
492 void CPL_DLL OGR_F_SetStyleString( OGRFeatureH, const char * );
493 void CPL_DLL OGR_F_SetStyleStringDirectly( OGRFeatureH, char * );
500 
501 const char CPL_DLL *OGR_F_GetNativeData( OGRFeatureH );
502 void CPL_DLL OGR_F_SetNativeData( OGRFeatureH, const char* );
503 const char CPL_DLL *OGR_F_GetNativeMediaType( OGRFeatureH );
504 void CPL_DLL OGR_F_SetNativeMediaType( OGRFeatureH, const char* );
505 
506 void CPL_DLL OGR_F_FillUnsetWithDefault( OGRFeatureH hFeat,
507  int bNotNullableOnly,
508  char** papszOptions );
509 int CPL_DLL OGR_F_Validate( OGRFeatureH, int nValidateFlags, int bEmitError );
510 
511 /* -------------------------------------------------------------------- */
512 /* ogrsf_frmts.h */
513 /* -------------------------------------------------------------------- */
514 
515 #ifdef DEBUG
516 typedef struct OGRLayerHS *OGRLayerH;
517 typedef struct OGRDataSourceHS *OGRDataSourceH;
518 typedef struct OGRDriverHS *OGRSFDriverH;
519 #else
521 typedef void *OGRLayerH;
523 typedef void *OGRDataSourceH;
525 typedef void *OGRSFDriverH;
526 #endif
527 
528 /* OGRLayer */
529 
530 const char CPL_DLL* OGR_L_GetName( OGRLayerH );
535  double, double, double, double );
536 void CPL_DLL OGR_L_SetSpatialFilterEx( OGRLayerH, int iGeomField,
537  OGRGeometryH hGeom );
538 void CPL_DLL OGR_L_SetSpatialFilterRectEx( OGRLayerH, int iGeomField,
539  double dfMinX, double dfMinY,
540  double dfMaxX, double dfMaxY );
541 OGRErr CPL_DLL OGR_L_SetAttributeFilter( OGRLayerH, const char * );
542 void CPL_DLL OGR_L_ResetReading( OGRLayerH );
544 
573 #define OGR_FOR_EACH_FEATURE_BEGIN(hFeat, hLayer) \
574  { \
575  OGRFeatureH hFeat = CPL_NULLPTR; \
576  OGR_L_ResetReading(hLayer); \
577  while( true) \
578  { \
579  if( hFeat ) \
580  OGR_F_Destroy(hFeat); \
581  hFeat = OGR_L_GetNextFeature(hLayer); \
582  if( !hFeat ) \
583  break;
584 
586 #define OGR_FOR_EACH_FEATURE_END(hFeat) \
587  } \
588  OGR_F_Destroy(hFeat); \
589  }
590 
598 int CPL_DLL OGR_L_FindFieldIndex( OGRLayerH, const char *, int bExactMatch );
599 GIntBig CPL_DLL OGR_L_GetFeatureCount( OGRLayerH, int );
600 OGRErr CPL_DLL OGR_L_GetExtent( OGRLayerH, OGREnvelope *, int );
601 OGRErr CPL_DLL OGR_L_GetExtentEx( OGRLayerH, int iGeomField,
602  OGREnvelope *psExtent, int bForce );
603 int CPL_DLL OGR_L_TestCapability( OGRLayerH, const char * );
605 OGRErr CPL_DLL OGR_L_CreateGeomField( OGRLayerH hLayer,
606  OGRGeomFieldDefnH hFieldDefn, int bForce );
607 OGRErr CPL_DLL OGR_L_DeleteField( OGRLayerH, int iField );
608 OGRErr CPL_DLL OGR_L_ReorderFields( OGRLayerH, int* panMap );
609 OGRErr CPL_DLL OGR_L_ReorderField( OGRLayerH, int iOldFieldPos, int iNewFieldPos );
610 OGRErr CPL_DLL OGR_L_AlterFieldDefn( OGRLayerH, int iField, OGRFieldDefnH hNewFieldDefn, int nFlags );
615 int CPL_DLL OGR_L_Reference( OGRLayerH );
616 int CPL_DLL OGR_L_Dereference( OGRLayerH );
617 int CPL_DLL OGR_L_GetRefCount( OGRLayerH );
621 GIntBig CPL_DLL OGR_L_GetFeaturesRead( OGRLayerH );
623 const char CPL_DLL *OGR_L_GetFIDColumn( OGRLayerH );
624 const char CPL_DLL *OGR_L_GetGeometryColumn( OGRLayerH );
631 OGRErr CPL_DLL OGR_L_SetIgnoredFields( OGRLayerH, const char** );
632 OGRErr CPL_DLL OGR_L_Intersection( OGRLayerH, OGRLayerH, OGRLayerH, char**, GDALProgressFunc, void * );
633 OGRErr CPL_DLL OGR_L_Union( OGRLayerH, OGRLayerH, OGRLayerH, char**, GDALProgressFunc, void * );
634 OGRErr CPL_DLL OGR_L_SymDifference( OGRLayerH, OGRLayerH, OGRLayerH, char**, GDALProgressFunc, void * );
635 OGRErr CPL_DLL OGR_L_Identity( OGRLayerH, OGRLayerH, OGRLayerH, char**, GDALProgressFunc, void * );
636 OGRErr CPL_DLL OGR_L_Update( OGRLayerH, OGRLayerH, OGRLayerH, char**, GDALProgressFunc, void * );
637 OGRErr CPL_DLL OGR_L_Clip( OGRLayerH, OGRLayerH, OGRLayerH, char**, GDALProgressFunc, void * );
638 OGRErr CPL_DLL OGR_L_Erase( OGRLayerH, OGRLayerH, OGRLayerH, char**, GDALProgressFunc, void * );
639 
640 /* OGRDataSource */
641 
642 void CPL_DLL OGR_DS_Destroy( OGRDataSourceH );
643 const char CPL_DLL *OGR_DS_GetName( OGRDataSourceH );
644 int CPL_DLL OGR_DS_GetLayerCount( OGRDataSourceH );
646 OGRLayerH CPL_DLL OGR_DS_GetLayerByName( OGRDataSourceH, const char * );
649 OGRLayerH CPL_DLL OGR_DS_CreateLayer( OGRDataSourceH, const char *,
651  char ** );
652 OGRLayerH CPL_DLL OGR_DS_CopyLayer( OGRDataSourceH, OGRLayerH, const char *,
653  char ** );
654 int CPL_DLL OGR_DS_TestCapability( OGRDataSourceH, const char * );
655 OGRLayerH CPL_DLL OGR_DS_ExecuteSQL( OGRDataSourceH, const char *,
656  OGRGeometryH, const char * );
659 int CPL_DLL OGR_DS_Reference( OGRDataSourceH );
660 int CPL_DLL OGR_DS_Dereference( OGRDataSourceH );
661 int CPL_DLL OGR_DS_GetRefCount( OGRDataSourceH );
662 int CPL_DLL OGR_DS_GetSummaryRefCount( OGRDataSourceH );
672 
673 /* OGRSFDriver */
674 
675 const char CPL_DLL *OGR_Dr_GetName( OGRSFDriverH );
677 int CPL_DLL OGR_Dr_TestCapability( OGRSFDriverH, const char * );
679  char ** ) CPL_WARN_UNUSED_RESULT;
681  const char *, char ** ) CPL_WARN_UNUSED_RESULT;
682 OGRErr CPL_DLL OGR_Dr_DeleteDataSource( OGRSFDriverH, const char * );
683 
684 /* OGRSFDriverRegistrar */
685 
690 void CPL_DLL OGRRegisterDriver( OGRSFDriverH );
691 void CPL_DLL OGRDeregisterDriver( OGRSFDriverH );
693 int CPL_DLL OGRGetDriverCount(void);
694 OGRSFDriverH CPL_DLL OGRGetDriver( int );
695 OGRSFDriverH CPL_DLL OGRGetDriverByName( const char * );
697 int CPL_DLL OGRGetOpenDSCount(void);
698 OGRDataSourceH CPL_DLL OGRGetOpenDS( int iDS );
701 void CPL_DLL OGRRegisterAll(void);
702 
705 void CPL_DLL OGRCleanupAll(void);
706 
707 /* -------------------------------------------------------------------- */
708 /* ogrsf_featurestyle.h */
709 /* -------------------------------------------------------------------- */
710 
711 #ifdef DEBUG
712 typedef struct OGRStyleMgrHS *OGRStyleMgrH;
713 typedef struct OGRStyleToolHS *OGRStyleToolH;
714 #else
716 typedef void *OGRStyleMgrH;
718 typedef void *OGRStyleToolH;
719 #endif
720 
721 /* OGRStyleMgr */
722 
724 void CPL_DLL OGR_SM_Destroy(OGRStyleMgrH hSM);
725 
726 const char CPL_DLL *OGR_SM_InitFromFeature(OGRStyleMgrH hSM,
727  OGRFeatureH hFeat);
728 int CPL_DLL OGR_SM_InitStyleString(OGRStyleMgrH hSM,
729  const char *pszStyleString);
730 int CPL_DLL OGR_SM_GetPartCount(OGRStyleMgrH hSM,
731  const char *pszStyleString);
732 OGRStyleToolH CPL_DLL OGR_SM_GetPart(OGRStyleMgrH hSM, int nPartId,
733  const char *pszStyleString);
734 int CPL_DLL OGR_SM_AddPart(OGRStyleMgrH hSM, OGRStyleToolH hST);
735 int CPL_DLL OGR_SM_AddStyle(OGRStyleMgrH hSM, const char *pszStyleName,
736  const char *pszStyleString);
737 
738 /* OGRStyleTool */
739 
741 void CPL_DLL OGR_ST_Destroy(OGRStyleToolH hST);
742 
744 
746 void CPL_DLL OGR_ST_SetUnit(OGRStyleToolH hST, OGRSTUnitId eUnit,
747  double dfGroundPaperScale);
748 
749 const char CPL_DLL *OGR_ST_GetParamStr(OGRStyleToolH hST, int eParam, int *bValueIsNull);
750 int CPL_DLL OGR_ST_GetParamNum(OGRStyleToolH hST, int eParam, int *bValueIsNull);
751 double CPL_DLL OGR_ST_GetParamDbl(OGRStyleToolH hST, int eParam, int *bValueIsNull);
752 void CPL_DLL OGR_ST_SetParamStr(OGRStyleToolH hST, int eParam, const char *pszValue);
753 void CPL_DLL OGR_ST_SetParamNum(OGRStyleToolH hST, int eParam, int nValue);
754 void CPL_DLL OGR_ST_SetParamDbl(OGRStyleToolH hST, int eParam, double dfValue);
755 const char CPL_DLL *OGR_ST_GetStyleString(OGRStyleToolH hST);
756 
757 int CPL_DLL OGR_ST_GetRGBFromString(OGRStyleToolH hST, const char *pszColor,
758  int *pnRed, int *pnGreen, int *pnBlue,
759  int *pnAlpha);
760 
761 /* OGRStyleTable */
762 
764 void CPL_DLL OGR_STBL_Destroy( OGRStyleTableH hSTBL );
765 int CPL_DLL OGR_STBL_AddStyle( OGRStyleTableH hStyleTable,
766  const char *pszName,
767  const char *pszStyleString);
768 int CPL_DLL OGR_STBL_SaveStyleTable( OGRStyleTableH hStyleTable,
769  const char *pszFilename );
770 int CPL_DLL OGR_STBL_LoadStyleTable( OGRStyleTableH hStyleTable,
771  const char *pszFilename );
772 const char CPL_DLL *OGR_STBL_Find( OGRStyleTableH hStyleTable, const char *pszName );
773 void CPL_DLL OGR_STBL_ResetStyleStringReading( OGRStyleTableH hStyleTable );
774 const char CPL_DLL *OGR_STBL_GetNextStyle( OGRStyleTableH hStyleTable);
775 const char CPL_DLL *OGR_STBL_GetLastStyleName( OGRStyleTableH hStyleTable);
776 
777 CPL_C_END
778 
779 #endif /* ndef OGR_API_H_INCLUDED */
Simple container for a bounding region in 3D.
Definition: ogr_core.h:176
Simple container for a bounding region (rectangle)
Definition: ogr_core.h:58
Definitions for CPL mini XML Parser/Serializer.
#define CPL_C_END
Macro to end a block of C symbols.
Definition: cpl_port.h:339
#define CPL_C_START
Macro to start a block of C symbols.
Definition: cpl_port.h:337
char ** CSLConstList
Type of a constant null-terminated list of nul terminated strings.
Definition: cpl_port.h:1212
#define CPL_WARN_UNUSED_RESULT
Qualifier to warn when the return value of a function is not used.
Definition: cpl_port.h:942
unsigned char GByte
Unsigned byte type.
Definition: cpl_port.h:215
long long GIntBig
Large signed integer type (generally 64-bit integer type).
Definition: cpl_port.h:248
void OGR_L_SetSpatialFilterEx(OGRLayerH, int iGeomField, OGRGeometryH hGeom)
Set a new spatial filter.
Definition: ogrlayer.cpp:1166
OGRErr OGR_F_SetGeomFieldDirectly(OGRFeatureH hFeat, int iField, OGRGeometryH hGeom)
Set feature geometry of a specified geometry field.
Definition: ogrfeature.cpp:845
OGRErr OGR_L_SymDifference(OGRLayerH, OGRLayerH, OGRLayerH, char **, GDALProgressFunc, void *)
Symmetrical difference of two layers.
Definition: ogrlayer.cpp:3098
void OGR_G_SetPointZM(OGRGeometryH, int iPoint, double, double, double, double)
Set the location of a vertex in a point or linestring geometry.
Definition: ogr_api.cpp:1003
void OGR_DS_SetStyleTable(OGRDataSourceH, OGRStyleTableH)
Set style table.
Definition: ogrdatasource.cpp:373
OGRLayerH OGR_DS_GetLayer(OGRDataSourceH, int)
Fetch a layer by index.
Definition: ogrdatasource.cpp:285
OGRGeometryH OGR_G_Simplify(OGRGeometryH hThis, double tolerance)
Compute a simplified geometry.
Definition: ogrgeometry.cpp:5463
void * OGRCoordinateTransformationH
Opaque type for a coordinate transformation object.
Definition: ogr_api.h:77
char * OGR_G_ExportToGMLEx(OGRGeometryH, char **papszOptions)
Convert a geometry into GML format.
Definition: ogr2gmlgeometry.cpp:1266
void OGR_FD_Release(OGRFeatureDefnH)
Drop a reference, and destroy if unreferenced.
Definition: ogrfeaturedefn.cpp:181
int OGR_G_Overlaps(OGRGeometryH, OGRGeometryH)
Test for overlap.
Definition: ogrgeometry.cpp:5083
GIntBig OGR_L_GetFeatureCount(OGRLayerH, int)
Fetch the feature count in this layer.
Definition: ogrlayer.cpp:194
void OGR_F_SetFieldNull(OGRFeatureH, int)
Clear a field, marking it as null.
Definition: ogrfeature.cpp:1698
OGRDataSourceH OGR_Dr_CreateDataSource(OGRSFDriverH, const char *, char **)
This function attempts to create a new data source based on the passed driver.
OGRwkbGeometryType OGR_L_GetGeomType(OGRLayerH)
Return the layer geometry type.
Definition: ogrlayer.cpp:1770
int OGR_FD_GetGeomFieldCount(OGRFeatureDefnH hFDefn)
Fetch number of geometry fields on the passed feature definition.
Definition: ogrfeaturedefn.cpp:652
int OGR_G_GetPointsZM(OGRGeometryH hGeom, void *pabyX, int nXStride, void *pabyY, int nYStride, void *pabyZ, int nZStride, void *pabyM, int nMStride)
Returns all points of line string.
Definition: ogr_api.cpp:365
OGRJustification OGR_Fld_GetJustify(OGRFieldDefnH)
Get the justification for this field.
Definition: ogrfielddefn.cpp:808
OGRFeatureH OGR_F_Create(OGRFeatureDefnH)
Feature factory.
Definition: ogrfeature.cpp:129
OGRErr OGR_G_ExportToIsoWkt(OGRGeometryH, char **)
Convert a geometry into SFSQL 1.2 / ISO SQL/MM Part 3 well known text format.
Definition: ogrgeometry.cpp:1856
GIntBig OGR_F_GetFieldAsInteger64(OGRFeatureH, int)
Fetch field value as integer 64 bit.
Definition: ogrfeature.cpp:2077
void OGR_GFld_Destroy(OGRGeomFieldDefnH)
Destroy a geometry field definition.
Definition: ogrgeomfielddefn.cpp:155
OGRErr OGR_L_Erase(OGRLayerH, OGRLayerH, OGRLayerH, char **, GDALProgressFunc, void *)
Remove areas that are covered by the method layer.
Definition: ogrlayer.cpp:4252
int OGR_FD_Dereference(OGRFeatureDefnH)
Decrements the reference count by one.
Definition: ogrfeaturedefn.cpp:1160
const char * OGR_F_GetStyleString(OGRFeatureH)
Fetch style string for this feature.
Definition: ogrfeature.cpp:6146
OGRGeomFieldDefnH OGR_F_GetGeomFieldDefnRef(OGRFeatureH hFeat, int iField)
Fetch definition for this geometry field.
Definition: ogrfeature.cpp:1294
void OGR_FD_SetGeomType(OGRFeatureDefnH, OGRwkbGeometryType)
Assign the base geometry type for the passed layer (the same as the feature definition).
Definition: ogrfeaturedefn.cpp:1087
int OGR_Fld_GetPrecision(OGRFieldDefnH)
Get the formatting precision for this field.
Definition: ogrfielddefn.cpp:944
OGRDataSourceH OGROpen(const char *, int, OGRSFDriverH *)
Open a file / data source with one of the registered drivers.
OGRFeatureDefnH OGR_F_GetDefnRef(OGRFeatureH)
Fetch feature definition.
Definition: ogrfeature.cpp:328
void OGR_Fld_SetPrecision(OGRFieldDefnH, int)
Set the formatting precision for this field in characters.
Definition: ogrfielddefn.cpp:980
OGRErr OGR_DS_SyncToDisk(OGRDataSourceH)
Flush pending changes to disk.
Definition: ogrdatasource.cpp:317
void OGR_G_Set3D(OGRGeometryH, int)
Add or remove the Z coordinate dimension.
Definition: ogrgeometry.cpp:1121
void * OGRGeometryH
Opaque type for a geometry.
Definition: ogr_api.h:60
void OGR_G_AddPointM(OGRGeometryH, double, double, double)
Add a point to a geometry (line string or point).
Definition: ogr_api.cpp:1149
void OGR_F_Destroy(OGRFeatureH)
Destroy feature.
Definition: ogrfeature.cpp:220
OGRGeometryH OGR_G_Clone(OGRGeometryH)
Make a copy of this object.
Definition: ogrgeometry.cpp:1967
const char * OGR_G_GetGeometryName(OGRGeometryH)
Fetch WKT name for geometry type.
Definition: ogrgeometry.cpp:1931
void OGR_FD_SetGeometryIgnored(OGRFeatureDefnH, int)
Set whether the geometry can be omitted when fetching features.
Definition: ogrfeaturedefn.cpp:1385
OGRGeometryH OGR_F_GetGeometryRef(OGRFeatureH)
Fetch an handle to feature geometry.
Definition: ogrfeature.cpp:628
void OGR_F_SetFieldInteger64(OGRFeatureH, int, GIntBig)
Set field to 64 bit integer value.
Definition: ogrfeature.cpp:3663
OGRGeometryH OGR_G_Buffer(OGRGeometryH, double, int)
Compute buffer of geometry.
Definition: ogrgeometry.cpp:4022
void OGR_Fld_SetWidth(OGRFieldDefnH, int)
Set the formatting width for this field in characters.
Definition: ogrfielddefn.cpp:908
double OGR_G_GetZ(OGRGeometryH, int)
Fetch the z coordinate of a point from a geometry.
Definition: ogr_api.cpp:233
int OGR_FD_GetFieldIndex(OGRFeatureDefnH, const char *)
Find field by name.
Definition: ogrfeaturedefn.cpp:1280
int OGR_G_GetGeometryCount(OGRGeometryH)
Fetch the number of elements in a geometry or number of geometries in container.
Definition: ogr_api.cpp:1243
OGRErr OGR_FD_DeleteGeomFieldDefn(OGRFeatureDefnH hFDefn, int iGeomField)
Delete an existing geometry field definition.
Definition: ogrfeaturedefn.cpp:892
const char * OGR_FD_GetName(OGRFeatureDefnH)
Get name of the OGRFeatureDefn passed as an argument.
Definition: ogrfeaturedefn.cpp:267
OGRGeometryH OGR_G_GetCurveGeometry(OGRGeometryH hGeom, char **papszOptions)
Return curve version of this geometry.
Definition: ogr_api.cpp:1758
void * OGRSpatialReferenceH
Opaque type for a spatial reference system.
Definition: ogr_api.h:75
int OGR_G_Centroid(OGRGeometryH, OGRGeometryH)
Compute the geometry centroid.
Definition: ogrgeometry.cpp:5259
char * OGR_G_ExportToKML(OGRGeometryH, const char *pszAltitudeMode)
Convert a geometry into KML format.
Definition: ogr2kmlgeometry.cpp:502
void OGR_G_AddPoint_2D(OGRGeometryH, double, double)
Add a point to a geometry (line string or point).
Definition: ogr_api.cpp:1106
int OGR_Fld_IsIgnored(OGRFieldDefnH hDefn)
Return whether this field should be omitted when fetching features.
Definition: ogrfielddefn.cpp:1073
OGRFeatureH OGR_L_GetFeature(OGRLayerH, GIntBig)
Fetch a feature by its identifier.
Definition: ogrlayer.cpp:481
void OGR_FD_AddFieldDefn(OGRFeatureDefnH, OGRFieldDefnH)
Add a new field definition to the passed feature definition.
Definition: ogrfeaturedefn.cpp:465
double OGR_G_Area(OGRGeometryH)
Compute geometry area.
Definition: ogr_api.cpp:1607
void OGR_F_SetStyleTableDirectly(OGRFeatureH, OGRStyleTableH)
Set style table and take ownership.
Definition: ogrfeature.cpp:6408
OGRGeometryH OGR_G_SymDifference(OGRGeometryH, OGRGeometryH)
Compute symmetric difference.
Definition: ogrgeometry.cpp:4587
OGRGeometryH OGR_G_UnionCascaded(OGRGeometryH)
Compute union using cascading.
Definition: ogrgeometry.cpp:4343
OGRErr OGR_L_CreateFeature(OGRLayerH, OGRFeatureH)
Create and write a new feature within a layer.
Definition: ogrlayer.cpp:647
void OGR_G_SetPoint(OGRGeometryH, int iPoint, double, double, double)
Set the location of a vertex in a point or linestring geometry.
Definition: ogr_api.cpp:817
void OGRSetNonLinearGeometriesEnabledFlag(int bFlag)
Set flag to enable/disable returning non-linear geometries in the C API.
Definition: ogr_api.cpp:1831
OGRwkbGeometryType OGR_GFld_GetType(OGRGeomFieldDefnH)
Fetch geometry type of this field.
Definition: ogrgeomfielddefn.cpp:284
void OGR_F_SetFieldBinary(OGRFeatureH, int, int, const void *)
Set field to binary data.
Definition: ogrfeature.cpp:4799
double OGR_G_GetX(OGRGeometryH, int)
Fetch the x coordinate of a point from a geometry.
Definition: ogr_api.cpp:187
int OGR_SM_AddStyle(OGRStyleMgrH hSM, const char *pszStyleName, const char *pszStyleString)
Add a style to the current style table.
Definition: ogrfeaturestyle.cpp:441
void OGR_F_SetFieldStringList(OGRFeatureH, int, CSLConstList)
Set field to list of strings value.
Definition: ogrfeature.cpp:4714
void OGR_G_GetPointZM(OGRGeometryH, int iPoint, double *, double *, double *, double *)
Fetch a point in line string or a point geometry.
Definition: ogr_api.cpp:488
OGRGeometryH OGR_L_GetSpatialFilter(OGRLayerH)
This function returns the current spatial filter for this layer.
Definition: ogrlayer.cpp:1095
const char * OGR_F_GetNativeData(OGRFeatureH)
Returns the native data for the feature.
Definition: ogrfeature.cpp:6755
OGRGeometryH OGR_F_GetGeomFieldRef(OGRFeatureH hFeat, int iField)
Fetch an handle to feature geometry.
Definition: ogrfeature.cpp:755
OGRGeometryH OGR_G_CreateGeometryFromEsriJson(const char *)
Create a OGR geometry from a ESRI JSON geometry object.
void OGR_G_DumpReadable(OGRGeometryH, FILE *, const char *)
Dump geometry in well known text format to indicated output file.
Definition: ogrgeometry.cpp:398
OGRErr OGR_G_CreateFromFgf(const void *, OGRSpatialReferenceH, OGRGeometryH *, int, int *)
Create a geometry object of the appropriate type from its FGF (FDO Geometry Format) binary representa...
Definition: ogrgeometryfactory.cpp:2600
OGRErr OGR_G_ExportToWkt(OGRGeometryH, char **)
Convert a geometry into well known text format.
Definition: ogrgeometry.cpp:1823
char * OGR_G_ExportToGML(OGRGeometryH)
Convert a geometry into GML format.
Definition: ogr2gmlgeometry.cpp:1197
int OGR_G_IsSimple(OGRGeometryH)
Returns TRUE if the geometry is simple.
Definition: ogrgeometry.cpp:2255
char ** OGR_F_GetFieldAsStringList(OGRFeatureH, int)
Fetch field value as a list of strings.
Definition: ogrfeature.cpp:2989
OGRFieldSubType OGR_Fld_GetSubType(OGRFieldDefnH)
Fetch subtype of this field.
Definition: ogrfielddefn.cpp:337
int OGR_AreTypeSubTypeCompatible(OGRFieldType eType, OGRFieldSubType eSubType)
Return if type and subtype are compatible.
Definition: ogrfielddefn.cpp:765
OGRSFDriverH OGRGetDriver(int)
Fetch the indicated driver.
OGRErr OGR_L_SetAttributeFilter(OGRLayerH, const char *)
Set a new attribute query.
Definition: ogrlayer.cpp:430
const char * OGR_ST_GetStyleString(OGRStyleToolH hST)
Get the style string for this Style Tool.
Definition: ogrfeaturestyle.cpp:2583
CPLXMLNode * OGR_G_ExportEnvelopeToGMLTree(OGRGeometryH)
Export the envelope of a geometry as a gml:Box.
Definition: ogr2gmlgeometry.cpp:452
OGRLayerH OGR_DS_CreateLayer(OGRDataSourceH, const char *, OGRSpatialReferenceH, OGRwkbGeometryType, char **)
This function attempts to create a new layer on the data source with the indicated name,...
Definition: ogrdatasource.cpp:127
OGRErr OGR_G_ImportFromWkt(OGRGeometryH, char **)
Assign geometry from well known text data.
Definition: ogrgeometry.cpp:1600
const char * OGR_F_GetFieldAsString(OGRFeatureH, int)
Fetch field value as a string.
Definition: ogrfeature.cpp:2650
OGRErr OGR_G_TransformTo(OGRGeometryH, OGRSpatialReferenceH)
Transform geometry to new spatial reference system.
Definition: ogrgeometry.cpp:684
void OGR_Fld_Destroy(OGRFieldDefnH)
Destroy a field definition.
Definition: ogrfielddefn.cpp:139
void OGR_SM_Destroy(OGRStyleMgrH hSM)
Destroy Style Manager.
Definition: ogrfeaturestyle.cpp:188
int OGR_F_GetFieldAsDateTime(OGRFeatureH, int, int *, int *, int *, int *, int *, int *, int *)
Fetch field value as date and time.
Definition: ogrfeature.cpp:3193
int OGR_L_TestCapability(OGRLayerH, const char *)
Test if this layer supported the named capability.
Definition: ogrlayer.cpp:1067
void OGR_DS_Destroy(OGRDataSourceH)
Closes opened datasource and releases allocated resources.
Definition: ogrdatasource.cpp:58
OGRFieldDefnH OGR_FD_GetFieldDefn(OGRFeatureDefnH, int)
Fetch field definition of the passed feature definition.
Definition: ogrfeaturedefn.cpp:385
void OGR_L_SetSpatialFilterRectEx(OGRLayerH, int iGeomField, double dfMinX, double dfMinY, double dfMaxX, double dfMaxY)
Set a new rectangular spatial filter.
Definition: ogrlayer.cpp:1238
OGRGeometryH OGR_G_Difference(OGRGeometryH, OGRGeometryH)
Compute difference.
Definition: ogrgeometry.cpp:4461
double OGR_G_GetM(OGRGeometryH, int)
Fetch the m coordinate of a point from a geometry.
Definition: ogr_api.cpp:256
OGRErr OGR_G_AddGeometry(OGRGeometryH, OGRGeometryH)
Add a geometry to a geometry container.
Definition: ogr_api.cpp:1374
const double * OGR_F_GetFieldAsDoubleList(OGRFeatureH, int, int *)
Fetch field value as a list of doubles.
Definition: ogrfeature.cpp:2904
int OGR_Fld_IsDefaultDriverSpecific(OGRFieldDefnH hDefn)
Returns whether the default value is driver specific.
Definition: ogrfielddefn.cpp:604
void OGR_G_SwapXY(OGRGeometryH hGeom)
Swap x and y coordinates.
Definition: ogrgeometry.cpp:5810
OGRErr OGR_L_ReorderFields(OGRLayerH, int *panMap)
Reorder all the fields of a layer.
Definition: ogrlayer.cpp:748
OGRErr OGR_Dr_DeleteDataSource(OGRSFDriverH, const char *)
Delete a datasource.
int OGR_G_IsValid(OGRGeometryH)
Test if the geometry is valid.
Definition: ogrgeometry.cpp:2183
void OGR_G_AssignSpatialReference(OGRGeometryH, OGRSpatialReferenceH)
Assign spatial reference to this object.
Definition: ogrgeometry.cpp:471
OGRGeometryH OGR_G_MakeValid(OGRGeometryH)
Attempts to make an invalid geometry valid without losing vertices.
Definition: ogrgeometry.cpp:3683
OGRGeometryH OGR_G_CreateGeometry(OGRwkbGeometryType)
Create an empty geometry of desired type.
Definition: ogrgeometryfactory.cpp:605
OGRGeometryH OGR_G_ForceTo(OGRGeometryH hGeom, OGRwkbGeometryType eTargetType, char **papszOptions)
Convert to another geometry type.
Definition: ogrgeometryfactory.cpp:4880
void OGR_G_SetPointCount(OGRGeometryH hGeom, int nNewPointCount)
Set number of points in a geometry.
Definition: ogr_api.cpp:113
void OGR_G_SetPoints(OGRGeometryH hGeom, int nPointsIn, const void *pabyX, int nXStride, const void *pabyY, int nYStride, const void *pabyZ, int nZStride)
Assign all points in a point or a line string geometry.
Definition: ogr_api.cpp:569
void * OGRStyleMgrH
Style manager opaque type.
Definition: ogr_api.h:716
OGRGeometryH OGR_G_GetLinearGeometry(OGRGeometryH hGeom, double dfMaxAngleStepSizeDegrees, char **papszOptions)
Return, possibly approximate, linear version of this geometry.
Definition: ogr_api.cpp:1718
int OGR_F_GetGeomFieldIndex(OGRFeatureH hFeat, const char *pszName)
Fetch the geometry field index given geometry field name.
Definition: ogrfeature.cpp:1344
OGRErr OGR_G_RemoveGeometry(OGRGeometryH, int, int)
Remove a geometry from an exiting geometry container.
Definition: ogr_api.cpp:1513
int OGR_Fld_IsNullable(OGRFieldDefnH hDefn)
Return whether this field can receive null values.
Definition: ogrfielddefn.cpp:1175
const char * OGR_STBL_Find(OGRStyleTableH hStyleTable, const char *pszName)
Get a style string by name.
Definition: ogrfeaturestyle.cpp:1131
int OGR_FD_GetFieldCount(OGRFeatureDefnH)
Fetch number of fields on the passed feature definition.
Definition: ogrfeaturedefn.cpp:304
void OGR_Fld_Set(OGRFieldDefnH, const char *, OGRFieldType, int, int, OGRJustification)
Set defining parameters for a field in one call.
Definition: ogrfielddefn.cpp:1036
OGRErr OGR_G_Transform(OGRGeometryH, OGRCoordinateTransformationH)
Apply arbitrary coordinate transformation to geometry.
Definition: ogrgeometry.cpp:743
void OGR_FD_Destroy(OGRFeatureDefnH)
Destroy a feature definition object and release all memory associated with it.
Definition: ogrfeaturedefn.cpp:146
OGRGeometryH OGR_G_Intersection(OGRGeometryH, OGRGeometryH)
Compute intersection.
Definition: ogrgeometry.cpp:4142
OGRGeometryH OGR_F_StealGeometry(OGRFeatureH)
Take away ownership of geometry.
Definition: ogrfeature.cpp:556
OGRFeatureDefnH OGR_FD_Create(const char *)
Create a new feature definition object to hold the field definitions.
Definition: ogrfeaturedefn.cpp:96
OGRErr OGR_L_SetFeature(OGRLayerH, OGRFeatureH)
Rewrite an existing feature.
Definition: ogrlayer.cpp:608
OGRErr OGR_L_Intersection(OGRLayerH, OGRLayerH, OGRLayerH, char **, GDALProgressFunc, void *)
Intersection of two layers.
Definition: ogrlayer.cpp:2321
void OGR_L_SetSpatialFilterRect(OGRLayerH, double, double, double, double)
Set a new rectangular spatial filter.
Definition: ogrlayer.cpp:1218
void OGR_STBL_Destroy(OGRStyleTableH hSTBL)
Destroy Style Table.
Definition: ogrfeaturestyle.cpp:826
void OGR_ST_Destroy(OGRStyleToolH hST)
Destroy Style Tool.
Definition: ogrfeaturestyle.cpp:1403
OGRSFDriverH OGR_DS_GetDriver(OGRDataSourceH)
Returns the driver that the dataset was opened with.
Definition: ogrdatasource.cpp:333
void OGR_F_SetNativeMediaType(OGRFeatureH, const char *)
Sets the native media type for the feature.
Definition: ogrfeature.cpp:6919
double OGR_G_Length(OGRGeometryH)
Compute length of a geometry.
Definition: ogr_api.cpp:1559
int OGR_G_WkbSize(OGRGeometryH hGeom)
Returns size of related binary representation.
Definition: ogrgeometry.cpp:1282
OGRErr OGR_L_CommitTransaction(OGRLayerH)
For datasources which support transactions, CommitTransaction commits a transaction.
Definition: ogrlayer.cpp:949
OGRStyleTableH OGR_DS_GetStyleTable(OGRDataSourceH)
Get style table.
Definition: ogrdatasource.cpp:346
void OGR_G_GetEnvelope(OGRGeometryH, OGREnvelope *)
Computes and returns the bounding envelope for this geometry in the passed psEnvelope structure.
Definition: ogrgeometry.cpp:1314
OGRStyleToolH OGR_SM_GetPart(OGRStyleMgrH hSM, int nPartId, const char *pszStyleString)
Fetch a part (style tool) from the current style.
Definition: ogrfeaturestyle.cpp:710
double OGR_F_GetFieldAsDouble(OGRFeatureH, int)
Fetch field value as a double.
Definition: ogrfeature.cpp:2190
OGRErr OGR_G_ExportToIsoWkb(OGRGeometryH, OGRwkbByteOrder, unsigned char *)
Convert a geometry into SFSQL 1.2 / ISO SQL/MM Part 3 well known binary format.
Definition: ogrgeometry.cpp:1546
void * OGRFieldDefnH
Opaque type for a field definition (OGRFieldDefn)
Definition: ogr_api.h:310
void OGR_F_SetFieldDateTime(OGRFeatureH, int, int, int, int, int, int, int, int)
Set field to datetime.
Definition: ogrfeature.cpp:4932
OGRErr OGR_FD_DeleteFieldDefn(OGRFeatureDefnH hDefn, int iField)
Delete an existing field definition.
Definition: ogrfeaturedefn.cpp:534
OGRLayerH OGR_DS_CopyLayer(OGRDataSourceH, OGRLayerH, const char *, char **)
Duplicate an existing layer.
Definition: ogrdatasource.cpp:157
void * OGRLayerH
Opaque type for a layer (OGRLayer)
Definition: ogr_api.h:521
OGRGeometryH OGR_GeomTransformer_Transform(OGRGeomTransformerH hTransformer, OGRGeometryH hGeom)
Transforms a geometry.
Definition: ogrgeometryfactory.cpp:4038
void OGR_Fld_SetName(OGRFieldDefnH, const char *)
Reset the name of this field.
Definition: ogrfielddefn.cpp:179
OGRErr OGR_G_CreateFromWkb(const void *, OGRSpatialReferenceH, OGRGeometryH *, int)
Create a geometry object of the appropriate type from its well known binary representation.
Definition: ogrgeometryfactory.cpp:274
OGRGeometryH OGR_G_ForceToLineString(OGRGeometryH)
Convert to line string.
Definition: ogrgeometryfactory.cpp:4488
OGRFeatureH OGR_L_GetNextFeature(OGRLayerH)
Fetch the next available feature from this layer.
Definition: ogrlayer.cpp:541
OGRGeometryH OGR_G_Polygonize(OGRGeometryH)
Polygonizes a set of sparse edges.
Definition: ogrgeometry.cpp:5775
int OGR_FD_Reference(OGRFeatureDefnH)
Increments the reference count by one.
Definition: ogrfeaturedefn.cpp:1126
void OGR_L_SetSpatialFilter(OGRLayerH, OGRGeometryH)
Set a new spatial filter.
Definition: ogrlayer.cpp:1148
OGRErr OGR_L_Identity(OGRLayerH, OGRLayerH, OGRLayerH, char **, GDALProgressFunc, void *)
Identify the features of this layer with the ones from the identity layer.
Definition: ogrlayer.cpp:3448
OGRErr OGR_L_AlterFieldDefn(OGRLayerH, int iField, OGRFieldDefnH hNewFieldDefn, int nFlags)
Alter the definition of an existing field on a layer.
Definition: ogrlayer.cpp:856
void OGR_G_GetPoint(OGRGeometryH, int iPoint, double *, double *, double *)
Fetch a point in line string or a point geometry.
Definition: ogr_api.cpp:418
int OGR_FD_GetGeomFieldIndex(OGRFeatureDefnH hFDefn, const char *pszName)
Find geometry field by name.
Definition: ogrfeaturedefn.cpp:949
void OGR_STBL_ResetStyleStringReading(OGRStyleTableH hStyleTable)
Reset the next style pointer to 0.
Definition: ogrfeaturestyle.cpp:1243
OGRGeometryH OGR_G_GetGeometryRef(OGRGeometryH, int)
Fetch geometry from a geometry container.
Definition: ogr_api.cpp:1308
void OGR_FD_SetStyleIgnored(OGRFeatureDefnH, int)
Set whether the style can be omitted when fetching features.
Definition: ogrfeaturedefn.cpp:1453
int OGR_G_GetPoints(OGRGeometryH hGeom, void *pabyX, int nXStride, void *pabyY, int nYStride, void *pabyZ, int nZStride)
Returns all points of line string.
Definition: ogr_api.cpp:297
void OGR_GFld_SetName(OGRGeomFieldDefnH, const char *)
Reset the name of this field.
Definition: ogrgeomfielddefn.cpp:202
OGRErr OGR_L_SetIgnoredFields(OGRLayerH, const char **)
Set which fields can be omitted when retrieving features from the layer.
Definition: ogrlayer.cpp:1847
int OGR_G_Touches(OGRGeometryH, OGRGeometryH)
Test for touching.
Definition: ogrgeometry.cpp:4754
OGRFieldDefnH OGR_F_GetFieldDefnRef(OGRFeatureH, int)
Fetch definition for this field.
Definition: ogrfeature.cpp:1145
void OGR_F_SetFieldDateTimeEx(OGRFeatureH, int, int, int, int, int, int, float, int)
Set field to datetime.
Definition: ogrfeature.cpp:4973
GByte * OGR_F_GetFieldAsBinary(OGRFeatureH, int, int *)
Fetch field value as binary.
Definition: ogrfeature.cpp:3062
double OGR_G_Distance3D(OGRGeometryH, OGRGeometryH)
Returns the 3D distance between two geometries.
Definition: ogrgeometry.cpp:3449
int OGR_G_IsEmpty(OGRGeometryH)
Test if the geometry is empty.
Definition: ogrgeometry.cpp:2076
int OGR_F_GetFieldAsDateTimeEx(OGRFeatureH hFeat, int iField, int *pnYear, int *pnMonth, int *pnDay, int *pnHour, int *pnMinute, float *pfSecond, int *pnTZFlag)
Fetch field value as date and time.
Definition: ogrfeature.cpp:3237
OGRLayerH OGR_DS_GetLayerByName(OGRDataSourceH, const char *)
Fetch a layer by name.
Definition: ogrdatasource.cpp:194
OGRGeometryH OGRBuildPolygonFromEdges(OGRGeometryH hLinesAsCollection, int bBestEffort, int bAutoClose, double dfTolerance, OGRErr *peErr)
Build a ring from a bunch of arcs.
Definition: ograssemblepolygon.cpp:141
void OGR_Fld_SetType(OGRFieldDefnH, OGRFieldType)
Set the type of this field.
Definition: ogrfielddefn.cpp:303
void OGR_ST_SetParamDbl(OGRStyleToolH hST, int eParam, double dfValue)
Set Style Tool parameter value from a double.
Definition: ogrfeaturestyle.cpp:2533
OGRSpatialReferenceH OGR_GFld_GetSpatialRef(OGRGeomFieldDefnH)
Fetch spatial reference system of this field.
Definition: ogrgeomfielddefn.cpp:460
int OGR_F_GetGeomFieldCount(OGRFeatureH hFeat)
Fetch number of geometry fields on this feature This will always be the same as the geometry field co...
Definition: ogrfeature.cpp:1233
int OGR_G_Disjoint(OGRGeometryH, OGRGeometryH)
Test for disjointness.
Definition: ogrgeometry.cpp:4680
OGRGeometryH OGR_G_ConvexHull(OGRGeometryH)
Compute convex hull.
Definition: ogrgeometry.cpp:3796
int OGR_G_Crosses(OGRGeometryH, OGRGeometryH)
Test for crossing.
Definition: ogrgeometry.cpp:4859
OGRFeatureDefnH OGR_L_GetLayerDefn(OGRLayerH)
Fetch the schema information for this layer.
Definition: ogrlayer.cpp:993
OGRErr OGR_F_SetGeometry(OGRFeatureH, OGRGeometryH)
Set feature geometry.
Definition: ogrfeature.cpp:472
OGRGeometryH OGR_G_ApproximateArcAngles(double dfCenterX, double dfCenterY, double dfZ, double dfPrimaryRadius, double dfSecondaryAxis, double dfRotation, double dfStartAngle, double dfEndAngle, double dfMaxAngleStepSizeDegrees)
Stroke arc to linestring.
Definition: ogrgeometryfactory.cpp:4282
int OGR_G_Within(OGRGeometryH, OGRGeometryH)
Test for containment.
Definition: ogrgeometry.cpp:4933
OGRErr OGR_L_StartTransaction(OGRLayerH)
For datasources which support transactions, StartTransaction creates a transaction.
Definition: ogrlayer.cpp:922
OGRGeomFieldDefnH OGR_FD_GetGeomFieldDefn(OGRFeatureDefnH hFDefn, int i)
Fetch geometry field definition of the passed feature definition.
Definition: ogrfeaturedefn.cpp:739
OGRErr OGR_L_RollbackTransaction(OGRLayerH)
For datasources which support transactions, RollbackTransaction will roll back a datasource to its st...
Definition: ogrlayer.cpp:976
void * OGRFeatureDefnH
Opaque type for a feature definition (OGRFeatureDefn)
Definition: ogr_api.h:312
OGRStyleTableH OGR_F_GetStyleTable(OGRFeatureH)
Return style table.
Definition: ogrfeature.cpp:6395
void OGR_F_SetFieldDoubleList(OGRFeatureH, int, int, const double *)
Set field to list of doubles value.
Definition: ogrfeature.cpp:4563
double OGR_G_GetY(OGRGeometryH, int)
Fetch the x coordinate of a point from a geometry.
Definition: ogr_api.cpp:210
int OGR_G_IsMeasured(OGRGeometryH)
See whether this geometry is measured.
Definition: ogrgeometry.cpp:993
OGRErr OGR_DS_DeleteLayer(OGRDataSourceH, int)
Delete the indicated layer from the datasource.
Definition: ogrdatasource.cpp:175
OGRErr OGR_L_Update(OGRLayerH, OGRLayerH, OGRLayerH, char **, GDALProgressFunc, void *)
Update this layer with features from the update layer.
Definition: ogrlayer.cpp:3747
OGRErr OGR_FD_ReorderFieldDefns(OGRFeatureDefnH hDefn, int *panMap)
Reorder the field definitions in the array of the feature definition.
Definition: ogrfeaturedefn.cpp:612
void OGR_G_SetMeasured(OGRGeometryH, int)
Add or remove the M coordinate dimension.
Definition: ogrgeometry.cpp:1148
void OGR_ST_SetParamStr(OGRStyleToolH hST, int eParam, const char *pszValue)
Set Style Tool parameter value from a string.
Definition: ogrfeaturestyle.cpp:2446
const char * OGR_L_GetName(OGRLayerH)
Return the layer name.
Definition: ogrlayer.cpp:1738
int OGR_G_GetCoordinateDimension(OGRGeometryH)
Get the dimension of the coordinates in this geometry.
Definition: ogrgeometry.cpp:925
OGRSpatialReferenceH OGR_L_GetSpatialRef(OGRLayerH)
Fetch the spatial reference system for this layer.
Definition: ogrlayer.cpp:1049
OGRErr OGR_L_SetNextByIndex(OGRLayerH, GIntBig)
Move read cursor to the nIndex'th feature in the current resultset.
Definition: ogrlayer.cpp:524
int OGR_F_Equal(OGRFeatureH, OGRFeatureH)
Test if two features are the same.
Definition: ogrfeature.cpp:5702
const char * OGR_Fld_GetNameRef(OGRFieldDefnH)
Fetch name of this field.
Definition: ogrfielddefn.cpp:213
OGRGeometryH OGR_G_SimplifyPreserveTopology(OGRGeometryH hThis, double tolerance)
Simplify the geometry while preserving topology.
Definition: ogrgeometry.cpp:5545
OGRwkbGeometryType OGR_G_GetGeometryType(OGRGeometryH)
Fetch geometry type.
Definition: ogrgeometry.cpp:1895
int OGR_Dr_TestCapability(OGRSFDriverH, const char *)
Test if capability is available.
int OGR_ST_GetRGBFromString(OGRStyleToolH hST, const char *pszColor, int *pnRed, int *pnGreen, int *pnBlue, int *pnAlpha)
Return the r,g,b,a components of a color encoded in #RRGGBB[AA] format.
Definition: ogrfeaturestyle.cpp:2631
OGRFeatureH OGR_F_Clone(OGRFeatureH)
Duplicate feature.
Definition: ogrfeature.cpp:980
void OGR_G_Empty(OGRGeometryH)
Clear geometry information.
Definition: ogrgeometry.cpp:2040
OGRGeometryH OGR_G_CreateFromGMLTree(const CPLXMLNode *)
Create geometry from GML.
Definition: gml2ogrgeometry.cpp:3837
void * OGRStyleToolH
Style tool opaque type.
Definition: ogr_api.h:718
int OGR_G_GetDimension(OGRGeometryH)
Get the dimension of this geometry.
Definition: ogrgeometry.cpp:855
OGRGeometryH OGR_G_Boundary(OGRGeometryH)
Compute boundary.
Definition: ogrgeometry.cpp:3896
double OGR_ST_GetParamDbl(OGRStyleToolH hST, int eParam, int *bValueIsNull)
Get Style Tool parameter value as a double.
Definition: ogrfeaturestyle.cpp:2396
const char * OGR_GetFieldSubTypeName(OGRFieldSubType)
Fetch human readable name for a field subtype.
Definition: ogrfielddefn.cpp:746
char * OGR_G_ExportToJsonEx(OGRGeometryH, char **papszOptions)
Convert a geometry into GeoJSON format.
Definition: ogrgeojsonwriter.cpp:1458
void OGR_F_SetFieldIntegerList(OGRFeatureH, int, int, const int *)
Set field to list of integers value.
Definition: ogrfeature.cpp:4284
OGRStyleTableH OGR_STBL_Create(void)
OGRStyleTable factory.
Definition: ogrfeaturestyle.cpp:785
OGRLayerH OGR_DS_ExecuteSQL(OGRDataSourceH, const char *, OGRGeometryH, const char *)
Execute an SQL statement against the data store.
Definition: ogrdatasource.cpp:214
void OGR_Fld_SetNullable(OGRFieldDefnH hDefn, int)
Set whether this field can receive null values.
Definition: ogrfielddefn.cpp:1221
int OGR_F_GetFieldIndex(OGRFeatureH, const char *)
Fetch the field index given field name.
Definition: ogrfeature.cpp:1190
void OGR_G_GetEnvelope3D(OGRGeometryH, OGREnvelope3D *)
Computes and returns the bounding envelope (3D) for this geometry in the passed psEnvelope structure.
Definition: ogrgeometry.cpp:1350
int OGR_GFld_IsNullable(OGRGeomFieldDefnH hDefn)
Return whether this geometry field can receive null values.
Definition: ogrgeomfielddefn.cpp:599
OGRErr OGR_F_SetFromWithMap(OGRFeatureH, OGRFeatureH, int, const int *)
Set one feature from another.
Definition: ogrfeature.cpp:5918
void OGR_L_SetStyleTable(OGRLayerH, OGRStyleTableH)
Set style table.
Definition: ogrlayer.cpp:1713
void OGR_F_SetFieldDouble(OGRFeatureH, int, double)
Set field to double value.
Definition: ogrfeature.cpp:3816
OGRGeomTransformerH OGR_GeomTransformer_Create(OGRCoordinateTransformationH, CSLConstList papszOptions)
Create a geometry transformer.
Definition: ogrgeometryfactory.cpp:4014
OGRErr OGR_L_SyncToDisk(OGRLayerH)
Flush pending changes to disk.
Definition: ogrlayer.cpp:1530
const GIntBig * OGR_F_GetFieldAsInteger64List(OGRFeatureH, int, int *)
Fetch field value as a list of 64 bit integers.
Definition: ogrfeature.cpp:2821
int OGR_FD_GetReferenceCount(OGRFeatureDefnH)
Fetch current reference count.
Definition: ogrfeaturedefn.cpp:1195
char * OGR_G_ExportToJson(OGRGeometryH)
Convert a geometry into GeoJSON format.
Definition: ogrgeojsonwriter.cpp:1425
void OGR_Fld_SetDefault(OGRFieldDefnH hDefn, const char *)
Set default field value.
Definition: ogrfielddefn.cpp:500
void OGR_FD_AddGeomFieldDefn(OGRFeatureDefnH hFDefn, OGRGeomFieldDefnH hGFldDefn)
Add a new field definition to the passed feature definition.
Definition: ogrfeaturedefn.cpp:818
void OGR_F_SetStyleTable(OGRFeatureH, OGRStyleTableH)
Set style table.
Definition: ogrfeature.cpp:6422
OGRDataSourceH OGR_Dr_CopyDataSource(OGRSFDriverH, OGRDataSourceH, const char *, char **)
This function creates a new datasource by copying all the layers from the source datasource.
void OGR_G_AddPoint(OGRGeometryH, double, double, double)
Add a point to a geometry (line string or point).
Definition: ogr_api.cpp:1063
int OGR_STBL_SaveStyleTable(OGRStyleTableH hStyleTable, const char *pszFilename)
Save a style table to a file.
Definition: ogrfeaturestyle.cpp:1023
int OGR_F_IsFieldNull(OGRFeatureH, int)
Test if a field is null.
Definition: ogrfeature.cpp:1552
void * OGRFeatureH
Opaque type for a feature (OGRFeature)
Definition: ogr_api.h:314
int OGR_Fld_GetWidth(OGRFieldDefnH)
Get the formatting width for this field.
Definition: ogrfielddefn.cpp:876
OGRErr OGR_L_GetExtent(OGRLayerH, OGREnvelope *, int)
Fetch the extent of this layer.
Definition: ogrlayer.cpp:303
void OGR_F_UnsetField(OGRFeatureH, int)
Clear a field, marking it as unset.
Definition: ogrfeature.cpp:1495
void OGR_GFld_SetSpatialRef(OGRGeomFieldDefnH, OGRSpatialReferenceH hSRS)
Set the spatial reference of this field.
Definition: ogrgeomfielddefn.cpp:517
int OGR_FD_IsStyleIgnored(OGRFeatureDefnH)
Determine whether the style can be omitted when fetching features.
Definition: ogrfeaturedefn.cpp:1419
int OGR_RawField_IsNull(const OGRField *)
Returns whether a raw field is null.
Definition: ogrfeature.cpp:6963
OGRErr OGR_L_CreateField(OGRLayerH, OGRFieldDefnH, int)
Create a new field on a layer.
Definition: ogrlayer.cpp:681
const char * OGR_Fld_GetDefault(OGRFieldDefnH hDefn)
Get default field value.
Definition: ogrfielddefn.cpp:538
int OGR_STBL_AddStyle(OGRStyleTableH hStyleTable, const char *pszName, const char *pszStyleString)
Add a new style in the table.
Definition: ogrfeaturestyle.cpp:920
OGRGeometryH OGR_G_Value(OGRGeometryH, double dfDistance)
Fetch point at given distance along curve.
Definition: ogr_api.cpp:1787
OGRSTClassId OGR_ST_GetType(OGRStyleToolH hST)
Determine type of Style Tool.
Definition: ogrfeaturestyle.cpp:1640
void OGR_DS_SetStyleTableDirectly(OGRDataSourceH, OGRStyleTableH)
Set style table (and take ownership)
Definition: ogrdatasource.cpp:359
double OGR_G_Distance(OGRGeometryH, OGRGeometryH)
Compute distance between two geometries.
Definition: ogrgeometry.cpp:3345
struct OGRGeomFieldDefnHS * OGRGeomFieldDefnH
Opaque type for a geometry field definition (OGRGeomFieldDefn)
Definition: ogr_api.h:319
void OGR_L_ResetReading(OGRLayerH)
Reset feature reading to start on the first feature.
Definition: ogrlayer.cpp:1473
const char * OGR_L_GetGeometryColumn(OGRLayerH)
This method returns the name of the underlying database column being used as the geometry column,...
Definition: ogrlayer.cpp:1637
int OGR_FD_IsSame(OGRFeatureDefnH hFDefn, OGRFeatureDefnH hOtherFDefn)
Test if the feature definition is identical to the other one.
Definition: ogrfeaturedefn.cpp:1542
void OGR_G_SetPoint_2D(OGRGeometryH, int iPoint, double, double)
Set the location of a vertex in a point or linestring geometry.
Definition: ogr_api.cpp:878
int OGR_GFld_IsIgnored(OGRGeomFieldDefnH hDefn)
Return whether this field should be omitted when fetching features.
Definition: ogrgeomfielddefn.cpp:380
OGRStyleMgrH OGR_SM_Create(OGRStyleTableH hStyleTable)
OGRStyleMgr factory.
Definition: ogrfeaturestyle.cpp:156
void OGR_G_SetPointM(OGRGeometryH, int iPoint, double, double, double)
Set the location of a vertex in a point or linestring geometry.
Definition: ogr_api.cpp:939
void OGR_L_SetStyleTableDirectly(OGRLayerH, OGRStyleTableH)
Set style table (and take ownership)
Definition: ogrlayer.cpp:1699
int OGR_F_Validate(OGRFeatureH, int nValidateFlags, int bEmitError)
Validate that a feature meets constraints of its schema.
Definition: ogrfeature.cpp:6683
void OGR_Fld_SetSubType(OGRFieldDefnH, OGRFieldSubType)
Set the subtype of this field.
Definition: ogrfielddefn.cpp:393
int OGR_G_IsRing(OGRGeometryH)
Test if the geometry is a ring.
Definition: ogrgeometry.cpp:2328
int OGR_G_Equals(OGRGeometryH, OGRGeometryH)
Returns TRUE if two geometries are equivalent.
Definition: ogrgeometry.cpp:1209
int OGR_F_IsFieldSet(OGRFeatureH, int)
Test if a field has ever been assigned a value or not.
Definition: ogrfeature.cpp:1417
void OGR_F_SetStyleStringDirectly(OGRFeatureH, char *)
Set feature style string.
Definition: ogrfeature.cpp:6244
OGRSpatialReferenceH OGR_G_GetSpatialReference(OGRGeometryH)
Returns spatial reference system for geometry.
Definition: ogrgeometry.cpp:2004
const char * OGR_F_GetNativeMediaType(OGRFeatureH)
Returns the native media type for the feature.
Definition: ogrfeature.cpp:6806
OGRDataSourceH OGR_Dr_Open(OGRSFDriverH, const char *, int)
Attempt to open file with this driver.
OGRGeometryH OGR_G_ForceToMultiPolygon(OGRGeometryH)
Convert to multipolygon.
Definition: ogrgeometryfactory.cpp:963
struct OGRGeomTransformer * OGRGeomTransformerH
Opaque type for a geometry transformer.
Definition: ogr_api.h:160
const char * OGR_L_GetFIDColumn(OGRLayerH)
This method returns the name of the underlying database column being used as the FID column,...
Definition: ogrlayer.cpp:1607
OGRErr OGR_G_CreateFromWkt(char **, OGRSpatialReferenceH, OGRGeometryH *)
Create a geometry object of the appropriate type from its well known text representation.
Definition: ogrgeometryfactory.cpp:497
void OGR_ST_SetParamNum(OGRStyleToolH hST, int eParam, int nValue)
Set Style Tool parameter value from an integer.
Definition: ogrfeaturestyle.cpp:2490
OGRGeometryH OGR_G_ForceToMultiLineString(OGRGeometryH)
Convert to multilinestring.
Definition: ogrgeometryfactory.cpp:1295
OGRErr OGR_L_GetExtentEx(OGRLayerH, int iGeomField, OGREnvelope *psExtent, int bForce)
Fetch the extent of this layer, on the specified geometry field.
Definition: ogrlayer.cpp:320
int OGR_G_CoordinateDimension(OGRGeometryH)
Get the dimension of the coordinates in this geometry.
Definition: ogrgeometry.cpp:951
OGRGeometryH OGR_G_ForceToPolygon(OGRGeometryH)
Convert to polygon.
Definition: ogrgeometryfactory.cpp:793
void OGR_G_DestroyGeometry(OGRGeometryH)
Destroy geometry object.
Definition: ogrgeometryfactory.cpp:648
void OGR_G_SetPointsZM(OGRGeometryH hGeom, int nPointsIn, const void *pabyX, int nXStride, const void *pabyY, int nYStride, const void *pabyZ, int nZStride, const void *pabyM, int nMStride)
Assign all points in a point or a line string geometry.
Definition: ogr_api.cpp:667
const int * OGR_F_GetFieldAsIntegerList(OGRFeatureH, int, int *)
Fetch field value as a list of integers.
Definition: ogrfeature.cpp:2735
void OGR_G_SetCoordinateDimension(OGRGeometryH, int)
Set the coordinate dimension.
Definition: ogrgeometry.cpp:1094
int OGR_DS_GetLayerCount(OGRDataSourceH)
Get the number of layers in this data source.
Definition: ogrdatasource.cpp:268
void OGR_F_FillUnsetWithDefault(OGRFeatureH hFeat, int bNotNullableOnly, char **papszOptions)
Fill unset fields with default values that might be defined.
Definition: ogrfeature.cpp:6527
OGRErr OGR_L_Union(OGRLayerH, OGRLayerH, OGRLayerH, char **, GDALProgressFunc, void *)
Union of two layers.
Definition: ogrlayer.cpp:2758
void OGR_ST_SetUnit(OGRStyleToolH hST, OGRSTUnitId eUnit, double dfGroundPaperScale)
Set Style Tool units.
Definition: ogrfeaturestyle.cpp:1704
void OGR_RawField_SetUnset(OGRField *)
Mark a raw field as unset.
Definition: ogrfeature.cpp:6987
int OGR_G_Intersects(OGRGeometryH, OGRGeometryH)
Do these features intersect?
Definition: ogrgeometry.cpp:575
void * OGRSFDriverH
Opaque type for a OGR driver (OGRSFDriver)
Definition: ogr_api.h:525
OGRGeometryH OGR_G_RemoveLowerDimensionSubGeoms(const OGRGeometryH hGeom)
Remove sub-geometries from a geometry collection that do not have the maximum topological dimensional...
Definition: ogrgeometryfactory.cpp:1400
OGRStyleTableH OGR_L_GetStyleTable(OGRLayerH)
Get style table.
Definition: ogrlayer.cpp:1686
OGRGeometryH OGR_G_DelaunayTriangulation(OGRGeometryH hThis, double dfTolerance, int bOnlyEdges)
Return a Delaunay triangulation of the vertices of the geometry.
Definition: ogrgeometry.cpp:5642
void OGR_RawField_SetNull(OGRField *)
Mark a raw field as null.
Definition: ogrfeature.cpp:7011
int OGR_F_GetFieldAsInteger(OGRFeatureH, int)
Fetch field value as integer.
Definition: ogrfeature.cpp:1956
void OGR_G_CloseRings(OGRGeometryH)
Force rings to be closed.
Definition: ogrgeometry.cpp:5120
int OGRGetDriverCount(void)
Fetch the number of registered drivers.
int OGR_DS_TestCapability(OGRDataSourceH, const char *)
Test if capability is available.
Definition: ogrdatasource.cpp:255
int OGR_FD_IsGeometryIgnored(OGRFeatureDefnH)
Determine whether the geometry can be omitted when fetching features.
Definition: ogrfeaturedefn.cpp:1337
void OGR_F_SetFieldString(OGRFeatureH, int, const char *)
Set field to string value.
Definition: ogrfeature.cpp:4131
OGRErr OGR_L_ReorderField(OGRLayerH, int iOldFieldPos, int iNewFieldPos)
Reorder an existing field on a layer.
Definition: ogrlayer.cpp:824
int OGR_SM_GetPartCount(OGRStyleMgrH hSM, const char *pszStyleString)
Get the number of parts in a style.
Definition: ogrfeaturestyle.cpp:631
OGRErr OGR_F_SetGeometryDirectly(OGRFeatureH, OGRGeometryH)
Set feature geometry.
Definition: ogrfeature.cpp:401
OGRErr OGRReleaseDataSource(OGRDataSourceH)
Drop a reference to this datasource, and if the reference count drops to zero close (destroy) the dat...
int OGR_ST_GetParamNum(OGRStyleToolH hST, int eParam, int *bValueIsNull)
Get Style Tool parameter value as an integer.
Definition: ogrfeaturestyle.cpp:2344
OGRErr OGR_G_ExportToWkb(OGRGeometryH, OGRwkbByteOrder, unsigned char *)
Convert a geometry well known binary format.
Definition: ogrgeometry.cpp:1508
OGRErr OGR_F_SetGeomField(OGRFeatureH hFeat, int iField, OGRGeometryH hGeom)
Set feature geometry of a specified geometry field.
Definition: ogrfeature.cpp:923
OGRErr OGR_F_SetFrom(OGRFeatureH, OGRFeatureH, int)
Set one feature from another.
Definition: ogrfeature.cpp:5777
int OGR_G_Contains(OGRGeometryH, OGRGeometryH)
Test for containment.
Definition: ogrgeometry.cpp:5007
OGRFieldType OGR_Fld_GetType(OGRFieldDefnH)
Fetch type of this field.
Definition: ogrfielddefn.cpp:251
const char * OGR_STBL_GetNextStyle(OGRStyleTableH hStyleTable)
Get the next style string from the table.
Definition: ogrfeaturestyle.cpp:1296
void OGR_F_SetFieldInteger(OGRFeatureH, int, int)
Set field to integer value.
Definition: ogrfeature.cpp:3506
const char * OGR_GFld_GetNameRef(OGRGeomFieldDefnH)
Fetch name of this field.
Definition: ogrgeomfielddefn.cpp:241
OGRwkbGeometryType OGR_FD_GetGeomType(OGRFeatureDefnH)
Fetch the geometry base type of the passed feature definition.
Definition: ogrfeaturedefn.cpp:1012
OGRGeomFieldDefnH OGR_GFld_Create(const char *, OGRwkbGeometryType)
Create a new field geometry definition.
Definition: ogrgeomfielddefn.cpp:109
int OGR_SM_InitStyleString(OGRStyleMgrH hSM, const char *pszStyleString)
Initialize style manager from the style string.
Definition: ogrfeaturestyle.cpp:336
void OGR_G_Segmentize(OGRGeometryH hGeom, double dfMaxLength)
Modify the geometry such it has no segment longer then the given distance.
Definition: ogrgeometry.cpp:824
void * OGRStyleTableH
Opaque type for a style table (OGRStyleTable)
Definition: ogr_api.h:316
void OGR_G_AddPointZM(OGRGeometryH, double, double, double, double)
Add a point to a geometry (line string or point).
Definition: ogr_api.cpp:1194
OGRErr OGR_F_SetFID(OGRFeatureH, GIntBig)
Set the feature identifier.
Definition: ogrfeature.cpp:5468
int OGR_F_IsFieldSetAndNotNull(OGRFeatureH, int)
Test if a field is set and not null.
Definition: ogrfeature.cpp:1615
OGRErr OGR_L_Clip(OGRLayerH, OGRLayerH, OGRLayerH, char **, GDALProgressFunc, void *)
Clip off areas that are not covered by the method layer.
Definition: ogrlayer.cpp:4006
int OGR_RawField_IsUnset(const OGRField *)
Returns whether a raw field is unset.
Definition: ogrfeature.cpp:6942
void * OGRDataSourceH
Opaque type for a OGR datasource (OGRDataSource)
Definition: ogr_api.h:523
void OGR_F_DumpReadable(OGRFeatureH, FILE *)
Dump this feature in a human readable form.
Definition: ogrfeature.cpp:5375
void OGR_Fld_SetJustify(OGRFieldDefnH, OGRJustification)
Set the justification for this field.
Definition: ogrfielddefn.cpp:844
OGRErr OGR_G_ImportFromWkb(OGRGeometryH, const void *, int)
Assign geometry from well known binary data.
Definition: ogrgeometry.cpp:1443
void OGR_GeomTransformer_Destroy(OGRGeomTransformerH hTransformer)
Destroy a geometry transformer allocated with OGR_GeomTransformer_Create()
Definition: ogrgeometryfactory.cpp:4061
OGRErr OGR_L_DeleteFeature(OGRLayerH, GIntBig)
Delete feature from layer.
Definition: ogrlayer.cpp:1556
void OGRCleanupAll(void)
Clean-up all drivers (including raster ones starting with GDAL 2.0.
OGRSFDriverH OGRGetDriverByName(const char *)
Fetch the indicated driver.
void OGRRegisterAll(void)
Register all drivers.
Definition: ogrregisterall.cpp:38
const char * OGR_DS_GetName(OGRDataSourceH)
Returns the name of the data source.
Definition: ogrdatasource.cpp:305
void OGR_F_SetNativeData(OGRFeatureH, const char *)
Sets the native data for the feature.
Definition: ogrfeature.cpp:6862
void OGR_GFld_SetNullable(OGRGeomFieldDefnH hDefn, int)
Set whether this geometry field can receive null values.
Definition: ogrgeomfielddefn.cpp:645
int OGR_G_GetPointCount(OGRGeometryH)
Fetch number of points from a geometry.
Definition: ogr_api.cpp:74
const char * OGR_ST_GetParamStr(OGRStyleToolH hST, int eParam, int *bValueIsNull)
Get Style Tool parameter value as string.
Definition: ogrfeaturestyle.cpp:2291
int OGR_STBL_LoadStyleTable(OGRStyleTableH hStyleTable, const char *pszFilename)
Load a style table from a file.
Definition: ogrfeaturestyle.cpp:1075
OGRGeometryH OGR_G_ForceToMultiPoint(OGRGeometryH)
Convert to multipoint.
Definition: ogrgeometryfactory.cpp:1055
void OGR_Fld_SetIgnored(OGRFieldDefnH hDefn, int)
Set whether this field should be omitted when fetching features.
Definition: ogrfielddefn.cpp:1105
OGRGeometryH OGR_G_CreateGeometryFromJson(const char *)
Create a OGR geometry from a GeoJSON geometry object.
OGRGeometryH OGR_G_CreateFromGML(const char *)
Create geometry from GML.
Definition: gml2ogrgeometry.cpp:3875
const char * OGR_GetFieldTypeName(OGRFieldType)
Fetch human readable name for a field type.
Definition: ogrfielddefn.cpp:683
int OGR_G_Is3D(OGRGeometryH)
See whether this geometry has Z coordinates.
Definition: ogrgeometry.cpp:972
CPLXMLNode * OGR_G_ExportToGMLTree(OGRGeometryH)
Convert a geometry into GML format.
Definition: ogr2gmlgeometry.cpp:1166
int OGR_SM_AddPart(OGRStyleMgrH hSM, OGRStyleToolH hST)
Add a part (style tool) to the current style.
Definition: ogrfeaturestyle.cpp:565
void OGR_GFld_SetIgnored(OGRGeomFieldDefnH hDefn, int)
Set whether this field should be omitted when fetching features.
Definition: ogrgeomfielddefn.cpp:418
void OGR_F_SetFieldRaw(OGRFeatureH, int, OGRField *)
Set field.
Definition: ogrfeature.cpp:5248
int OGR_G_HasCurveGeometry(OGRGeometryH, int bLookForNonLinear)
Returns if this geometry is or has curve geometry.
Definition: ogr_api.cpp:1681
OGRGeometryH OGR_G_Union(OGRGeometryH, OGRGeometryH)
Compute union.
Definition: ogrgeometry.cpp:4259
OGRErr OGR_L_CreateGeomField(OGRLayerH hLayer, OGRGeomFieldDefnH hFieldDefn, int bForce)
Create a new geometry field on a layer.
Definition: ogrlayer.cpp:892
int OGR_F_GetFieldCount(OGRFeatureH)
Fetch number of fields on this feature This will always be the same as the field count for the OGRFea...
Definition: ogrfeature.cpp:1090
OGRField * OGR_F_GetRawFieldRef(OGRFeatureH, int)
Fetch an handle to the internal field value given the index.
Definition: ogrfeature.cpp:1818
void OGR_F_SetFieldInteger64List(OGRFeatureH, int, int, const GIntBig *)
Set field to list of 64 bit integers value.
Definition: ogrfeature.cpp:4431
int OGRGetNonLinearGeometriesEnabledFlag(void)
Get flag to enable/disable returning non-linear geometries in the C API.
Definition: ogr_api.cpp:1851
const char * OGR_STBL_GetLastStyleName(OGRStyleTableH hStyleTable)
Get the style name of the last style string fetched with OGR_STBL_GetNextStyle.
Definition: ogrfeaturestyle.cpp:1334
OGRGeometryH OGR_G_PointOnSurface(OGRGeometryH)
Returns a point guaranteed to lie on the surface.
Definition: ogrgeometry.cpp:5301
OGRStyleToolH OGR_ST_Create(OGRSTClassId eClassId)
OGRStyleTool factory.
Definition: ogrfeaturestyle.cpp:1367
OGRFieldDefnH OGR_Fld_Create(const char *, OGRFieldType)
Create a new field definition.
Definition: ogrfielddefn.cpp:113
OGRSTUnitId OGR_ST_GetUnit(OGRStyleToolH hST)
Get Style Tool units.
Definition: ogrfeaturestyle.cpp:1666
void OGR_F_SetStyleString(OGRFeatureH, const char *)
Set feature style string.
Definition: ogrfeature.cpp:6198
void OGR_DS_ReleaseResultSet(OGRDataSourceH, OGRLayerH)
Release results of OGR_DS_ExecuteSQL().
Definition: ogrdatasource.cpp:238
OGRErr OGR_L_DeleteField(OGRLayerH, int iField)
Delete an existing field on a layer.
Definition: ogrlayer.cpp:716
GIntBig OGR_F_GetFID(OGRFeatureH)
Get feature identifier.
Definition: ogrfeature.cpp:5413
const char * OGR_SM_InitFromFeature(OGRStyleMgrH hSM, OGRFeatureH hFeat)
Initialize style manager from the style string of a feature.
Definition: ogrfeaturestyle.cpp:281
const char * OGR_Dr_GetName(OGRSFDriverH)
Fetch name of driver (file format).
void OGR_G_FlattenTo2D(OGRGeometryH)
Convert geometry to strictly 2D.
Definition: ogrgeometry.cpp:2819
OGRDataSourceH OGROpenShared(const char *, int, OGRSFDriverH *)
Open a file / data source with one of the registered drivers if not already opened,...
OGRErr OGR_G_AddGeometryDirectly(OGRGeometryH, OGRGeometryH)
Add a geometry directly to an existing geometry container.
Definition: ogr_api.cpp:1439
void OGR_GFld_SetType(OGRGeomFieldDefnH, OGRwkbGeometryType)
Set the geometry type of this field.
Definition: ogrgeomfielddefn.cpp:341
int OGR_L_FindFieldIndex(OGRLayerH, const char *, int bExactMatch)
Find the index of field in a layer.
Definition: ogrlayer.cpp:1011
Core portability services for cross-platform OGR code.
OGRFieldSubType
List of field subtypes.
Definition: ogr_core.h:661
OGRwkbByteOrder
Enumeration to describe byte order.
Definition: ogr_core.h:528
OGRJustification
Display justification for field values.
Definition: ogr_core.h:681
OGRFieldType
List of feature field types.
Definition: ogr_core.h:633
OGRwkbGeometryType
List of well known binary geometry types.
Definition: ogr_core.h:346
enum ogr_style_tool_class_id OGRSTClassId
OGRStyleTool derived class types (returned by GetType()).
enum ogr_style_tool_units_id OGRSTUnitId
List of units supported by OGRStyleTools.
int OGRErr
Type for a OGR error.
Definition: ogr_core.h:318
Document node structure.
Definition: cpl_minixml.h:70
OGRFeature field attribute value union.
Definition: ogr_core.h:721