SubPathOptions

data class SubPathOptions(val searchTime: Duration? = null, val searchDistance: Distance? = null)

Horizon search options for a sub-path level. 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 distance are non-null (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 the search time is null and the search distance is non-null 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 the search time is non-null and the search distance is null for a given sub-path level, the horizon engine will work with a default value of 0 centimeters for the search distance and will extend sub-paths of that level 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.

searchDistance

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

Throws

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

Constructors

Link copied to clipboard
fun SubPathOptions(searchTime: Duration? = null, searchDistance: Distance? = null)

Properties

Link copied to clipboard
Link copied to clipboard
val searchTime: Duration? = null