LuciadCPillar C# 2024.0.04
Luciad.Formats.MbTiles.MbTilesModelDecoderOptions.Builder Class Reference

Builder for the MBTiles options. More...

Inheritance diagram for Luciad.Formats.MbTiles.MbTilesModelDecoderOptions.Builder:

Public Member Functions

 Builder (Luciad.Formats.MbTiles.MbTilesModelDecoderOptions.Builder other)
 
Luciad.Formats.MbTiles.MbTilesModelDecoderOptions Build ()
 Builds the options for the MBTiles model decoder. More...
 
void Dispose ()
 
Luciad.Formats.MbTiles.MbTilesModelDecoderOptions.Builder FeatureIdProperty (string featureIdProperty)
 Sets a property to be used as feature id, to identify and associate features belonging to the same object together. More...
 
Luciad.Formats.MbTiles.MbTilesModelDecoderOptions.Builder HttpClient (Luciad.Net.Http.IHttpClient httpClient)
 Sets the http client to be used for fetching the data. More...
 
Luciad.Formats.MbTiles.MbTilesModelDecoderOptions.Builder MbTilesType (Luciad.Formats.MbTiles.MbTilesType mbTilesType)
 Sets the MBTiles type. More...
 

Detailed Description

Builder for the MBTiles options.

Since
2024.0

Constructor & Destructor Documentation

◆ Builder()

Luciad.Formats.MbTiles.MbTilesModelDecoderOptions.Builder.Builder ( Luciad.Formats.MbTiles.MbTilesModelDecoderOptions.Builder  other)
inline

Member Function Documentation

◆ Build()

Luciad.Formats.MbTiles.MbTilesModelDecoderOptions Luciad.Formats.MbTiles.MbTilesModelDecoderOptions.Builder.Build ( )
inline

Builds the options for the MBTiles model decoder.

Returns
the options for the MBTiles model decoder.
Exceptions
System.InvalidOperationExceptionWhen not all mandatory parameters are set.

◆ Dispose()

void Luciad.Formats.MbTiles.MbTilesModelDecoderOptions.Builder.Dispose ( )
inline

◆ FeatureIdProperty()

Luciad.Formats.MbTiles.MbTilesModelDecoderOptions.Builder Luciad.Formats.MbTiles.MbTilesModelDecoderOptions.Builder.FeatureIdProperty ( string  featureIdProperty)
inline

Sets a property to be used as feature id, to identify and associate features belonging to the same object together.

Calling this function is optional.

If not set, and an "id" property exists in the data, the "id" property is used. If not set but no "id" property exists in the data, a new id is generated per feature.

Parameters
featureIdPropertythe property to be used as feature id.
Returns
this builder.

◆ HttpClient()

Luciad.Formats.MbTiles.MbTilesModelDecoderOptions.Builder Luciad.Formats.MbTiles.MbTilesModelDecoderOptions.Builder.HttpClient ( Luciad.Net.Http.IHttpClient  httpClient)
inline

Sets the http client to be used for fetching the data.

Calling this function is optional.

See related article for an example on how to customize HTTP requests when loading data.

Parameters
httpClientHTTP client implementation to fetch the MBTiles resources. When null the decoder uses its own HTTP client.
Returns
this builder.

◆ MbTilesType()

Luciad.Formats.MbTiles.MbTilesModelDecoderOptions.Builder Luciad.Formats.MbTiles.MbTilesModelDecoderOptions.Builder.MbTilesType ( Luciad.Formats.MbTiles.MbTilesType  mbTilesType)
inline

Sets the MBTiles type.

Calling this function is optional.

This method can be used to enforce the expected MBTiles type when the source metadata does not contain sufficient information to determine it.

Parameters
mbTilesTypethe MBTiles type.
Returns
this builder.