SubPathOptions

data class SubPathOptions(val searchTime: <Error class: unknown class> = 0.seconds, val searchDistance: PathSearchDistance = PathSearchDistance( maxHorizonLength = DEFAULT_MAX_HORIZON_LENGTH ))

Horizon search options for a sub-path level. 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 subscription specifies both a search time and a search distance) for a given sub-path level, the horizon engine will extend 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 will extend 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 m maximum extension length for the search distance and will extend sub-paths of that that level until both time and distance have reached the limit.

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.

searchDistance

Path search distance. maximum 200 m if the subscription does not specify a path search distance.

Throws

If searchTime is negative or searchDistance is invalid.

Constructors

Link copied to clipboard
constructor(searchTime: <Error class: unknown class> = 0.seconds, searchDistance: PathSearchDistance = PathSearchDistance( maxHorizonLength = DEFAULT_MAX_HORIZON_LENGTH ))

Types

Link copied to clipboard
object Companion

Properties

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