wmsupdate - Synchronize WMSLayer object with server

Syntax

[updatedLayers, index] = wmsupdate(layers) [...] = wmsupdate(layers, param, val, ...)

Description

[updatedLayers, index] = wmsupdate(layers) returns a WMSLayer array with its properties synchronized with values from the server. The input layers contains only one unique ServerURL. Layers no longer available on the server are removed. The logical array index contains true for each available layer; therefore, updatedLayers has the same size as layers(index). Except for deletion, updatedLayers preserves the same order of layers as layers.

[...] = wmsupdate(layers, param, val, ...) specifies parameter-value pairs that modify the request. Parameter names can be abbreviated and are case-insensitive.

Note about Internet Connection

The function accesses the Internet to update the properties. The WMS server may periodically be unavailable and several minutes may elapse before the layers are updated. The function times-out after 60 seconds if a connection is not made to the server.

To specify a proxy server to connect to the Internet, select File > Preferences > Web and enter your proxy information. Use this feature if you have a firewall.

Inputs

layers

Contains WMSLayer objects

Data Type: WMSLayer array

param, val

Modifies the request. See the table below for permissible values.

Parameter	Data Type	Value	Default
`'TimeoutInSeconds'`	Integer-valued, scalar double	Indicates the number of seconds before a server times out. A value of 0 causes the time-out mechanism to be ignored.	60 seconds
`'AllowMultipleServers'`	Logical scalar	Indicates whether the `layer` array may contain elements from multiple servers. Use caution when setting the value to `true`, since a request is made to each unique server and each request may take several minutes to finish.	`false` (indicates the array must contain elements from the same server)

Examples

Update the layers from the NASA Goddard Space Flight Center WMS SVS Image Server.

% Search the abstract field of the updated layers
% to find layers containing the term 'blue marble'.
% Read and display the blue marble layer containing the term
% '1024x512' in its LayerTitle.
gsfc = wmsfind('svs.gsfc.nasa.gov', 'SearchField', 'serverurl');
gsfc = wmsupdate(gsfc);
blue_marble = gsfc.refine('blue marble', 'SearchField', ...
   'abstract');
blueMarbleQuery = '1024x512';
layer = blue_marble.refine(blueMarbleQuery);

% Display the layer.
[A, R] = wmsread(layer);
figure
worldmap world
plabel off; mlabel off
geoshow(A, R);
title(layer.LayerTitle)

Update the properties of all the layers from the NASA servers.

nasa = wmsfind('nasa', 'SearchField', 'serverurl');
nasa = wmsupdate(nasa, 'AllowMultipleServers', true);