MainPathSearchOptions
Horizon search options for the main path.
These options specify the search distance policy and the search time 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 main path.
To specify horizon options for the main path, create an instance of this class:
val mainPathSearchOptions = MainPathSearchOptions(
searchTime = 10.minutes,
searchDistancePolicy = ExplicitDistancePolicy(
searchDistance = PathSearchDistance(
maxHorizonLength = Distance.kilometers(5)
)
)
)For more information on horizon paths see HorizonEngine.
For more information on horizon options see HorizonOptions.
The search distance policy determines whether the horizon engine must search along the entire route (see RouteLengthPolicy) or within an explicitly specified distance (see ExplicitDistancePolicy).
The main path will be extended until search time and search distance have both reached their limits.
Throws
if searchTime is negative.
Constructors
Horizon search options for the main path.
Properties
The minimum length of the horizon ahead for which a horizon snapshot update is triggered. If the distance between the vehicle and the end of the horizon snapshot since the last snapshot update is less than this value, the client will receive a new horizon snapshot.
Path search distance policy. The default value is ExplicitDistancePolicy with PathSearchDistance.maxHorizonLength set to DEFAULT_MAIN_PATH_MAX_HORIZON_LENGTH.
Path search time. The default value is DEFAULT_MAIN_PATH_SEARCH_TIME.