LuciadCPillar 2023.1.04
luciad::WmtsDataSource Class Referencefinal

Describes a WMTS data source and how to access it. More...

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

Classes

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

Public Member Functions

 ~WmtsDataSource ()
 
const std::optional< std::string > & getFormat () const
 Returns the preferred format to request images. More...
 
const std::optional< std::string > & getLayer () const
 Returns the layer to use within the WMTS data provided by the source. More...
 
const std::optional< std::string > & getStyle () const
 Returns the style to use for the layer. More...
 
const std::string & getUrl () const
 Returns the base URL of the WMTS data source. More...
 

Static Public Member Functions

static Builder newBuilder ()
 Returns the builder class for creation of the WMTS data source. More...
 

Detailed Description

Describes a WMTS data source and how to access it.

Used for creating WMTS models.

Constructor & Destructor Documentation

◆ ~WmtsDataSource()

luciad::WmtsDataSource::~WmtsDataSource ( )

Member Function Documentation

◆ getFormat()

const std::optional< std::string > & luciad::WmtsDataSource::getFormat ( ) const

Returns the preferred format to request images.

When specified and the layer offers the specified format, it is used when requesting images.

Remarks
When specified and the layer offers the specified format, it is used when requesting images.
Returns
the preferred format to request images.

◆ getLayer()

const std::optional< std::string > & luciad::WmtsDataSource::getLayer ( ) const

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

When no layer is provided, the first layer from the WMTS is used.

Remarks
When no layer is provided, the first layer from the WMTS is used.
Returns
the layer to use within the WMTS data provided by the source.

◆ getStyle()

const std::optional< std::string > & luciad::WmtsDataSource::getStyle ( ) const

Returns the style to use for the layer.

When no style is selected, the default advertised in the capabilities is used.

Remarks
When no style is selected, the default advertised in the capabilities is used.
Returns
the style to use for the layer.

◆ getUrl()

const std::string & luciad::WmtsDataSource::getUrl ( ) const

Returns the base URL of the WMTS data source.

Returns
the base URL of the WMTS data source.

◆ newBuilder()

static Builder luciad::WmtsDataSource::newBuilder ( )
static

Returns the builder class for creation of the WMTS data source.

Returns
the builder class for creation of the WMTS data source.