Main Page | Class Hierarchy | Class List | Directories | File List | Class Members | File Members | Related Pages

ogr_api.h

Go to the documentation of this file.
00001 /******************************************************************************
00002  * $Id: ogr_api.h 10646 2007-01-18 02:38:10Z warmerdam $
00003  *
00004  * Project:  OpenGIS Simple Features Reference Implementation
00005  * Purpose:  C API for OGR Geometry, Feature, Layers, DataSource and drivers.
00006  * Author:   Frank Warmerdam, warmerdam@pobox.com
00007  *
00008  ******************************************************************************
00009  * Copyright (c) 2002, Frank Warmerdam
00010  *
00011  * Permission is hereby granted, free of charge, to any person obtaining a
00012  * copy of this software and associated documentation files (the "Software"),
00013  * to deal in the Software without restriction, including without limitation
00014  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
00015  * and/or sell copies of the Software, and to permit persons to whom the
00016  * Software is furnished to do so, subject to the following conditions:
00017  *
00018  * The above copyright notice and this permission notice shall be included
00019  * in all copies or substantial portions of the Software.
00020  *
00021  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
00022  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00023  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
00024  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
00025  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
00026  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
00027  * DEALINGS IN THE SOFTWARE.
00028  ****************************************************************************/
00029 
00030 #ifndef _OGR_API_H_INCLUDED
00031 #define _OGR_API_H_INCLUDED
00032 
00042 #include "ogr_core.h"
00043 
00044 CPL_C_START
00045 
00046 /* -------------------------------------------------------------------- */
00047 /*      Geometry related functions (ogr_geometry.h)                     */
00048 /* -------------------------------------------------------------------- */
00049 typedef void *OGRGeometryH;
00050 
00051 #ifndef _DEFINED_OGRSpatialReferenceH
00052 #define _DEFINED_OGRSpatialReferenceH
00053 
00054 typedef void *OGRSpatialReferenceH;                               
00055 typedef void *OGRCoordinateTransformationH;
00056 
00057 #endif
00058 
00059 struct _CPLXMLNode;
00060 
00061 /* From base OGRGeometry class */
00062 
00063 OGRErr CPL_DLL OGR_G_CreateFromWkb( unsigned char *, OGRSpatialReferenceH, 
00064                                     OGRGeometryH *, int );
00065 OGRErr CPL_DLL OGR_G_CreateFromWkt( char **, OGRSpatialReferenceH, 
00066                                     OGRGeometryH * );
00067 void   CPL_DLL OGR_G_DestroyGeometry( OGRGeometryH );
00068 OGRGeometryH CPL_DLL OGR_G_CreateGeometry( OGRwkbGeometryType );
00069 
00070 int    CPL_DLL OGR_G_GetDimension( OGRGeometryH );
00071 int    CPL_DLL OGR_G_GetCoordinateDimension( OGRGeometryH );
00072 void   CPL_DLL OGR_G_SetCoordinateDimension( OGRGeometryH, int );
00073 OGRGeometryH CPL_DLL OGR_G_Clone( OGRGeometryH );
00074 void   CPL_DLL OGR_G_GetEnvelope( OGRGeometryH, OGREnvelope * );
00075 OGRErr CPL_DLL OGR_G_ImportFromWkb( OGRGeometryH, unsigned char *, int );
00076 OGRErr CPL_DLL OGR_G_ExportToWkb( OGRGeometryH, OGRwkbByteOrder, unsigned char*);
00077 int    CPL_DLL OGR_G_WkbSize( OGRGeometryH hGeom );
00078 OGRErr CPL_DLL OGR_G_ImportFromWkt( OGRGeometryH, char ** );
00079 OGRErr CPL_DLL OGR_G_ExportToWkt( OGRGeometryH, char ** );
00080 OGRwkbGeometryType CPL_DLL OGR_G_GetGeometryType( OGRGeometryH );
00081 const char CPL_DLL *OGR_G_GetGeometryName( OGRGeometryH );
00082 void   CPL_DLL OGR_G_DumpReadable( OGRGeometryH, FILE *, const char * );
00083 void   CPL_DLL OGR_G_FlattenTo2D( OGRGeometryH );
00084 void   CPL_DLL OGR_G_CloseRings( OGRGeometryH );
00085 
00086 OGRGeometryH CPL_DLL OGR_G_CreateFromGML( const char * );
00087 char   CPL_DLL *OGR_G_ExportToGML( OGRGeometryH );
00088 
00089 #if defined(_CPL_MINIXML_H_INCLUDED)
00090 OGRGeometryH CPL_DLL OGR_G_CreateFromGMLTree( const CPLXMLNode * );
00091 CPLXMLNode CPL_DLL *OGR_G_ExportToGMLTree( OGRGeometryH );
00092 CPLXMLNode CPL_DLL *OGR_G_ExportEnvelopeToGMLTree( OGRGeometryH );
00093 #endif
00094 
00095 void   CPL_DLL OGR_G_AssignSpatialReference( OGRGeometryH, 
00096                                              OGRSpatialReferenceH );
00097 OGRSpatialReferenceH CPL_DLL OGR_G_GetSpatialReference( OGRGeometryH );
00098 OGRErr CPL_DLL OGR_G_Transform( OGRGeometryH, OGRCoordinateTransformationH );
00099 OGRErr CPL_DLL OGR_G_TransformTo( OGRGeometryH, OGRSpatialReferenceH );
00100 
00101 int    CPL_DLL OGR_G_Intersects( OGRGeometryH, OGRGeometryH );
00102 int    CPL_DLL OGR_G_Equals( OGRGeometryH, OGRGeometryH );
00103 int    CPL_DLL OGR_G_Disjoint( OGRGeometryH, OGRGeometryH );
00104 int    CPL_DLL OGR_G_Touches( OGRGeometryH, OGRGeometryH );
00105 int    CPL_DLL OGR_G_Crosses( OGRGeometryH, OGRGeometryH );
00106 int    CPL_DLL OGR_G_Within( OGRGeometryH, OGRGeometryH );
00107 int    CPL_DLL OGR_G_Contains( OGRGeometryH, OGRGeometryH );
00108 int    CPL_DLL OGR_G_Overlaps( OGRGeometryH, OGRGeometryH );
00109 
00110 OGRGeometryH CPL_DLL OGR_G_GetBoundary( OGRGeometryH );
00111 OGRGeometryH CPL_DLL OGR_G_ConvexHull( OGRGeometryH );
00112 OGRGeometryH CPL_DLL OGR_G_Buffer( OGRGeometryH, double, int );
00113 OGRGeometryH CPL_DLL OGR_G_Intersection( OGRGeometryH, OGRGeometryH );
00114 OGRGeometryH CPL_DLL OGR_G_Union( OGRGeometryH, OGRGeometryH );
00115 OGRGeometryH CPL_DLL OGR_G_Difference( OGRGeometryH, OGRGeometryH );
00116 OGRGeometryH CPL_DLL OGR_G_SymmetricDifference( OGRGeometryH, OGRGeometryH );
00117 double CPL_DLL OGR_G_Distance( OGRGeometryH, OGRGeometryH );
00118 
00119 double CPL_DLL OGR_G_GetArea( OGRGeometryH );
00120 int    CPL_DLL OGR_G_Centroid( OGRGeometryH, OGRGeometryH );
00121 
00122 void   CPL_DLL OGR_G_Empty( OGRGeometryH );
00123 
00124 /* backward compatibility */
00125 int    CPL_DLL OGR_G_Intersect( OGRGeometryH, OGRGeometryH );
00126 int    CPL_DLL OGR_G_Equal( OGRGeometryH, OGRGeometryH );
00127 
00128 /* Methods for getting/setting vertices in points, line strings and rings */
00129 int    CPL_DLL OGR_G_GetPointCount( OGRGeometryH );
00130 double CPL_DLL OGR_G_GetX( OGRGeometryH, int );
00131 double CPL_DLL OGR_G_GetY( OGRGeometryH, int );
00132 double CPL_DLL OGR_G_GetZ( OGRGeometryH, int );
00133 void   CPL_DLL OGR_G_GetPoint( OGRGeometryH, int iPoint, 
00134                                double *, double *, double * );
00135 void   CPL_DLL OGR_G_SetPoint( OGRGeometryH, int iPoint, 
00136                                double, double, double );
00137 void   CPL_DLL OGR_G_SetPoint_2D( OGRGeometryH, int iPoint, 
00138                                   double, double );
00139 void   CPL_DLL OGR_G_AddPoint( OGRGeometryH, double, double, double );
00140 void   CPL_DLL OGR_G_AddPoint_2D( OGRGeometryH, double, double );
00141 
00142 /* Methods for getting/setting rings and members collections */
00143 
00144 int    CPL_DLL OGR_G_GetGeometryCount( OGRGeometryH );
00145 OGRGeometryH CPL_DLL OGR_G_GetGeometryRef( OGRGeometryH, int );
00146 OGRErr CPL_DLL OGR_G_AddGeometry( OGRGeometryH, OGRGeometryH );
00147 OGRErr CPL_DLL OGR_G_AddGeometryDirectly( OGRGeometryH, OGRGeometryH );
00148 OGRErr CPL_DLL OGR_G_RemoveGeometry( OGRGeometryH, int, int );
00149 
00150 OGRGeometryH CPL_DLL OGRBuildPolygonFromEdges( OGRGeometryH hLinesAsCollection,
00151                                        int bBestEffort, 
00152                                        int bAutoClose, 
00153                                        double dfTolerance,
00154                                        OGRErr * peErr );
00155 
00156 OGRErr CPL_DLL OGRSetGenerate_DB2_V72_BYTE_ORDER( 
00157     int bGenerate_DB2_V72_BYTE_ORDER );
00158 
00159 int CPL_DLL OGRGetGenerate_DB2_V72_BYTE_ORDER(void);
00160 
00161 /* -------------------------------------------------------------------- */
00162 /*      Feature related (ogr_feature.h)                                 */
00163 /* -------------------------------------------------------------------- */
00164 
00165 typedef void *OGRFieldDefnH;
00166 typedef void *OGRFeatureDefnH;
00167 typedef void *OGRFeatureH;
00168 
00169 /* OGRFieldDefn */
00170 
00171 OGRFieldDefnH CPL_DLL OGR_Fld_Create( const char *, OGRFieldType );
00172 void   CPL_DLL OGR_Fld_Destroy( OGRFieldDefnH );
00173 
00174 void   CPL_DLL OGR_Fld_SetName( OGRFieldDefnH, const char * );
00175 const char CPL_DLL *OGR_Fld_GetNameRef( OGRFieldDefnH );
00176 OGRFieldType CPL_DLL OGR_Fld_GetType( OGRFieldDefnH );
00177 void   CPL_DLL OGR_Fld_SetType( OGRFieldDefnH, OGRFieldType );
00178 OGRJustification CPL_DLL OGR_Fld_GetJustify( OGRFieldDefnH );
00179 void   CPL_DLL OGR_Fld_SetJustify( OGRFieldDefnH, OGRJustification );
00180 int    CPL_DLL OGR_Fld_GetWidth( OGRFieldDefnH );
00181 void   CPL_DLL OGR_Fld_SetWidth( OGRFieldDefnH, int );
00182 int    CPL_DLL OGR_Fld_GetPrecision( OGRFieldDefnH );
00183 void   CPL_DLL OGR_Fld_SetPrecision( OGRFieldDefnH, int );
00184 void   CPL_DLL OGR_Fld_Set( OGRFieldDefnH, const char *, OGRFieldType, 
00185                             int, int, OGRJustification );
00186 
00187 const char CPL_DLL *OGR_GetFieldTypeName( OGRFieldType );
00188 
00189 /* OGRFeatureDefn */
00190 
00191 OGRFeatureDefnH CPL_DLL OGR_FD_Create( const char * );
00192 void   CPL_DLL OGR_FD_Destroy( OGRFeatureDefnH );
00193 void   CPL_DLL OGR_FD_Release( OGRFeatureDefnH );
00194 const char CPL_DLL *OGR_FD_GetName( OGRFeatureDefnH );
00195 int    CPL_DLL OGR_FD_GetFieldCount( OGRFeatureDefnH );
00196 OGRFieldDefnH CPL_DLL OGR_FD_GetFieldDefn( OGRFeatureDefnH, int );
00197 int    CPL_DLL OGR_FD_GetFieldIndex( OGRFeatureDefnH, const char * );
00198 void   CPL_DLL OGR_FD_AddFieldDefn( OGRFeatureDefnH, OGRFieldDefnH );
00199 OGRwkbGeometryType CPL_DLL OGR_FD_GetGeomType( OGRFeatureDefnH );
00200 void   CPL_DLL OGR_FD_SetGeomType( OGRFeatureDefnH, OGRwkbGeometryType );
00201 int    CPL_DLL OGR_FD_Reference( OGRFeatureDefnH );
00202 int    CPL_DLL OGR_FD_Dereference( OGRFeatureDefnH );
00203 int    CPL_DLL OGR_FD_GetReferenceCount( OGRFeatureDefnH );
00204 
00205 /* OGRFeature */
00206 
00207 OGRFeatureH CPL_DLL OGR_F_Create( OGRFeatureDefnH );
00208 void   CPL_DLL OGR_F_Destroy( OGRFeatureH );
00209 OGRFeatureDefnH CPL_DLL OGR_F_GetDefnRef( OGRFeatureH );
00210 
00211 OGRErr CPL_DLL OGR_F_SetGeometryDirectly( OGRFeatureH, OGRGeometryH );
00212 OGRErr CPL_DLL OGR_F_SetGeometry( OGRFeatureH, OGRGeometryH );
00213 OGRGeometryH CPL_DLL OGR_F_GetGeometryRef( OGRFeatureH );
00214 OGRFeatureH CPL_DLL OGR_F_Clone( OGRFeatureH );
00215 int    CPL_DLL OGR_F_Equal( OGRFeatureH, OGRFeatureH );
00216 
00217 int    CPL_DLL OGR_F_GetFieldCount( OGRFeatureH );
00218 OGRFieldDefnH CPL_DLL OGR_F_GetFieldDefnRef( OGRFeatureH, int );
00219 int    CPL_DLL OGR_F_GetFieldIndex( OGRFeatureH, const char * );
00220 
00221 int    CPL_DLL OGR_F_IsFieldSet( OGRFeatureH, int );
00222 void   CPL_DLL OGR_F_UnsetField( OGRFeatureH, int );
00223 OGRField CPL_DLL *OGR_F_GetRawFieldRef( OGRFeatureH, int );
00224 
00225 int    CPL_DLL OGR_F_GetFieldAsInteger( OGRFeatureH, int );
00226 double CPL_DLL OGR_F_GetFieldAsDouble( OGRFeatureH, int );
00227 const char CPL_DLL *OGR_F_GetFieldAsString( OGRFeatureH, int );
00228 const int CPL_DLL *OGR_F_GetFieldAsIntegerList( OGRFeatureH, int, int * );
00229 const double CPL_DLL *OGR_F_GetFieldAsDoubleList( OGRFeatureH, int, int * );
00230 char  CPL_DLL **OGR_F_GetFieldAsStringList( OGRFeatureH, int );
00231 GByte CPL_DLL *OGR_F_GetFieldAsBinary( OGRFeatureH, int, int * );
00232 int   CPL_DLL  OGR_F_GetFieldAsDateTime( OGRFeatureH, int, int *, int *, int *,
00233                                          int *, int *, int *, int * );
00234 
00235 void   CPL_DLL OGR_F_SetFieldInteger( OGRFeatureH, int, int );
00236 void   CPL_DLL OGR_F_SetFieldDouble( OGRFeatureH, int, double );
00237 void   CPL_DLL OGR_F_SetFieldString( OGRFeatureH, int, const char * );
00238 void   CPL_DLL OGR_F_SetFieldIntegerList( OGRFeatureH, int, int, int * );
00239 void   CPL_DLL OGR_F_SetFieldDoubleList( OGRFeatureH, int, int, double * );
00240 void   CPL_DLL OGR_F_SetFieldStringList( OGRFeatureH, int, char ** );
00241 void   CPL_DLL OGR_F_SetFieldRaw( OGRFeatureH, int, OGRField * );
00242 void   CPL_DLL OGR_F_SetFieldBinary( OGRFeatureH, int, int, GByte * );
00243 void   CPL_DLL OGR_F_SetFieldDateTime( OGRFeatureH, int, 
00244                                        int, int, int, int, int, int, int );
00245 
00246 long   CPL_DLL OGR_F_GetFID( OGRFeatureH );
00247 OGRErr CPL_DLL OGR_F_SetFID( OGRFeatureH, long );
00248 void   CPL_DLL OGR_F_DumpReadable( OGRFeatureH, FILE * );
00249 OGRErr CPL_DLL OGR_F_SetFrom( OGRFeatureH, OGRFeatureH, int );
00250 
00251 const char CPL_DLL *OGR_F_GetStyleString( OGRFeatureH );
00252 void   CPL_DLL OGR_F_SetStyleString( OGRFeatureH, const char * );
00253 void   CPL_DLL OGR_F_SetStyleStringDirectly( OGRFeatureH, char * );
00254 
00255 /* -------------------------------------------------------------------- */
00256 /*      ogrsf_frmts.h                                                   */
00257 /* -------------------------------------------------------------------- */
00258 
00259 typedef void *OGRLayerH;
00260 typedef void *OGRDataSourceH;
00261 typedef void *OGRSFDriverH;
00262 
00263 /* OGRLayer */
00264 
00265 OGRGeometryH CPL_DLL OGR_L_GetSpatialFilter( OGRLayerH );
00266 void   CPL_DLL OGR_L_SetSpatialFilter( OGRLayerH, OGRGeometryH );
00267 void   CPL_DLL OGR_L_SetSpatialFilterRect( OGRLayerH, 
00268                                            double, double, double, double );
00269 OGRErr CPL_DLL OGR_L_SetAttributeFilter( OGRLayerH, const char * );
00270 void   CPL_DLL OGR_L_ResetReading( OGRLayerH );
00271 OGRFeatureH CPL_DLL OGR_L_GetNextFeature( OGRLayerH );
00272 OGRErr CPL_DLL OGR_L_SetNextByIndex( OGRLayerH, long );
00273 OGRFeatureH CPL_DLL OGR_L_GetFeature( OGRLayerH, long );
00274 OGRErr CPL_DLL OGR_L_SetFeature( OGRLayerH, OGRFeatureH );
00275 OGRErr CPL_DLL OGR_L_CreateFeature( OGRLayerH, OGRFeatureH );
00276 OGRErr CPL_DLL OGR_L_DeleteFeature( OGRLayerH, long );
00277 OGRFeatureDefnH CPL_DLL OGR_L_GetLayerDefn( OGRLayerH );
00278 OGRSpatialReferenceH CPL_DLL OGR_L_GetSpatialRef( OGRLayerH );
00279 int    CPL_DLL OGR_L_GetFeatureCount( OGRLayerH, int );
00280 OGRErr CPL_DLL OGR_L_GetExtent( OGRLayerH, OGREnvelope *, int );
00281 int    CPL_DLL OGR_L_TestCapability( OGRLayerH, const char * );
00282 OGRErr CPL_DLL OGR_L_CreateField( OGRLayerH, OGRFieldDefnH, int );
00283 OGRErr CPL_DLL OGR_L_StartTransaction( OGRLayerH );
00284 OGRErr CPL_DLL OGR_L_CommitTransaction( OGRLayerH );
00285 OGRErr CPL_DLL OGR_L_RollbackTransaction( OGRLayerH );
00286 int    CPL_DLL OGR_L_Reference( OGRLayerH );
00287 int    CPL_DLL OGR_L_Dereference( OGRLayerH );
00288 int    CPL_DLL OGR_L_GetRefCount( OGRLayerH );
00289 OGRErr CPL_DLL OGR_L_SyncToDisk( OGRLayerH );
00290 GIntBig CPL_DLL OGR_L_GetFeaturesRead( OGRLayerH );
00291 const char CPL_DLL *OGR_L_GetFIDColumn( OGRLayerH );
00292 const char CPL_DLL *OGR_L_GetGeometryColumn( OGRLayerH );
00293 /* OGRDataSource */
00294 
00295 void   CPL_DLL OGR_DS_Destroy( OGRDataSourceH );
00296 const char CPL_DLL *OGR_DS_GetName( OGRDataSourceH );
00297 int    CPL_DLL OGR_DS_GetLayerCount( OGRDataSourceH );
00298 OGRLayerH CPL_DLL OGR_DS_GetLayer( OGRDataSourceH, int );
00299 OGRLayerH CPL_DLL OGR_DS_GetLayerByName( OGRDataSourceH, const char * );
00300 OGRErr    CPL_DLL OGR_DS_DeleteLayer( OGRDataSourceH, int );
00301 OGRSFDriverH CPL_DLL OGR_DS_GetDriver( OGRDataSourceH );
00302 OGRLayerH CPL_DLL OGR_DS_CreateLayer( OGRDataSourceH, const char *, 
00303                                       OGRSpatialReferenceH, OGRwkbGeometryType,
00304                                       char ** );
00305 OGRLayerH CPL_DLL OGR_DS_CopyLayer( OGRDataSourceH, OGRLayerH, const char *,
00306                                     char ** );
00307 int    CPL_DLL OGR_DS_TestCapability( OGRDataSourceH, const char * );
00308 OGRLayerH CPL_DLL OGR_DS_ExecuteSQL( OGRDataSourceH, const char *,
00309                                      OGRGeometryH, const char * );
00310 void   CPL_DLL OGR_DS_ReleaseResultSet( OGRDataSourceH, OGRLayerH );
00311 int    CPL_DLL OGR_DS_Reference( OGRDataSourceH );
00312 int    CPL_DLL OGR_DS_Dereference( OGRDataSourceH );
00313 int    CPL_DLL OGR_DS_GetRefCount( OGRDataSourceH );
00314 int    CPL_DLL OGR_DS_GetSummaryRefCount( OGRDataSourceH );
00315 OGRErr CPL_DLL OGR_DS_SyncToDisk( OGRDataSourceH );
00316 
00317 /* OGRSFDriver */
00318 
00319 const char CPL_DLL *OGR_Dr_GetName( OGRSFDriverH );
00320 OGRDataSourceH CPL_DLL OGR_Dr_Open( OGRSFDriverH, const char *, int );
00321 int CPL_DLL OGR_Dr_TestCapability( OGRSFDriverH, const char * );
00322 OGRDataSourceH CPL_DLL OGR_Dr_CreateDataSource( OGRSFDriverH, const char *,
00323                                                 char ** );
00324 OGRDataSourceH CPL_DLL OGR_Dr_CopyDataSource( OGRSFDriverH,  OGRDataSourceH, 
00325                                               const char *, char ** );
00326 OGRErr CPL_DLL OGR_Dr_DeleteDataSource( OGRSFDriverH, const char * );
00327 
00328 /* OGRSFDriverRegistrar */
00329 
00330 OGRDataSourceH CPL_DLL OGROpen( const char *, int, OGRSFDriverH * );
00331 OGRDataSourceH CPL_DLL OGROpenShared( const char *, int, OGRSFDriverH * );
00332 OGRErr  CPL_DLL OGRReleaseDataSource( OGRDataSourceH );
00333 void    CPL_DLL OGRRegisterDriver( OGRSFDriverH );
00334 int     CPL_DLL OGRGetDriverCount(void);
00335 OGRSFDriverH CPL_DLL OGRGetDriver( int );
00336 OGRSFDriverH CPL_DLL OGRGetDriverByName( const char * );
00337 int     CPL_DLL OGRGetOpenDSCount(void);
00338 OGRDataSourceH CPL_DLL OGRGetOpenDS( int iDS );
00339 
00340 
00341 /* note: this is also declared in ogrsf_frmts.h */
00342 void CPL_DLL OGRRegisterAll(void);
00343 void CPL_DLL OGRCleanupAll(void);
00344 
00345 CPL_C_END
00346 
00347 #endif /* ndef _OGR_API_H_INCLUDED */
00348 
00349 

Generated for GDAL by doxygen 1.4.4.