LuciadCPillar C# 2023.1.02
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. 2020.2

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::WmsDataSource::Builder.

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.

layerName

The name of the WMS layer.

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::WmsDataSource::Builder::addLayer.

◆ 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.

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.

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::WmsDataSource::Builder::addLayer.

◆ 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. the WMS data source.

luciad::LogicException

If not all mandatory parameters are set.

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::WmsDataSource::Builder::build.

◆ 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.

format

the image format for GetMap requests.

this builder.

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::WmsDataSource::Builder::format.

◆ 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. WmsDataSource::Builder::styledLayerDescriptorUrl

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::WmsDataSource::Builder::styledLayerDescriptor.

◆ 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. WmsDataSource::Builder::styledLayerDescriptor

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::WmsDataSource::Builder::styledLayerDescriptorUrl.

◆ 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.

transparent

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

this builder.

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::WmsDataSource::Builder::transparent.

◆ 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.

url

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

this builder.

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::WmsDataSource::Builder::url.