MainPathSearchOptions

data class MainPathSearchOptions(val searchTime: Duration = DEFAULT_MAIN_PATH_SEARCH_TIME, val searchDistancePolicy: PathSearchDistancePolicy)

Horizon search options for the main path. The main path is the path the user currently follows, extending along the most likely trajectory. 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 horizon options specifies both a search time and a search distance policy) for the main path, the horizon engine extends the main path until time and distance have both reached their limits. If the search time is not specified, the horizon engine will work with a default value of DEFAULT_MAIN_PATH_SEARCH_TIME 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. DEFAULT_MAIN_PATH_SEARCH_TIME if the horizon options do not specify a path search time.

searchDistancePolicy

Path search distance policy. It determines whether the horizon engine must search along the entire route (see RouteLengthPolicy) or within an explicitly specified distance (see ExplicitDistancePolicy).

Throws

If the search time is negative.

Constructors

Link copied to clipboard
constructor(searchTime: Duration = DEFAULT_MAIN_PATH_SEARCH_TIME, searchDistancePolicy: PathSearchDistancePolicy)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard