ogr_api.h 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625
  1. /******************************************************************************
  2. * $Id: ogr_api.h 28900 2015-04-14 09:40:34Z 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 mines-paris dot org>
  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. #ifndef OGR_API_H_INCLUDED
  31. #define OGR_API_H_INCLUDED
  32. /**
  33. * \file ogr_api.h
  34. *
  35. * C API and defines for OGRFeature, OGRGeometry, and OGRDataSource
  36. * related classes.
  37. *
  38. * See also: ogr_geometry.h, ogr_feature.h, ogrsf_frmts.h, ogr_featurestyle.h
  39. */
  40. #include "cpl_progress.h"
  41. #include "cpl_minixml.h"
  42. #include "ogr_core.h"
  43. CPL_C_START
  44. /* -------------------------------------------------------------------- */
  45. /* Geometry related functions (ogr_geometry.h) */
  46. /* -------------------------------------------------------------------- */
  47. #ifdef DEBUG
  48. typedef struct OGRGeometryHS *OGRGeometryH;
  49. #else
  50. typedef void *OGRGeometryH;
  51. #endif
  52. #ifndef _DEFINED_OGRSpatialReferenceH
  53. #define _DEFINED_OGRSpatialReferenceH
  54. #ifdef DEBUG
  55. typedef struct OGRSpatialReferenceHS *OGRSpatialReferenceH;
  56. typedef struct OGRCoordinateTransformationHS *OGRCoordinateTransformationH;
  57. #else
  58. typedef void *OGRSpatialReferenceH;
  59. typedef void *OGRCoordinateTransformationH;
  60. #endif
  61. #endif
  62. struct _CPLXMLNode;
  63. /* From base OGRGeometry class */
  64. OGRErr CPL_DLL OGR_G_CreateFromWkb( unsigned char *, OGRSpatialReferenceH,
  65. OGRGeometryH *, int );
  66. OGRErr CPL_DLL OGR_G_CreateFromWkt( char **, OGRSpatialReferenceH,
  67. OGRGeometryH * );
  68. OGRErr CPL_DLL OGR_G_CreateFromFgf( unsigned char *, OGRSpatialReferenceH,
  69. OGRGeometryH *, int, int * );
  70. void CPL_DLL OGR_G_DestroyGeometry( OGRGeometryH );
  71. OGRGeometryH CPL_DLL OGR_G_CreateGeometry( OGRwkbGeometryType );
  72. OGRGeometryH CPL_DLL
  73. OGR_G_ApproximateArcAngles(
  74. double dfCenterX, double dfCenterY, double dfZ,
  75. double dfPrimaryRadius, double dfSecondaryAxis, double dfRotation,
  76. double dfStartAngle, double dfEndAngle,
  77. double dfMaxAngleStepSizeDegrees );
  78. OGRGeometryH CPL_DLL OGR_G_ForceToPolygon( OGRGeometryH );
  79. OGRGeometryH CPL_DLL OGR_G_ForceToLineString( OGRGeometryH );
  80. OGRGeometryH CPL_DLL OGR_G_ForceToMultiPolygon( OGRGeometryH );
  81. OGRGeometryH CPL_DLL OGR_G_ForceToMultiPoint( OGRGeometryH );
  82. OGRGeometryH CPL_DLL OGR_G_ForceToMultiLineString( OGRGeometryH );
  83. OGRGeometryH CPL_DLL OGR_G_ForceTo( OGRGeometryH hGeom,
  84. OGRwkbGeometryType eTargetType,
  85. char** papszOptions );
  86. int CPL_DLL OGR_G_GetDimension( OGRGeometryH );
  87. int CPL_DLL OGR_G_GetCoordinateDimension( OGRGeometryH );
  88. void CPL_DLL OGR_G_SetCoordinateDimension( OGRGeometryH, int );
  89. OGRGeometryH CPL_DLL OGR_G_Clone( OGRGeometryH );
  90. void CPL_DLL OGR_G_GetEnvelope( OGRGeometryH, OGREnvelope * );
  91. void CPL_DLL OGR_G_GetEnvelope3D( OGRGeometryH, OGREnvelope3D * );
  92. OGRErr CPL_DLL OGR_G_ImportFromWkb( OGRGeometryH, unsigned char *, int );
  93. OGRErr CPL_DLL OGR_G_ExportToWkb( OGRGeometryH, OGRwkbByteOrder, unsigned char*);
  94. OGRErr CPL_DLL OGR_G_ExportToIsoWkb( OGRGeometryH, OGRwkbByteOrder, unsigned char*);
  95. int CPL_DLL OGR_G_WkbSize( OGRGeometryH hGeom );
  96. OGRErr CPL_DLL OGR_G_ImportFromWkt( OGRGeometryH, char ** );
  97. OGRErr CPL_DLL OGR_G_ExportToWkt( OGRGeometryH, char ** );
  98. OGRErr CPL_DLL OGR_G_ExportToIsoWkt( OGRGeometryH, char ** );
  99. OGRwkbGeometryType CPL_DLL OGR_G_GetGeometryType( OGRGeometryH );
  100. const char CPL_DLL *OGR_G_GetGeometryName( OGRGeometryH );
  101. void CPL_DLL OGR_G_DumpReadable( OGRGeometryH, FILE *, const char * );
  102. void CPL_DLL OGR_G_FlattenTo2D( OGRGeometryH );
  103. void CPL_DLL OGR_G_CloseRings( OGRGeometryH );
  104. OGRGeometryH CPL_DLL OGR_G_CreateFromGML( const char * );
  105. char CPL_DLL *OGR_G_ExportToGML( OGRGeometryH );
  106. char CPL_DLL *OGR_G_ExportToGMLEx( OGRGeometryH, char** papszOptions );
  107. OGRGeometryH CPL_DLL OGR_G_CreateFromGMLTree( const CPLXMLNode * );
  108. CPLXMLNode CPL_DLL *OGR_G_ExportToGMLTree( OGRGeometryH );
  109. CPLXMLNode CPL_DLL *OGR_G_ExportEnvelopeToGMLTree( OGRGeometryH );
  110. char CPL_DLL *OGR_G_ExportToKML( OGRGeometryH, const char* pszAltitudeMode );
  111. char CPL_DLL *OGR_G_ExportToJson( OGRGeometryH );
  112. char CPL_DLL *OGR_G_ExportToJsonEx( OGRGeometryH, char** papszOptions );
  113. OGRGeometryH CPL_DLL OGR_G_CreateGeometryFromJson( const char* );
  114. void CPL_DLL OGR_G_AssignSpatialReference( OGRGeometryH,
  115. OGRSpatialReferenceH );
  116. OGRSpatialReferenceH CPL_DLL OGR_G_GetSpatialReference( OGRGeometryH );
  117. OGRErr CPL_DLL OGR_G_Transform( OGRGeometryH, OGRCoordinateTransformationH );
  118. OGRErr CPL_DLL OGR_G_TransformTo( OGRGeometryH, OGRSpatialReferenceH );
  119. OGRGeometryH CPL_DLL OGR_G_Simplify( OGRGeometryH hThis, double tolerance );
  120. OGRGeometryH CPL_DLL OGR_G_SimplifyPreserveTopology( OGRGeometryH hThis, double tolerance );
  121. void CPL_DLL OGR_G_Segmentize(OGRGeometryH hGeom, double dfMaxLength );
  122. int CPL_DLL OGR_G_Intersects( OGRGeometryH, OGRGeometryH );
  123. int CPL_DLL OGR_G_Equals( OGRGeometryH, OGRGeometryH );
  124. /*int CPL_DLL OGR_G_EqualsExact( OGRGeometryH, OGRGeometryH, double );*/
  125. int CPL_DLL OGR_G_Disjoint( OGRGeometryH, OGRGeometryH );
  126. int CPL_DLL OGR_G_Touches( OGRGeometryH, OGRGeometryH );
  127. int CPL_DLL OGR_G_Crosses( OGRGeometryH, OGRGeometryH );
  128. int CPL_DLL OGR_G_Within( OGRGeometryH, OGRGeometryH );
  129. int CPL_DLL OGR_G_Contains( OGRGeometryH, OGRGeometryH );
  130. int CPL_DLL OGR_G_Overlaps( OGRGeometryH, OGRGeometryH );
  131. OGRGeometryH CPL_DLL OGR_G_Boundary( OGRGeometryH );
  132. OGRGeometryH CPL_DLL OGR_G_ConvexHull( OGRGeometryH );
  133. OGRGeometryH CPL_DLL OGR_G_Buffer( OGRGeometryH, double, int );
  134. OGRGeometryH CPL_DLL OGR_G_Intersection( OGRGeometryH, OGRGeometryH );
  135. OGRGeometryH CPL_DLL OGR_G_Union( OGRGeometryH, OGRGeometryH );
  136. OGRGeometryH CPL_DLL OGR_G_UnionCascaded( OGRGeometryH );
  137. OGRGeometryH CPL_DLL OGR_G_PointOnSurface( OGRGeometryH );
  138. /*OGRGeometryH CPL_DLL OGR_G_Polygonize( OGRGeometryH *, int);*/
  139. /*OGRGeometryH CPL_DLL OGR_G_Polygonizer_getCutEdges( OGRGeometryH *, int);*/
  140. /*OGRGeometryH CPL_DLL OGR_G_LineMerge( OGRGeometryH );*/
  141. OGRGeometryH CPL_DLL OGR_G_Difference( OGRGeometryH, OGRGeometryH );
  142. OGRGeometryH CPL_DLL OGR_G_SymDifference( OGRGeometryH, OGRGeometryH );
  143. double CPL_DLL OGR_G_Distance( OGRGeometryH, OGRGeometryH );
  144. double CPL_DLL OGR_G_Length( OGRGeometryH );
  145. double CPL_DLL OGR_G_Area( OGRGeometryH );
  146. int CPL_DLL OGR_G_Centroid( OGRGeometryH, OGRGeometryH );
  147. OGRGeometryH CPL_DLL OGR_G_Value( OGRGeometryH, double dfDistance );
  148. void CPL_DLL OGR_G_Empty( OGRGeometryH );
  149. int CPL_DLL OGR_G_IsEmpty( OGRGeometryH );
  150. int CPL_DLL OGR_G_IsValid( OGRGeometryH );
  151. /*char CPL_DLL *OGR_G_IsValidReason( OGRGeometryH );*/
  152. int CPL_DLL OGR_G_IsSimple( OGRGeometryH );
  153. int CPL_DLL OGR_G_IsRing( OGRGeometryH );
  154. OGRGeometryH CPL_DLL OGR_G_Polygonize( OGRGeometryH );
  155. /* backward compatibility (non-standard methods) */
  156. int CPL_DLL OGR_G_Intersect( OGRGeometryH, OGRGeometryH ) CPL_WARN_DEPRECATED("Non standard method. Use OGR_G_Intersects() instead");
  157. int CPL_DLL OGR_G_Equal( OGRGeometryH, OGRGeometryH ) CPL_WARN_DEPRECATED("Non standard method. Use OGR_G_Equals() instead");
  158. OGRGeometryH CPL_DLL OGR_G_SymmetricDifference( OGRGeometryH, OGRGeometryH ) CPL_WARN_DEPRECATED("Non standard method. Use OGR_G_SymDifference() instead");
  159. double CPL_DLL OGR_G_GetArea( OGRGeometryH ) CPL_WARN_DEPRECATED("Non standard method. Use OGR_G_Area() instead");
  160. OGRGeometryH CPL_DLL OGR_G_GetBoundary( OGRGeometryH ) CPL_WARN_DEPRECATED("Non standard method. Use OGR_G_Boundary() instead");
  161. /* Methods for getting/setting vertices in points, line strings and rings */
  162. int CPL_DLL OGR_G_GetPointCount( OGRGeometryH );
  163. int CPL_DLL OGR_G_GetPoints( OGRGeometryH hGeom,
  164. void* pabyX, int nXStride,
  165. void* pabyY, int nYStride,
  166. void* pabyZ, int nZStride);
  167. double CPL_DLL OGR_G_GetX( OGRGeometryH, int );
  168. double CPL_DLL OGR_G_GetY( OGRGeometryH, int );
  169. double CPL_DLL OGR_G_GetZ( OGRGeometryH, int );
  170. void CPL_DLL OGR_G_GetPoint( OGRGeometryH, int iPoint,
  171. double *, double *, double * );
  172. void CPL_DLL OGR_G_SetPointCount( OGRGeometryH hGeom, int nNewPointCount );
  173. void CPL_DLL OGR_G_SetPoint( OGRGeometryH, int iPoint,
  174. double, double, double );
  175. void CPL_DLL OGR_G_SetPoint_2D( OGRGeometryH, int iPoint,
  176. double, double );
  177. void CPL_DLL OGR_G_AddPoint( OGRGeometryH, double, double, double );
  178. void CPL_DLL OGR_G_AddPoint_2D( OGRGeometryH, double, double );
  179. void CPL_DLL OGR_G_SetPoints( OGRGeometryH hGeom, int nPointsIn,
  180. void* pabyX, int nXStride,
  181. void* pabyY, int nYStride,
  182. void* pabyZ, int nZStride );
  183. /* Methods for getting/setting rings and members collections */
  184. int CPL_DLL OGR_G_GetGeometryCount( OGRGeometryH );
  185. OGRGeometryH CPL_DLL OGR_G_GetGeometryRef( OGRGeometryH, int );
  186. OGRErr CPL_DLL OGR_G_AddGeometry( OGRGeometryH, OGRGeometryH );
  187. OGRErr CPL_DLL OGR_G_AddGeometryDirectly( OGRGeometryH, OGRGeometryH );
  188. OGRErr CPL_DLL OGR_G_RemoveGeometry( OGRGeometryH, int, int );
  189. int CPL_DLL OGR_G_HasCurveGeometry( OGRGeometryH, int bLookForNonLinear );
  190. OGRGeometryH CPL_DLL OGR_G_GetLinearGeometry( OGRGeometryH hGeom,
  191. double dfMaxAngleStepSizeDegrees,
  192. char** papszOptions);
  193. OGRGeometryH CPL_DLL OGR_G_GetCurveGeometry( OGRGeometryH hGeom,
  194. char** papszOptions );
  195. OGRGeometryH CPL_DLL OGRBuildPolygonFromEdges( OGRGeometryH hLinesAsCollection,
  196. int bBestEffort,
  197. int bAutoClose,
  198. double dfTolerance,
  199. OGRErr * peErr );
  200. OGRErr CPL_DLL OGRSetGenerate_DB2_V72_BYTE_ORDER(
  201. int bGenerate_DB2_V72_BYTE_ORDER );
  202. int CPL_DLL OGRGetGenerate_DB2_V72_BYTE_ORDER(void);
  203. void CPL_DLL OGRSetNonLinearGeometriesEnabledFlag(int bFlag);
  204. int CPL_DLL OGRGetNonLinearGeometriesEnabledFlag(void);
  205. /* -------------------------------------------------------------------- */
  206. /* Feature related (ogr_feature.h) */
  207. /* -------------------------------------------------------------------- */
  208. #ifdef DEBUG
  209. typedef struct OGRFieldDefnHS *OGRFieldDefnH;
  210. typedef struct OGRFeatureDefnHS *OGRFeatureDefnH;
  211. typedef struct OGRFeatureHS *OGRFeatureH;
  212. typedef struct OGRStyleTableHS *OGRStyleTableH;
  213. #else
  214. typedef void *OGRFieldDefnH;
  215. typedef void *OGRFeatureDefnH;
  216. typedef void *OGRFeatureH;
  217. typedef void *OGRStyleTableH;
  218. #endif
  219. typedef struct OGRGeomFieldDefnHS *OGRGeomFieldDefnH;
  220. /* OGRFieldDefn */
  221. OGRFieldDefnH CPL_DLL OGR_Fld_Create( const char *, OGRFieldType ) CPL_WARN_UNUSED_RESULT;
  222. void CPL_DLL OGR_Fld_Destroy( OGRFieldDefnH );
  223. void CPL_DLL OGR_Fld_SetName( OGRFieldDefnH, const char * );
  224. const char CPL_DLL *OGR_Fld_GetNameRef( OGRFieldDefnH );
  225. OGRFieldType CPL_DLL OGR_Fld_GetType( OGRFieldDefnH );
  226. void CPL_DLL OGR_Fld_SetType( OGRFieldDefnH, OGRFieldType );
  227. OGRFieldSubType CPL_DLL OGR_Fld_GetSubType( OGRFieldDefnH );
  228. void CPL_DLL OGR_Fld_SetSubType( OGRFieldDefnH, OGRFieldSubType );
  229. OGRJustification CPL_DLL OGR_Fld_GetJustify( OGRFieldDefnH );
  230. void CPL_DLL OGR_Fld_SetJustify( OGRFieldDefnH, OGRJustification );
  231. int CPL_DLL OGR_Fld_GetWidth( OGRFieldDefnH );
  232. void CPL_DLL OGR_Fld_SetWidth( OGRFieldDefnH, int );
  233. int CPL_DLL OGR_Fld_GetPrecision( OGRFieldDefnH );
  234. void CPL_DLL OGR_Fld_SetPrecision( OGRFieldDefnH, int );
  235. void CPL_DLL OGR_Fld_Set( OGRFieldDefnH, const char *, OGRFieldType,
  236. int, int, OGRJustification );
  237. int CPL_DLL OGR_Fld_IsIgnored( OGRFieldDefnH hDefn );
  238. void CPL_DLL OGR_Fld_SetIgnored( OGRFieldDefnH hDefn, int );
  239. int CPL_DLL OGR_Fld_IsNullable( OGRFieldDefnH hDefn );
  240. void CPL_DLL OGR_Fld_SetNullable( OGRFieldDefnH hDefn, int );
  241. const char CPL_DLL *OGR_Fld_GetDefault( OGRFieldDefnH hDefn );
  242. void CPL_DLL OGR_Fld_SetDefault( OGRFieldDefnH hDefn, const char* );
  243. int CPL_DLL OGR_Fld_IsDefaultDriverSpecific( OGRFieldDefnH hDefn );
  244. const char CPL_DLL *OGR_GetFieldTypeName( OGRFieldType );
  245. const char CPL_DLL *OGR_GetFieldSubTypeName( OGRFieldSubType );
  246. int CPL_DLL OGR_AreTypeSubTypeCompatible( OGRFieldType eType,
  247. OGRFieldSubType eSubType );
  248. /* OGRGeomFieldDefnH */
  249. OGRGeomFieldDefnH CPL_DLL OGR_GFld_Create( const char *, OGRwkbGeometryType ) CPL_WARN_UNUSED_RESULT;
  250. void CPL_DLL OGR_GFld_Destroy( OGRGeomFieldDefnH );
  251. void CPL_DLL OGR_GFld_SetName( OGRGeomFieldDefnH, const char * );
  252. const char CPL_DLL *OGR_GFld_GetNameRef( OGRGeomFieldDefnH );
  253. OGRwkbGeometryType CPL_DLL OGR_GFld_GetType( OGRGeomFieldDefnH );
  254. void CPL_DLL OGR_GFld_SetType( OGRGeomFieldDefnH, OGRwkbGeometryType );
  255. OGRSpatialReferenceH CPL_DLL OGR_GFld_GetSpatialRef( OGRGeomFieldDefnH );
  256. void CPL_DLL OGR_GFld_SetSpatialRef( OGRGeomFieldDefnH,
  257. OGRSpatialReferenceH hSRS );
  258. int CPL_DLL OGR_GFld_IsNullable( OGRGeomFieldDefnH hDefn );
  259. void CPL_DLL OGR_GFld_SetNullable( OGRGeomFieldDefnH hDefn, int );
  260. int CPL_DLL OGR_GFld_IsIgnored( OGRGeomFieldDefnH hDefn );
  261. void CPL_DLL OGR_GFld_SetIgnored( OGRGeomFieldDefnH hDefn, int );
  262. /* OGRFeatureDefn */
  263. OGRFeatureDefnH CPL_DLL OGR_FD_Create( const char * ) CPL_WARN_UNUSED_RESULT;
  264. void CPL_DLL OGR_FD_Destroy( OGRFeatureDefnH );
  265. void CPL_DLL OGR_FD_Release( OGRFeatureDefnH );
  266. const char CPL_DLL *OGR_FD_GetName( OGRFeatureDefnH );
  267. int CPL_DLL OGR_FD_GetFieldCount( OGRFeatureDefnH );
  268. OGRFieldDefnH CPL_DLL OGR_FD_GetFieldDefn( OGRFeatureDefnH, int );
  269. int CPL_DLL OGR_FD_GetFieldIndex( OGRFeatureDefnH, const char * );
  270. void CPL_DLL OGR_FD_AddFieldDefn( OGRFeatureDefnH, OGRFieldDefnH );
  271. OGRErr CPL_DLL OGR_FD_DeleteFieldDefn( OGRFeatureDefnH hDefn, int iField );
  272. OGRErr CPL_DLL OGR_FD_ReorderFieldDefns( OGRFeatureDefnH hDefn, int* panMap );
  273. OGRwkbGeometryType CPL_DLL OGR_FD_GetGeomType( OGRFeatureDefnH );
  274. void CPL_DLL OGR_FD_SetGeomType( OGRFeatureDefnH, OGRwkbGeometryType );
  275. int CPL_DLL OGR_FD_IsGeometryIgnored( OGRFeatureDefnH );
  276. void CPL_DLL OGR_FD_SetGeometryIgnored( OGRFeatureDefnH, int );
  277. int CPL_DLL OGR_FD_IsStyleIgnored( OGRFeatureDefnH );
  278. void CPL_DLL OGR_FD_SetStyleIgnored( OGRFeatureDefnH, int );
  279. int CPL_DLL OGR_FD_Reference( OGRFeatureDefnH );
  280. int CPL_DLL OGR_FD_Dereference( OGRFeatureDefnH );
  281. int CPL_DLL OGR_FD_GetReferenceCount( OGRFeatureDefnH );
  282. int CPL_DLL OGR_FD_GetGeomFieldCount( OGRFeatureDefnH hFDefn );
  283. OGRGeomFieldDefnH CPL_DLL OGR_FD_GetGeomFieldDefn( OGRFeatureDefnH hFDefn,
  284. int i );
  285. int CPL_DLL OGR_FD_GetGeomFieldIndex( OGRFeatureDefnH hFDefn,
  286. const char *pszName);
  287. void CPL_DLL OGR_FD_AddGeomFieldDefn( OGRFeatureDefnH hFDefn,
  288. OGRGeomFieldDefnH hGFldDefn);
  289. OGRErr CPL_DLL OGR_FD_DeleteGeomFieldDefn( OGRFeatureDefnH hFDefn,
  290. int iGeomField );
  291. int CPL_DLL OGR_FD_IsSame( OGRFeatureDefnH hFDefn,
  292. OGRFeatureDefnH hOtherFDefn );
  293. /* OGRFeature */
  294. OGRFeatureH CPL_DLL OGR_F_Create( OGRFeatureDefnH ) CPL_WARN_UNUSED_RESULT;
  295. void CPL_DLL OGR_F_Destroy( OGRFeatureH );
  296. OGRFeatureDefnH CPL_DLL OGR_F_GetDefnRef( OGRFeatureH );
  297. OGRErr CPL_DLL OGR_F_SetGeometryDirectly( OGRFeatureH, OGRGeometryH );
  298. OGRErr CPL_DLL OGR_F_SetGeometry( OGRFeatureH, OGRGeometryH );
  299. OGRGeometryH CPL_DLL OGR_F_GetGeometryRef( OGRFeatureH );
  300. OGRGeometryH CPL_DLL OGR_F_StealGeometry( OGRFeatureH );
  301. OGRFeatureH CPL_DLL OGR_F_Clone( OGRFeatureH );
  302. int CPL_DLL OGR_F_Equal( OGRFeatureH, OGRFeatureH );
  303. int CPL_DLL OGR_F_GetFieldCount( OGRFeatureH );
  304. OGRFieldDefnH CPL_DLL OGR_F_GetFieldDefnRef( OGRFeatureH, int );
  305. int CPL_DLL OGR_F_GetFieldIndex( OGRFeatureH, const char * );
  306. int CPL_DLL OGR_F_IsFieldSet( OGRFeatureH, int );
  307. void CPL_DLL OGR_F_UnsetField( OGRFeatureH, int );
  308. OGRField CPL_DLL *OGR_F_GetRawFieldRef( OGRFeatureH, int );
  309. int CPL_DLL OGR_F_GetFieldAsInteger( OGRFeatureH, int );
  310. GIntBig CPL_DLL OGR_F_GetFieldAsInteger64( OGRFeatureH, int );
  311. double CPL_DLL OGR_F_GetFieldAsDouble( OGRFeatureH, int );
  312. const char CPL_DLL *OGR_F_GetFieldAsString( OGRFeatureH, int );
  313. const int CPL_DLL *OGR_F_GetFieldAsIntegerList( OGRFeatureH, int, int * );
  314. const GIntBig CPL_DLL *OGR_F_GetFieldAsInteger64List( OGRFeatureH, int, int * );
  315. const double CPL_DLL *OGR_F_GetFieldAsDoubleList( OGRFeatureH, int, int * );
  316. char CPL_DLL **OGR_F_GetFieldAsStringList( OGRFeatureH, int );
  317. GByte CPL_DLL *OGR_F_GetFieldAsBinary( OGRFeatureH, int, int * );
  318. int CPL_DLL OGR_F_GetFieldAsDateTime( OGRFeatureH, int, int *, int *, int *,
  319. int *, int *, int *, int * );
  320. int CPL_DLL OGR_F_GetFieldAsDateTimeEx( OGRFeatureH hFeat, int iField,
  321. int *pnYear, int *pnMonth, int *pnDay,
  322. int *pnHour, int *pnMinute, float *pfSecond,
  323. int *pnTZFlag );
  324. void CPL_DLL OGR_F_SetFieldInteger( OGRFeatureH, int, int );
  325. void CPL_DLL OGR_F_SetFieldInteger64( OGRFeatureH, int, GIntBig );
  326. void CPL_DLL OGR_F_SetFieldDouble( OGRFeatureH, int, double );
  327. void CPL_DLL OGR_F_SetFieldString( OGRFeatureH, int, const char * );
  328. void CPL_DLL OGR_F_SetFieldIntegerList( OGRFeatureH, int, int, int * );
  329. void CPL_DLL OGR_F_SetFieldInteger64List( OGRFeatureH, int, int, const GIntBig * );
  330. void CPL_DLL OGR_F_SetFieldDoubleList( OGRFeatureH, int, int, double * );
  331. void CPL_DLL OGR_F_SetFieldStringList( OGRFeatureH, int, char ** );
  332. void CPL_DLL OGR_F_SetFieldRaw( OGRFeatureH, int, OGRField * );
  333. void CPL_DLL OGR_F_SetFieldBinary( OGRFeatureH, int, int, GByte * );
  334. void CPL_DLL OGR_F_SetFieldDateTime( OGRFeatureH, int,
  335. int, int, int, int, int, int, int );
  336. void CPL_DLL OGR_F_SetFieldDateTimeEx( OGRFeatureH, int,
  337. int, int, int, int, int, float, int );
  338. int CPL_DLL OGR_F_GetGeomFieldCount( OGRFeatureH hFeat );
  339. OGRGeomFieldDefnH CPL_DLL OGR_F_GetGeomFieldDefnRef( OGRFeatureH hFeat,
  340. int iField );
  341. int CPL_DLL OGR_F_GetGeomFieldIndex( OGRFeatureH hFeat,
  342. const char *pszName);
  343. OGRGeometryH CPL_DLL OGR_F_GetGeomFieldRef( OGRFeatureH hFeat,
  344. int iField );
  345. OGRErr CPL_DLL OGR_F_SetGeomFieldDirectly( OGRFeatureH hFeat,
  346. int iField,
  347. OGRGeometryH hGeom );
  348. OGRErr CPL_DLL OGR_F_SetGeomField( OGRFeatureH hFeat,
  349. int iField, OGRGeometryH hGeom );
  350. GIntBig CPL_DLL OGR_F_GetFID( OGRFeatureH );
  351. OGRErr CPL_DLL OGR_F_SetFID( OGRFeatureH, GIntBig );
  352. void CPL_DLL OGR_F_DumpReadable( OGRFeatureH, FILE * );
  353. OGRErr CPL_DLL OGR_F_SetFrom( OGRFeatureH, OGRFeatureH, int );
  354. OGRErr CPL_DLL OGR_F_SetFromWithMap( OGRFeatureH, OGRFeatureH, int , int * );
  355. const char CPL_DLL *OGR_F_GetStyleString( OGRFeatureH );
  356. void CPL_DLL OGR_F_SetStyleString( OGRFeatureH, const char * );
  357. void CPL_DLL OGR_F_SetStyleStringDirectly( OGRFeatureH, char * );
  358. OGRStyleTableH CPL_DLL OGR_F_GetStyleTable( OGRFeatureH );
  359. void CPL_DLL OGR_F_SetStyleTableDirectly( OGRFeatureH, OGRStyleTableH );
  360. void CPL_DLL OGR_F_SetStyleTable( OGRFeatureH, OGRStyleTableH );
  361. void CPL_DLL OGR_F_FillUnsetWithDefault( OGRFeatureH hFeat,
  362. int bNotNullableOnly,
  363. char** papszOptions );
  364. int CPL_DLL OGR_F_Validate( OGRFeatureH, int nValidateFlags, int bEmitError );
  365. /* -------------------------------------------------------------------- */
  366. /* ogrsf_frmts.h */
  367. /* -------------------------------------------------------------------- */
  368. #ifdef DEBUG
  369. typedef struct OGRLayerHS *OGRLayerH;
  370. typedef struct OGRDataSourceHS *OGRDataSourceH;
  371. typedef struct OGRDriverHS *OGRSFDriverH;
  372. #else
  373. typedef void *OGRLayerH;
  374. typedef void *OGRDataSourceH;
  375. typedef void *OGRSFDriverH;
  376. #endif
  377. /* OGRLayer */
  378. const char CPL_DLL* OGR_L_GetName( OGRLayerH );
  379. OGRwkbGeometryType CPL_DLL OGR_L_GetGeomType( OGRLayerH );
  380. OGRGeometryH CPL_DLL OGR_L_GetSpatialFilter( OGRLayerH );
  381. void CPL_DLL OGR_L_SetSpatialFilter( OGRLayerH, OGRGeometryH );
  382. void CPL_DLL OGR_L_SetSpatialFilterRect( OGRLayerH,
  383. double, double, double, double );
  384. void CPL_DLL OGR_L_SetSpatialFilterEx( OGRLayerH, int iGeomField,
  385. OGRGeometryH hGeom );
  386. void CPL_DLL OGR_L_SetSpatialFilterRectEx( OGRLayerH, int iGeomField,
  387. double dfMinX, double dfMinY,
  388. double dfMaxX, double dfMaxY );
  389. OGRErr CPL_DLL OGR_L_SetAttributeFilter( OGRLayerH, const char * );
  390. void CPL_DLL OGR_L_ResetReading( OGRLayerH );
  391. OGRFeatureH CPL_DLL OGR_L_GetNextFeature( OGRLayerH );
  392. OGRErr CPL_DLL OGR_L_SetNextByIndex( OGRLayerH, GIntBig );
  393. OGRFeatureH CPL_DLL OGR_L_GetFeature( OGRLayerH, GIntBig );
  394. OGRErr CPL_DLL OGR_L_SetFeature( OGRLayerH, OGRFeatureH );
  395. OGRErr CPL_DLL OGR_L_CreateFeature( OGRLayerH, OGRFeatureH );
  396. OGRErr CPL_DLL OGR_L_DeleteFeature( OGRLayerH, GIntBig );
  397. OGRFeatureDefnH CPL_DLL OGR_L_GetLayerDefn( OGRLayerH );
  398. OGRSpatialReferenceH CPL_DLL OGR_L_GetSpatialRef( OGRLayerH );
  399. int CPL_DLL OGR_L_FindFieldIndex( OGRLayerH, const char *, int bExactMatch );
  400. GIntBig CPL_DLL OGR_L_GetFeatureCount( OGRLayerH, int );
  401. OGRErr CPL_DLL OGR_L_GetExtent( OGRLayerH, OGREnvelope *, int );
  402. OGRErr CPL_DLL OGR_L_GetExtentEx( OGRLayerH, int iGeomField,
  403. OGREnvelope *psExtent, int bForce );
  404. int CPL_DLL OGR_L_TestCapability( OGRLayerH, const char * );
  405. OGRErr CPL_DLL OGR_L_CreateField( OGRLayerH, OGRFieldDefnH, int );
  406. OGRErr CPL_DLL OGR_L_CreateGeomField( OGRLayerH hLayer,
  407. OGRGeomFieldDefnH hFieldDefn, int bForce );
  408. OGRErr CPL_DLL OGR_L_DeleteField( OGRLayerH, int iField );
  409. OGRErr CPL_DLL OGR_L_ReorderFields( OGRLayerH, int* panMap );
  410. OGRErr CPL_DLL OGR_L_ReorderField( OGRLayerH, int iOldFieldPos, int iNewFieldPos );
  411. OGRErr CPL_DLL OGR_L_AlterFieldDefn( OGRLayerH, int iField, OGRFieldDefnH hNewFieldDefn, int nFlags );
  412. OGRErr CPL_DLL OGR_L_StartTransaction( OGRLayerH );
  413. OGRErr CPL_DLL OGR_L_CommitTransaction( OGRLayerH );
  414. OGRErr CPL_DLL OGR_L_RollbackTransaction( OGRLayerH );
  415. int CPL_DLL OGR_L_Reference( OGRLayerH );
  416. int CPL_DLL OGR_L_Dereference( OGRLayerH );
  417. int CPL_DLL OGR_L_GetRefCount( OGRLayerH );
  418. OGRErr CPL_DLL OGR_L_SyncToDisk( OGRLayerH );
  419. GIntBig CPL_DLL OGR_L_GetFeaturesRead( OGRLayerH );
  420. const char CPL_DLL *OGR_L_GetFIDColumn( OGRLayerH );
  421. const char CPL_DLL *OGR_L_GetGeometryColumn( OGRLayerH );
  422. OGRStyleTableH CPL_DLL OGR_L_GetStyleTable( OGRLayerH );
  423. void CPL_DLL OGR_L_SetStyleTableDirectly( OGRLayerH, OGRStyleTableH );
  424. void CPL_DLL OGR_L_SetStyleTable( OGRLayerH, OGRStyleTableH );
  425. OGRErr CPL_DLL OGR_L_SetIgnoredFields( OGRLayerH, const char** );
  426. OGRErr CPL_DLL OGR_L_Intersection( OGRLayerH, OGRLayerH, OGRLayerH, char**, GDALProgressFunc, void * );
  427. OGRErr CPL_DLL OGR_L_Union( OGRLayerH, OGRLayerH, OGRLayerH, char**, GDALProgressFunc, void * );
  428. OGRErr CPL_DLL OGR_L_SymDifference( OGRLayerH, OGRLayerH, OGRLayerH, char**, GDALProgressFunc, void * );
  429. OGRErr CPL_DLL OGR_L_Identity( OGRLayerH, OGRLayerH, OGRLayerH, char**, GDALProgressFunc, void * );
  430. OGRErr CPL_DLL OGR_L_Update( OGRLayerH, OGRLayerH, OGRLayerH, char**, GDALProgressFunc, void * );
  431. OGRErr CPL_DLL OGR_L_Clip( OGRLayerH, OGRLayerH, OGRLayerH, char**, GDALProgressFunc, void * );
  432. OGRErr CPL_DLL OGR_L_Erase( OGRLayerH, OGRLayerH, OGRLayerH, char**, GDALProgressFunc, void * );
  433. /* OGRDataSource */
  434. void CPL_DLL OGR_DS_Destroy( OGRDataSourceH );
  435. const char CPL_DLL *OGR_DS_GetName( OGRDataSourceH );
  436. int CPL_DLL OGR_DS_GetLayerCount( OGRDataSourceH );
  437. OGRLayerH CPL_DLL OGR_DS_GetLayer( OGRDataSourceH, int );
  438. OGRLayerH CPL_DLL OGR_DS_GetLayerByName( OGRDataSourceH, const char * );
  439. OGRErr CPL_DLL OGR_DS_DeleteLayer( OGRDataSourceH, int );
  440. OGRSFDriverH CPL_DLL OGR_DS_GetDriver( OGRDataSourceH );
  441. OGRLayerH CPL_DLL OGR_DS_CreateLayer( OGRDataSourceH, const char *,
  442. OGRSpatialReferenceH, OGRwkbGeometryType,
  443. char ** );
  444. OGRLayerH CPL_DLL OGR_DS_CopyLayer( OGRDataSourceH, OGRLayerH, const char *,
  445. char ** );
  446. int CPL_DLL OGR_DS_TestCapability( OGRDataSourceH, const char * );
  447. OGRLayerH CPL_DLL OGR_DS_ExecuteSQL( OGRDataSourceH, const char *,
  448. OGRGeometryH, const char * );
  449. void CPL_DLL OGR_DS_ReleaseResultSet( OGRDataSourceH, OGRLayerH );
  450. int CPL_DLL OGR_DS_Reference( OGRDataSourceH );
  451. int CPL_DLL OGR_DS_Dereference( OGRDataSourceH );
  452. int CPL_DLL OGR_DS_GetRefCount( OGRDataSourceH );
  453. int CPL_DLL OGR_DS_GetSummaryRefCount( OGRDataSourceH );
  454. OGRErr CPL_DLL OGR_DS_SyncToDisk( OGRDataSourceH );
  455. OGRStyleTableH CPL_DLL OGR_DS_GetStyleTable( OGRDataSourceH );
  456. void CPL_DLL OGR_DS_SetStyleTableDirectly( OGRDataSourceH, OGRStyleTableH );
  457. void CPL_DLL OGR_DS_SetStyleTable( OGRDataSourceH, OGRStyleTableH );
  458. /* OGRSFDriver */
  459. const char CPL_DLL *OGR_Dr_GetName( OGRSFDriverH );
  460. OGRDataSourceH CPL_DLL OGR_Dr_Open( OGRSFDriverH, const char *, int ) CPL_WARN_UNUSED_RESULT;
  461. int CPL_DLL OGR_Dr_TestCapability( OGRSFDriverH, const char * );
  462. OGRDataSourceH CPL_DLL OGR_Dr_CreateDataSource( OGRSFDriverH, const char *,
  463. char ** ) CPL_WARN_UNUSED_RESULT;
  464. OGRDataSourceH CPL_DLL OGR_Dr_CopyDataSource( OGRSFDriverH, OGRDataSourceH,
  465. const char *, char ** ) CPL_WARN_UNUSED_RESULT;
  466. OGRErr CPL_DLL OGR_Dr_DeleteDataSource( OGRSFDriverH, const char * );
  467. /* OGRSFDriverRegistrar */
  468. OGRDataSourceH CPL_DLL OGROpen( const char *, int, OGRSFDriverH * ) CPL_WARN_UNUSED_RESULT;
  469. OGRDataSourceH CPL_DLL OGROpenShared( const char *, int, OGRSFDriverH * ) CPL_WARN_UNUSED_RESULT;
  470. OGRErr CPL_DLL OGRReleaseDataSource( OGRDataSourceH );
  471. void CPL_DLL OGRRegisterDriver( OGRSFDriverH );
  472. void CPL_DLL OGRDeregisterDriver( OGRSFDriverH );
  473. int CPL_DLL OGRGetDriverCount(void);
  474. OGRSFDriverH CPL_DLL OGRGetDriver( int );
  475. OGRSFDriverH CPL_DLL OGRGetDriverByName( const char * );
  476. int CPL_DLL OGRGetOpenDSCount(void);
  477. OGRDataSourceH CPL_DLL OGRGetOpenDS( int iDS );
  478. /* note: this is also declared in ogrsf_frmts.h */
  479. void CPL_DLL OGRRegisterAll(void);
  480. void CPL_DLL OGRCleanupAll(void);
  481. /* -------------------------------------------------------------------- */
  482. /* ogrsf_featurestyle.h */
  483. /* -------------------------------------------------------------------- */
  484. #ifdef DEBUG
  485. typedef struct OGRStyleMgrHS *OGRStyleMgrH;
  486. typedef struct OGRStyleToolHS *OGRStyleToolH;
  487. #else
  488. typedef void *OGRStyleMgrH;
  489. typedef void *OGRStyleToolH;
  490. #endif
  491. /* OGRStyleMgr */
  492. OGRStyleMgrH CPL_DLL OGR_SM_Create(OGRStyleTableH hStyleTable) CPL_WARN_UNUSED_RESULT;
  493. void CPL_DLL OGR_SM_Destroy(OGRStyleMgrH hSM);
  494. const char CPL_DLL *OGR_SM_InitFromFeature(OGRStyleMgrH hSM,
  495. OGRFeatureH hFeat);
  496. int CPL_DLL OGR_SM_InitStyleString(OGRStyleMgrH hSM,
  497. const char *pszStyleString);
  498. int CPL_DLL OGR_SM_GetPartCount(OGRStyleMgrH hSM,
  499. const char *pszStyleString);
  500. OGRStyleToolH CPL_DLL OGR_SM_GetPart(OGRStyleMgrH hSM, int nPartId,
  501. const char *pszStyleString);
  502. int CPL_DLL OGR_SM_AddPart(OGRStyleMgrH hSM, OGRStyleToolH hST);
  503. int CPL_DLL OGR_SM_AddStyle(OGRStyleMgrH hSM, const char *pszStyleName,
  504. const char *pszStyleString);
  505. /* OGRStyleTool */
  506. OGRStyleToolH CPL_DLL OGR_ST_Create(OGRSTClassId eClassId) CPL_WARN_UNUSED_RESULT;
  507. void CPL_DLL OGR_ST_Destroy(OGRStyleToolH hST);
  508. OGRSTClassId CPL_DLL OGR_ST_GetType(OGRStyleToolH hST);
  509. OGRSTUnitId CPL_DLL OGR_ST_GetUnit(OGRStyleToolH hST);
  510. void CPL_DLL OGR_ST_SetUnit(OGRStyleToolH hST, OGRSTUnitId eUnit,
  511. double dfGroundPaperScale);
  512. const char CPL_DLL *OGR_ST_GetParamStr(OGRStyleToolH hST, int eParam, int *bValueIsNull);
  513. int CPL_DLL OGR_ST_GetParamNum(OGRStyleToolH hST, int eParam, int *bValueIsNull);
  514. double CPL_DLL OGR_ST_GetParamDbl(OGRStyleToolH hST, int eParam, int *bValueIsNull);
  515. void CPL_DLL OGR_ST_SetParamStr(OGRStyleToolH hST, int eParam, const char *pszValue);
  516. void CPL_DLL OGR_ST_SetParamNum(OGRStyleToolH hST, int eParam, int nValue);
  517. void CPL_DLL OGR_ST_SetParamDbl(OGRStyleToolH hST, int eParam, double dfValue);
  518. const char CPL_DLL *OGR_ST_GetStyleString(OGRStyleToolH hST);
  519. int CPL_DLL OGR_ST_GetRGBFromString(OGRStyleToolH hST, const char *pszColor,
  520. int *pnRed, int *pnGreen, int *pnBlue,
  521. int *pnAlpha);
  522. /* OGRStyleTable */
  523. OGRStyleTableH CPL_DLL OGR_STBL_Create( void ) CPL_WARN_UNUSED_RESULT;
  524. void CPL_DLL OGR_STBL_Destroy( OGRStyleTableH hSTBL );
  525. int CPL_DLL OGR_STBL_AddStyle( OGRStyleTableH hStyleTable,
  526. const char *pszName,
  527. const char *pszStyleString);
  528. int CPL_DLL OGR_STBL_SaveStyleTable( OGRStyleTableH hStyleTable,
  529. const char *pszFilename );
  530. int CPL_DLL OGR_STBL_LoadStyleTable( OGRStyleTableH hStyleTable,
  531. const char *pszFilename );
  532. const char CPL_DLL *OGR_STBL_Find( OGRStyleTableH hStyleTable, const char *pszName );
  533. void CPL_DLL OGR_STBL_ResetStyleStringReading( OGRStyleTableH hStyleTable );
  534. const char CPL_DLL *OGR_STBL_GetNextStyle( OGRStyleTableH hStyleTable);
  535. const char CPL_DLL *OGR_STBL_GetLastStyleName( OGRStyleTableH hStyleTable);
  536. CPL_C_END
  537. #endif /* ndef OGR_API_H_INCLUDED */