Class PolylineEncodingOptionsBuilder

Namespace

PolylineAlgorithm

Assembly

PolylineAlgorithm.dll

Provides a builder for configuring options for polyline encoding operations.

public sealed class PolylineEncodingOptionsBuilder

Inheritance

object

PolylineEncodingOptionsBuilder

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Methods

Build()

Builds a new PolylineAlgorithm.PolylineEncodingOptions instance using the configured options.

public PolylineEncodingOptions Build()

Returns

PolylineEncodingOptions

A configured PolylineAlgorithm.PolylineEncodingOptions instance.

Create()

Creates a new PolylineAlgorithm.PolylineEncodingOptionsBuilder instance for the specified coordinate type.

public static PolylineEncodingOptionsBuilder Create()

Returns

PolylineEncodingOptionsBuilder

An PolylineAlgorithm.PolylineEncodingOptionsBuilder instance for configuring polyline encoding options.

WithLoggerFactory(ILoggerFactory)

Configures the ILoggerFactory to be used for logging during polyline encoding operations.

public PolylineEncodingOptionsBuilder WithLoggerFactory(ILoggerFactory loggerFactory)

Parameters

loggerFactory ILoggerFactory

The ILoggerFactory instance to use for logging. If null, a NullLoggerFactory will be used instead.

Returns

PolylineEncodingOptionsBuilder

The current PolylineAlgorithm.PolylineEncodingOptionsBuilder instance for method chaining.

WithPrecision(uint)

Sets the coordinate encoding precision.

public PolylineEncodingOptionsBuilder WithPrecision(uint precision)

Parameters

precision uint

The number of decimal places to use for encoding coordinate values. Default is 5.

Returns

PolylineEncodingOptionsBuilder

The current PolylineAlgorithm.PolylineEncodingOptionsBuilder instance for method chaining.

WithStackAllocLimit(int)

Configures the buffer size used for stack allocation during polyline encoding operations.

public PolylineEncodingOptionsBuilder WithStackAllocLimit(int stackAllocLimit)

Parameters

stackAllocLimit int

The maximum buffer size to use for stack allocation. Must be greater than or equal to 1.

Returns

PolylineEncodingOptionsBuilder

The current PolylineAlgorithm.PolylineEncodingOptionsBuilder instance for method chaining.

Remarks

This method allows customization of the internal buffer size for encoding, which can impact performance and memory usage.

Exceptions

ArgumentOutOfRangeException

Thrown if stackAllocLimit is less than 1.