MainPathOptions

data class MainPathOptions(val searchTime: <Error class: unknown class> = 0.seconds, val searchDistancePolicy: PathSearchDistancePolicy)

Horizon search options for the main path. The search distance policy and the search time define the extent of the paths in the horizon.

If both search time and search distance policy are provided (i.e. the subscription specifies both a search time and a search distance policy) for the main path, the horizon engine will extend the main path until both time and distance have reached their limits. If the search time is not specified, the horizon engine will work with a default value of 0 seconds for the search time and will extend the main path based on the search distance directly specified by or derived from the search policy.

Important: This is a Public Preview API. It may be changed or removed at any time.

Parameters

searchTime

Path search time. 0 seconds if the subscription does not specify a path search time.

searchDistancePolicy

Path search distance policy. It determines whether the horizon engine must search along the entire route or within a subscription-specified distance.

Throws

If the search time is negative.

Constructors

Link copied to clipboard
constructor(searchTime: <Error class: unknown class> = 0.seconds, searchDistancePolicy: PathSearchDistancePolicy)

Properties

Link copied to clipboard
val searchTime: <Error class: unknown class>