com.tomtom.sdk.routing:routing-common/com.tomtom.sdk.routing.options.calculation/AlternativeRoutesOptions

AlternativeRoutesOptions

class AlternativeRoutesOptions

Specifies options related to alternative routes.

Constructors

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
constructor(maxAlternatives: Int, alternativeType: AlternativeType? = null, minDeviationDistance: Distance? = null, minDeviationTime: Duration? = null)

Specifies options related to alternative routes.

Properties

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
val alternativeType: AlternativeType?

Whether to find only better routes or any alternative to a given reference route. Can only be used with route reconstructions.

Link copied to clipboard
val maxAlternatives: Int

Maximum number of alternative routes to generate in addition to the primary route.

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
val minDeviationDistance: Distance?

Follow the reference route for at least this distance before deviating. Can only be used with route reconstructions.

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
val minDeviationTime: Duration?

Follow the reference route for at least this travel time before deviating. Can only be used with route reconstructions.

Functions

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
fun component1(): Int
Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
fun component2(): AlternativeType?
Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
fun component3(): Distance?
Link copied to clipboard
Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
fun copy(maxAlternatives: Int = this.maxAlternatives, alternativeType: AlternativeType? = this.alternativeType, minDeviationDistance: Distance? = this.minDeviationDistance, minDeviationTime: Duration? = this.minDeviationTime): AlternativeRoutesOptions
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean

Checks whether this AlternativeRoutesOptions object is structurally equal to another object.

Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String