luciad::WmtsDataSource::Builder Class Reference

Builder for creating luciad::WmtsDataSource. More...

#include <luciad/formats/wmts/WmtsDataSource.h>

Public Member Functions
	Builder (Builder &&other) noexcept
	Builder (const Builder &other)
	~Builder ()
std::shared_ptr< WmtsDataSource >	build ()
	Build the wmts data source. More...
Builder &	format (std::string format)
	Sets the preferred format to request images. More...
Builder &	layer (std::string layer)
	Sets the layer to use within the WMTS data provided by the source. More...
Builder &	operator= (Builder other) noexcept
Builder &	style (std::string style)
	Sets the style to use within the WMTS data provided by the source. More...
Builder &	url (std::string url)
	Sets the base URL of the WMTS data source. More...

Detailed Description

Builder for creating luciad::WmtsDataSource.

Constructor & Destructor Documentation

Builder() [1/2]

luciad::WmtsDataSource::Builder::Builder

(

const Builder &

other

)

Builder() [2/2]

luciad::WmtsDataSource::Builder::Builder ( Builder &&  other )

noexcept

~Builder()

luciad::WmtsDataSource::Builder::~Builder

(

)

Member Function Documentation

build()

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

(

)

Build the wmts data source.

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

Exceptions

luciad::LogicException

If not all mandatory parameters are set.

Returns

the wmts data source.

format()

Builder & luciad::WmtsDataSource::Builder::format

(

std::string

format

)

Sets the preferred format to request images.

If specified and if the layer offers specified format, it will be selected as a preference when requesting images.

Parameters

format

Preferred format to request images.

Remarks

If specified and if the layer offers specified format, it will be selected as a preference when requesting images.

layer()

Builder & luciad::WmtsDataSource::Builder::layer

(

std::string

layer

)

Sets the layer to use within the WMTS data provided by the source.

An empty layer name will link to the first layer described in the capabilities.

Parameters

layer

Layer to use within the WMTS data provided by the source.

Remarks

An empty layer name will link to the first layer described in the capabilities.

operator=()

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

noexcept

style()

Builder & luciad::WmtsDataSource::Builder::style

(

std::string

style

)

Sets the style to use within the WMTS data provided by the source.

An empty style name will link to the default layer style.

Parameters

style

Style to use within the WMTS data provided by the source.

Remarks

An empty style name will link to the default layer style.

url()

Builder & luciad::WmtsDataSource::Builder::url

(

std::string

url

)

Sets the base URL of the WMTS data source.

Calling this function is mandatory.

Parameters

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

Returns

this builder.