luciad::WmsDataSource::Builder Class Reference

A builder to create WmsDataSource instances. More...

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

Public Member Functions
	Builder (Builder &&other) noexcept
	Move constructor.
	Builder (const Builder &other)
	Copy constructor.
	~Builder ()
Builder &	addLayer (std::string layerName)
	Adds a WMS layer to load.
Builder &	addLayer (std::string layerName, std::string layerStyleName)
	Adds a WMS layer to load.
std::shared_ptr< WmsDataSource >	build ()
	Build the WMS data source.
Builder &	format (std::string format)
	Sets the image format for GetMap requests.
Builder &	operator= (Builder other) noexcept
Builder &	styledLayerDescriptor (std::string styledLayerDescriptor)
	Sets the Styled Layer Descriptor to pass when making a request.
Builder &	styledLayerDescriptorUrl (std::string styledLayerDescriptorUrl)
	Sets an URL pointing to a valid Styled Layer Descriptor which will be used by the server.
Builder &	transparent (bool transparent)
	Sets if the requested image should have a transparent background, provided that the image format supports transparency.
Builder &	url (std::string url)
	Sets the base URL of the WMS data source.

Detailed Description

A builder to create WmsDataSource instances.

This builder requires at a minimum a URL and one or more layers.

Since

2020.2

Constructor & Destructor Documentation

Builder() [1/2]

luciad::WmsDataSource::Builder::Builder

(

const Builder &

other

)

Copy constructor.

Parameters

other

the builder to copy.

Builder() [2/2]

luciad::WmsDataSource::Builder::Builder ( Builder && other )

noexcept

Move constructor.

Parameters

other

the builder to move from.

~Builder()

luciad::WmsDataSource::Builder::~Builder

(

)

Member Function Documentation

addLayer() [1/2]

Builder & luciad::WmsDataSource::Builder::addLayer

(

std::string

layerName

)

Adds a WMS layer to load.

The layer is added on top of other added WMS layers.

At least one of the addLayer methods must be called.

Parameters

layerName

The name of the WMS layer.

Returns

this builder.

addLayer() [2/2]

Builder & luciad::WmsDataSource::Builder::addLayer	(	std::string	layerName,
		std::string	layerStyleName )

Adds a WMS layer to load.

The layer is added on top of other added WMS layers.

At least one of the addLayer methods must be called.

Parameters

layerName	The name of the WMS layer.
layerStyleName	The WMS layer style name. This refers to a published named layer style of the WMS capabilities.

Returns

this builder.

build()

std::shared_ptr< WmsDataSource > luciad::WmsDataSource::Builder::build

(

)

Build the WMS data source.

After calling this function, this builder should no longer be used.

Returns

the WMS data source.

Exceptions

luciad::LogicException

If not all mandatory parameters are set.

format()

Builder & luciad::WmsDataSource::Builder::format

(

std::string

format

)

Sets the image format for GetMap requests.

When this method is not called the image format is determined by the WMS model decoder.

Parameters

format

the image format for GetMap requests.

Returns

this builder.

operator=()

Builder & luciad::WmsDataSource::Builder::operator= ( Builder other )

noexcept

styledLayerDescriptor()

Builder & luciad::WmsDataSource::Builder::styledLayerDescriptor

(

std::string

styledLayerDescriptor

)

Sets the Styled Layer Descriptor to pass when making a request.

This corresponds to the SLD_BODY request parameter in the GetMap request. The SLD must not be URL encoded. The SLD can be set using either one of the following method :

• styledLayerDescriptor
• styledLayerDescriptorUrl

Note that when these methods are called multiple times, only the last method call is taken into account.

You can find more information within the article on how to use Styled Layer Descriptor.

See also

WmsDataSource::Builder::styledLayerDescriptorUrl

Parameters

styledLayerDescriptor

the Styled Layer Descriptor.

Returns

this builder.

styledLayerDescriptorUrl()

Builder & luciad::WmsDataSource::Builder::styledLayerDescriptorUrl

(

std::string

styledLayerDescriptorUrl

)

Sets an URL pointing to a valid Styled Layer Descriptor which will be used by the server.

This corresponds to the SLD request parameter in the GetMap request. The SLD can be set using either one of the following method :

• styledLayerDescriptor
• styledLayerDescriptorUrl

Note that when these methods are called multiple times, only the last method call is taken into account.

You can find more information within the article on how to use Styled Layer Descriptor.

See also

WmsDataSource::Builder::styledLayerDescriptor

Parameters

styledLayerDescriptorUrl

the URL pointing to a Styled Layer Descriptor.

Returns

this builder.

transparent()

Builder & luciad::WmsDataSource::Builder::transparent

(

bool

transparent

)

Sets if the requested image should have a transparent background, provided that the image format supports transparency.

When this method is not called the default value is true.

Parameters

transparent

if the requested image should have a transparent background, provided that the image format supports transparency.

Returns

this builder.

url()

Builder & luciad::WmsDataSource::Builder::url

(

std::string

url

)

Sets the base URL of the WMS data source.

Calling this function is mandatory.

Parameters

url	the base URL of the WMS data source. Calling this function is mandatory.

Returns

this builder.