*/
/**
- * Metacarte
- * ---------
- * http://labs.metacarta.com/wms/vmap0?
- * LAYERS=basic&
- * SERVICE=WMS&
- * VERSION=1.1.1&
- * REQUEST=GetMap&
- * STYLES=&
- * EXCEPTIONS=application/vnd.ogc.se_inimage&
- * FORMAT=image/jpeg&
- * SRS=EPSG:4326&
- * BBOX=0,-90,180,90&
- * WIDTH=256&
- * HEIGHT=256
+ * SECTION:gis-wms
+ * @short_description: Web Map Service
+ *
+ * Provides an API for accessing image tiles form a Web Map Service (WMS)
+ * server. #GisWms integrates closely with #GisTile. The remote server must
+ * support the EPSG:4326 cartographic projection.
*/
-/**
- * http://www.nasa.network.com/elev?
- * SERVICE=WMS&
- * VERSION=1.1.0&
- * REQUEST=GetMap&
- * LAYERS=bmng200406&
- * STYLES=&
- * SRS=EPSG:4326&
- * BBOX=-180,-90,180,90&
- * FORMAT=image/jpeg&
- * WIDTH=600&
- * HEIGHT=300
+/*
+ * Example WMS URLS
+ * ----------------
+ *
+ * Metacarte Open Street Map:
+ * http://labs.metacarta.com/wms/vmap0?
+ * LAYERS=basic&
+ * SERVICE=WMS&
+ * VERSION=1.1.1&
+ * REQUEST=GetMap&
+ * STYLES=&
+ * EXCEPTIONS=application/vnd.ogc.se_inimage&
+ * FORMAT=image/jpeg&
+ * SRS=EPSG:4326&
+ * BBOX=0,-90,180,90&
+ * WIDTH=256&
+ * HEIGHT=256
*
- * http://www.nasa.network.com/elev?
- * SERVICE=WMS&
- * VERSION=1.1.0&
- * REQUEST=GetMap&
- * LAYERS=srtm30&
- * STYLES=&
- * SRS=EPSG:4326&
- * BBOX=-180,-90,180,90&
- * FORMAT=application/bil32&
- * WIDTH=600&
- * HEIGHT=300
+ * NASA Blue Marble Next Generation:
+ * http://www.nasa.network.com/elev?
+ * SERVICE=WMS&
+ * VERSION=1.1.0&
+ * REQUEST=GetMap&
+ * LAYERS=bmng200406&
+ * STYLES=&
+ * SRS=EPSG:4326&
+ * BBOX=-180,-90,180,90&
+ * FORMAT=image/jpeg&
+ * WIDTH=600&
+ * HEIGHT=300
+ *
+ * NASA Shuttle Radar Topography Mission:
+ * http://www.nasa.network.com/elev?
+ * SERVICE=WMS&
+ * VERSION=1.1.0&
+ * REQUEST=GetMap&
+ * LAYERS=srtm30&
+ * STYLES=&
+ * SRS=EPSG:4326&
+ * BBOX=-180,-90,180,90&
+ * FORMAT=application/bil32&
+ * WIDTH=600&
+ * HEIGHT=300
*/
#include <config.h>
tile->edge.n);
}
-gchar *gis_wms_fetch(GisWms *self, GisTile *tile, GisCacheType mode,
+/**
+ * gis_wms_fetch:
+ * @wms: the #GisWms to fetch the data from
+ * @tile: a #GisTile representing the area to be fetched
+ * @mode: the update type to use when fetching data
+ * @callback: callback to call when a chunk of data is received
+ * @user_data: user data to pass to the callback
+ *
+ * Fetch a image coresponding to a #GisTile from a WMS server.
+ *
+ * Returns: the path to the local file.
+ */
+gchar *gis_wms_fetch(GisWms *wms, GisTile *tile, GisCacheType mode,
GisChunkCallback callback, gpointer user_data)
{
- gchar *uri = _make_uri(self, tile);
+ gchar *uri = _make_uri(wms, tile);
gchar *tilep = gis_tile_get_path(tile);
- gchar *local = g_strdup_printf("%s%s", tilep, self->extension);
+ gchar *local = g_strdup_printf("%s%s", tilep, wms->extension);
mode = GIS_ONCE;
- gchar *path = gis_http_fetch(self->http, uri, local,
+ gchar *path = gis_http_fetch(wms->http, uri, local,
mode, callback, user_data);
g_free(uri);
g_free(tilep);
return path;
}
+/**
+ * gis_wms_new:
+ * @uri_prefix: the base URL for the WMS server
+ * @uri_layer: the layer the images should be fetched from (wms LAYERS)
+ * @uri_format: the format the images should be fetch in (wms FORMAT)
+ * @prefix: prefix to use for local files
+ * @extension: file extension for local files, should correspond to @uri_format
+ * @width: width in pixels for downloaded images (wms WIDTH)
+ * @height: height in pixels for downloaded images (wms HEIGHT)
+ *
+ * Creates a #GisWms for some layer on a WMS server. The returned #GisWms
+ * stores information about the images so it does not need to be entered each
+ * time a images is fetched.
+ *
+ * Returns: the new #GisWms
+ */
GisWms *gis_wms_new(
const gchar *uri_prefix, const gchar *uri_layer,
const gchar *uri_format, const gchar *prefix,
const gchar *extension, gint width, gint height)
{
g_debug("GisWms: new - %s", uri_prefix);
- GisWms *self = g_new0(GisWms, 1);
- self->http = gis_http_new(prefix);
- self->uri_prefix = g_strdup(uri_prefix);
- self->uri_layer = g_strdup(uri_layer);
- self->uri_format = g_strdup(uri_format);
- self->extension = g_strdup(extension);
- self->width = width;
- self->height = height;
- return self;
+ GisWms *wms = g_new0(GisWms, 1);
+ wms->http = gis_http_new(prefix);
+ wms->uri_prefix = g_strdup(uri_prefix);
+ wms->uri_layer = g_strdup(uri_layer);
+ wms->uri_format = g_strdup(uri_format);
+ wms->extension = g_strdup(extension);
+ wms->width = width;
+ wms->height = height;
+ return wms;
}
-void gis_wms_free(GisWms *self)
+/**
+ * gis_wms_free:
+ * @wms: the #GisWms to free
+ *
+ * Free resources used by @wms and cancel any pending requests.
+ */
+void gis_wms_free(GisWms *wms)
{
- g_debug("GisWms: free - %s", self->uri_prefix);
- gis_http_free(self->http);
- g_free(self->uri_prefix);
- g_free(self->uri_layer);
- g_free(self->uri_format);
- g_free(self->extension);
- g_free(self);
+ g_debug("GisWms: free - %s", wms->uri_prefix);
+ gis_http_free(wms->http);
+ g_free(wms->uri_prefix);
+ g_free(wms->uri_layer);
+ g_free(wms->uri_format);
+ g_free(wms->extension);
+ g_free(wms);
}
projects / grits / blobdiff