Luciad.Formats.Wms.WmsCapabilities Class Reference

Encapsulates the capabilities of a WMS source. More...

Inheritance diagram for Luciad.Formats.Wms.WmsCapabilities:

Public Member Functions
void	Dispose ()

Static Public Member Functions
static Luciad.Formats.Wms.WmsCapabilities	GetCapabilities (string url)
	Returns the capabilities of a given WMS url if it can be retrieved. More...
static Luciad.Formats.Wms.WmsCapabilities	GetCapabilities (string url, Luciad.Formats.Wms.WmsModelDecoderOptions options)
	Returns the capabilities of a given WMS url if it can be retrieved. More...

Properties
System.Collections.Generic.IList< string >	MapFormats [get]
	The all available formats for a GetMap request. More...
string	ServerUrl [get]
	The entry url for the server. More...
Luciad.Formats.Wms.WmsLayer	TopLevelLayer [get]
	The top layer if any. More...
string	Version [get]
	The capabilities specification version. More...

Detailed Description

Encapsulates the capabilities of a WMS source.

Remarks

See WmsCapabilities.GetCapabilities for a way of obtaining such information.

Since

2020.2

See also

WmsDataSource.Builder for its usage when constructing a model.

WmsModelDecoder.Decode

Member Function Documentation

Dispose()

void Luciad.Formats.Wms.WmsCapabilities.Dispose ( )

inline

GetCapabilities() [1/2]

static Luciad.Formats.Wms.WmsCapabilities Luciad.Formats.Wms.WmsCapabilities.GetCapabilities ( string  url )

inlinestatic

Returns the capabilities of a given WMS url if it can be retrieved.

Parameters

url	The source's base url from which capabilities have to be retrieved.

Returns

capabilities parsed from the server.

Exceptions

System.IO.IOException

when retrieving or parsing the capabilities fails.

GetCapabilities() [2/2]

static Luciad.Formats.Wms.WmsCapabilities Luciad.Formats.Wms.WmsCapabilities.GetCapabilities ( string  url, Luciad.Formats.Wms.WmsModelDecoderOptions  options  )

inlinestatic

Returns the capabilities of a given WMS url if it can be retrieved.

Parameters

url	The source's base url from which capabilities have to be retrieved.
options	Options for decoding WMS data, e.g. an optional http client implementation to send HTTP requests when fetching WMS resources.

Returns

capabilities parsed from the server.

Exceptions

System.IO.IOException

when retrieving or parsing the capabilities fails.

Since

2023.0

Property Documentation

MapFormats

System.Collections.Generic.IList<string> Luciad.Formats.Wms.WmsCapabilities.MapFormats

get

The all available formats for a GetMap request.

[get]

Returns the all available formats for a GetMap request.

ServerUrl

string Luciad.Formats.Wms.WmsCapabilities.ServerUrl

get

The entry url for the server.

[get]

Returns the entry url for the server.

TopLevelLayer

Luciad.Formats.Wms.WmsLayer Luciad.Formats.Wms.WmsCapabilities.TopLevelLayer

get

The top layer if any.

[get]

Returns the top layer if any.

Version

string Luciad.Formats.Wms.WmsCapabilities.Version

get

The capabilities specification version.

[get]

Returns the capabilities specification version. The current supported version are "1.1.1" and "1.3.0".