GDAL

ogr_geocoding.h
Go to the documentation of this file.
1 /******************************************************************************
2 * $Id$
3 *
4 * Project: OpenGIS Simple Features Reference Implementation
5 * Purpose: Client of geocoding service.
6 * Author: Even Rouault, <even dot rouault at spatialys.com>
7 *
8 ******************************************************************************
9 * Copyright (c) 2012, Even Rouault <even dot rouault at spatialys.com>
10 *
11 * Permission is hereby granted, free of charge, to any person obtaining a
12 * copy of this software and associated documentation files (the "Software"),
13 * to deal in the Software without restriction, including without limitation
14 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
15 * and/or sell copies of the Software, and to permit persons to whom the
16 * Software is furnished to do so, subject to the following conditions:
17 *
18 * The above copyright notice and this permission notice shall be included
19 * in all copies or substantial portions of the Software.
20 *
21 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
22 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
24 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
26 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
27 * DEALINGS IN THE SOFTWARE.
28 ****************************************************************************/
29
30 #ifndef OGR_GEOCODING_H_INCLUDED
31 #define OGR_GEOCODING_H_INCLUDED
32
33 #include "cpl_port.h"
34 #include "ogr_api.h"
35
42 CPL_C_START
43
45 typedef struct _OGRGeocodingSessionHS *OGRGeocodingSessionH;
46
47 OGRGeocodingSessionH CPL_DLL OGRGeocodeCreateSession(char** papszOptions);
48
49 void CPL_DLL OGRGeocodeDestroySession(OGRGeocodingSessionH hSession);
50
51 OGRLayerH CPL_DLL OGRGeocode(OGRGeocodingSessionH hSession,
52 const char* pszQuery,
53 char** papszStructuredQuery,
54 char** papszOptions);
55
56 OGRLayerH CPL_DLL OGRGeocodeReverse(OGRGeocodingSessionH hSession,
57 double dfLon, double dfLat,
58 char** papszOptions);
59
60 void CPL_DLL OGRGeocodeFreeResult(OGRLayerH hLayer);
61
62 CPL_C_END
63
64 #endif // OGR_GEOCODING_H_INCLUDED
OGRGeocodeCreateSession
OGRGeocodingSessionH OGRGeocodeCreateSession(char **papszOptions)
Creates a session handle for geocoding requests.
Definition: ogr_geocoding.cpp:252
OGRGeocodeDestroySession
void OGRGeocodeDestroySession(OGRGeocodingSessionH hSession)
Destroys a session handle for geocoding requests.
Definition: ogr_geocoding.cpp:392
CPL_C_START
#define CPL_C_START
Macro to start a block of C symbols.
Definition: cpl_port.h:304
OGRGeocodingSessionH
struct _OGRGeocodingSessionHS * OGRGeocodingSessionH
Opaque type for a geocoding session.
Definition: ogr_geocoding.h:45
OGRGeocodeFreeResult
void OGRGeocodeFreeResult(OGRLayerH hLayer)
Destroys the result of a geocoding request.
Definition: ogr_geocoding.cpp:1605
CPL_C_END
#define CPL_C_END
Macro to end a block of C symbols.
Definition: cpl_port.h:306
cpl_port.h
ogr_api.h
OGRGeocode
OGRLayerH OGRGeocode(OGRGeocodingSessionH hSession, const char *pszQuery, char **papszStructuredQuery, char **papszOptions)
Runs a geocoding request.
Definition: ogr_geocoding.cpp:1430
OGRLayerH
void * OGRLayerH
Opaque type for a layer (OGRLayer)
Definition: ogr_api.h:592
OGRGeocodeReverse
OGRLayerH OGRGeocodeReverse(OGRGeocodingSessionH hSession, double dfLon, double dfLat, char **papszOptions)
Runs a reverse geocoding request.
Definition: ogr_geocoding.cpp:1563