MainPathOptions

data class MainPathOptions(val searchTime: Duration? = null, val searchDistancePolicy: PathSearchDistancePolicy? = null)

Horizon search options for the main path. Search options, such as the search distance and the search time, define the extent of the paths in the horizon.

If both search time and search policy are non-null (i.e. the subscription specifies both a search time and a search distance) 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 null and the search policy is not null, 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.

If the search time is non-null and the search policy is null, the horizon engine will work with a default value of 0 centimeters for the search distance and will extend the main path based on the search time.

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

Parameters

searchTime

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

searchDistancePolicy

Path search policy. It determines whether the horizon engine must search along the entire route or within a subscription-specified distance. Null if the subscription does not specify a path search policy.

Throws

If both the search time and the search distance policy are null or if the search time is negative.

Constructors

Link copied to clipboard
fun MainPathOptions(searchTime: Duration? = null, searchDistancePolicy: PathSearchDistancePolicy? = null)

Properties

Link copied to clipboard
val searchTime: Duration? = null