LuciadCPillar 2024.0.04
luciad::WmtsModelDecoder Class Referencefinal

This class can be used to create an IRasterModel implementation that can read WMTS tiles. More...

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

Public Member Functions

 WmtsModelDecoder ()=delete
 
 ~WmtsModelDecoder ()=delete
 

Static Public Member Functions

static luciad::expected< std::shared_ptr< IRasterModel >, ErrorInfodecode (const std::shared_ptr< WmtsDataSource > &source, const WmtsModelDecoderOptions &options, std::shared_ptr< WmtsCapabilities > sourceCapabilities=nullptr)
 Creates a WMTS raster model, or returns information about why this model can not be created. More...
 
static luciad::expected< std::shared_ptr< IRasterModel >, ErrorInfodecode (const std::shared_ptr< WmtsDataSource > &source, std::shared_ptr< WmtsCapabilities > sourceCapabilities=nullptr)
 Creates a WMTS raster model, or returns information about why this model can not be created. More...
 

Detailed Description

This class can be used to create an IRasterModel implementation that can read WMTS tiles.

See also
WmtsModelDecoder::decode for more details.

Constructor & Destructor Documentation

◆ WmtsModelDecoder()

luciad::WmtsModelDecoder::WmtsModelDecoder ( )
delete

◆ ~WmtsModelDecoder()

luciad::WmtsModelDecoder::~WmtsModelDecoder ( )
delete

Member Function Documentation

◆ decode() [1/2]

static luciad::expected< std::shared_ptr< IRasterModel >, ErrorInfo > luciad::WmtsModelDecoder::decode ( const std::shared_ptr< WmtsDataSource > &  source,
const WmtsModelDecoderOptions options,
std::shared_ptr< WmtsCapabilities sourceCapabilities = nullptr 
)
static

Creates a WMTS raster model, or returns information about why this model can not be created.

This method does not support the entire WMTS specification. The following restrictions are used:

  • The returned raster model uses KVP (Key Value Pair) or REST requests. XML is not supported.
Parameters
sourceThe structure describing the source to use for data retrieval.
optionsOptions for decoding WMTS data, e.g. an optional http client implementation to send HTTP requests when fetching WMTS resources.
sourceCapabilitiesThe source's capabilities. Can be retrieved before using WmtsCapabilities::getCapabilities and reused. If set to nullptr, will be queried internally.
Returns
either the newly created model, or error information.
Since
2023.0

◆ decode() [2/2]

static luciad::expected< std::shared_ptr< IRasterModel >, ErrorInfo > luciad::WmtsModelDecoder::decode ( const std::shared_ptr< WmtsDataSource > &  source,
std::shared_ptr< WmtsCapabilities sourceCapabilities = nullptr 
)
static

Creates a WMTS raster model, or returns information about why this model can not be created.

Parameters
sourceThe structure describing the source to use for data retrieval.
sourceCapabilitiesThe source's capabilities. Can be retrieved before using WmtsCapabilities::getCapabilities and reused. If set to nullptr, will be queried internally.
Returns
either the newly created model, or error information.