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

#include <luciad/formats/wms/WmsCapabilities.h>

Public Member Functions
	~WmsCapabilities ()

const std::vector< std::string > &	getMapFormats () const
	Returns the all available formats for a GetMap request. More...

const std::string &	getServerUrl () const
	Returns the entry url for the server. More...

const std::shared_ptr< WmsLayer > &	getTopLevelLayer () const
	Returns the top layer if any. More...

const std::string &	getVersion () const
	Returns the capabilities specification version. More...

Static Public Member Functions
static luciad::expected< std::shared_ptr< WmsCapabilities >, ErrorInfo >	getCapabilities (const std::string &url)
	Returns the capabilities of a given WMS url if it can be retrieved. More...

static luciad::expected< std::shared_ptr< WmsCapabilities >, ErrorInfo >	getCapabilities (const std::string &url, const WmsModelDecoderOptions &options)
	Returns the capabilities of a given WMS url if it can be retrieved. More...

Detailed Description

Encapsulates the capabilities of a WMS source.

Remarks: See WmsCapabilities::getCapabilities for a way of obtaining such information.

See also: WmsDataSource::Builder for its usage when constructing a model.; WmsModelDecoder::decode

Since: 2020.2

Constructor & Destructor Documentation

◆ ~WmsCapabilities()

luciad::WmsCapabilities::~WmsCapabilities ( )

Member Function Documentation

◆ getCapabilities() [1/2]

static luciad::expected< std::shared_ptr< WmsCapabilities >, ErrorInfo > luciad::WmsCapabilities::getCapabilities ( const std::string & url )

static

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, or an error message explaining why it failed.

◆ getCapabilities() [2/2]

static luciad::expected< std::shared_ptr< WmsCapabilities >, ErrorInfo > luciad::WmsCapabilities::getCapabilities	(	const std::string &	url,
		const WmsModelDecoderOptions &	options
	)

static

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, or an error message explaining why it failed.

Since: 2023.0

◆ getMapFormats()

const std::vector< std::string > & luciad::WmsCapabilities::getMapFormats ( ) const

Returns the all available formats for a GetMap request.

Returns: the available map formats.

◆ getServerUrl()

const std::string & luciad::WmsCapabilities::getServerUrl ( ) const

Returns the entry url for the server.

Returns: the entry url for the server.

◆ getTopLevelLayer()

const std::shared_ptr< WmsLayer > & luciad::WmsCapabilities::getTopLevelLayer ( ) const

Returns the top layer if any.

Returns: the top layer or nullptr.

◆ getVersion()

const std::string & luciad::WmsCapabilities::getVersion ( ) const

Returns the capabilities specification version.

The current supported version are "1.1.1" and "1.3.0".

Returns: the capabilities specification version.

Public Member Functions

Static Public Member Functions