SubPathSearchOptions

public struct SubPathSearchOptions

Horizon search options for a sub-path level. Sub-path level - the number of times the driver would have to deviate from the main path to reach a particular sub-path. Search distance and the search time, define the extent of the paths in the horizon. If both search time and search distance are specified (i.e., the horizon options specify both a search time and a search distance) for a given sub-path level, the horizon engine extends horizon sub-paths of that level until both time and distance have reached the limit. If only the search distance is specified for a given sub-path level, the horizon engine will work with a default value of 0 seconds for the search time and extends sub-paths of that level based on the search distance. If only the search time is specified for a given sub-path level, the horizon engine will work with a default value of 200 meters maximum extension length for the search distance and extends sub-paths of that level until both the time and distance reach the limit.

Important

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

Public

  • Path search time. 0 seconds if the options do not specify a path search time.

    Declaration

    Swift

    public let searchTime: Measurement<UnitDuration>
  • Path search distance. Maximum 200 m if horizon options do not specify a path search distance.

    Declaration

    Swift

    public let searchDistance: PathSearchDistance