Luciad.Formats.Wms.WmsDataSource.Builder Class Reference

A builder to create WmsDataSource instances. More...

Inheritance diagram for Luciad.Formats.Wms.WmsDataSource.Builder:

Public Member Functions
	Builder (Luciad.Formats.Wms.WmsDataSource.Builder other)
Luciad.Formats.Wms.WmsDataSource.Builder	AddLayer (string layerName)
	Adds a WMS layer to load. More...
Luciad.Formats.Wms.WmsDataSource.Builder	AddLayer (string layerName, string layerStyleName)
	Adds a WMS layer to load. More...
Luciad.Formats.Wms.WmsDataSource	Build ()
	Build the WMS data source. More...
void	Dispose ()
Luciad.Formats.Wms.WmsDataSource.Builder	Format (string format)
	Sets the image format for GetMap requests. More...
Luciad.Formats.Wms.WmsDataSource.Builder	StyledLayerDescriptor (string styledLayerDescriptor)
	Sets the Styled Layer Descriptor to pass when making a request. More...
Luciad.Formats.Wms.WmsDataSource.Builder	StyledLayerDescriptorUrl (string styledLayerDescriptorUrl)
	Sets an URL pointing to a valid Styled Layer Descriptor which will be used by the server. More...
Luciad.Formats.Wms.WmsDataSource.Builder	Transparent (bool transparent)
	Sets if the requested image should have a transparent background, provided that the image format supports transparency. More...
Luciad.Formats.Wms.WmsDataSource.Builder	Url (string url)
	Sets the base URL of the WMS data source. More...

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()

Luciad.Formats.Wms.WmsDataSource.Builder.Builder ( Luciad.Formats.Wms.WmsDataSource.Builder  other )

inline

Member Function Documentation

AddLayer() [1/2]

Luciad.Formats.Wms.WmsDataSource.Builder Luciad.Formats.Wms.WmsDataSource.Builder.AddLayer ( string  layerName )

inline

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.

AddLayer() [2/2]

Luciad.Formats.Wms.WmsDataSource.Builder Luciad.Formats.Wms.WmsDataSource.Builder.AddLayer ( string  layerName, string  layerStyleName  )

inline

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.

Build()

Luciad.Formats.Wms.WmsDataSource Luciad.Formats.Wms.WmsDataSource.Builder.Build ( )

inline

Build the WMS data source.

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

Returns

the WMS data source.

Exceptions

System.InvalidOperationException

If not all mandatory parameters are set.

Dispose()

void Luciad.Formats.Wms.WmsDataSource.Builder.Dispose ( )

inline

Format()

Luciad.Formats.Wms.WmsDataSource.Builder Luciad.Formats.Wms.WmsDataSource.Builder.Format ( string  format )

inline

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.

StyledLayerDescriptor()

Luciad.Formats.Wms.WmsDataSource.Builder Luciad.Formats.Wms.WmsDataSource.Builder.StyledLayerDescriptor ( string  styledLayerDescriptor )

inline

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

StyledLayerDescriptorUrl()

Luciad.Formats.Wms.WmsDataSource.Builder Luciad.Formats.Wms.WmsDataSource.Builder.StyledLayerDescriptorUrl ( string  styledLayerDescriptorUrl )

inline

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

Transparent()

Luciad.Formats.Wms.WmsDataSource.Builder Luciad.Formats.Wms.WmsDataSource.Builder.Transparent ( bool  transparent )

inline

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()

Luciad.Formats.Wms.WmsDataSource.Builder Luciad.Formats.Wms.WmsDataSource.Builder.Url ( string  url )

inline

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.