SubPathSearchOptions

data class SubPathSearchOptions(val searchTime: Duration = DEFAULT_SUB_PATH_SEARCH_TIME, val searchDistance: PathSearchDistance = PathSearchDistance( maxHorizonLength = DEFAULT_MAX_HORIZON_SUB_PATH_LENGTH ))

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 DEFAULT_SUB_PATH_SEARCH_TIME for the search time and extends the 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 DEFAULT_MAX_HORIZON_SUB_PATH_LENGTH 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.

Parameters

searchTime

Path search time. DEFAULT_SUB_PATH_SEARCH_TIME if the options do not specify a path search time.

searchDistance

Path search distance. Maximum DEFAULT_MAX_HORIZON_SUB_PATH_LENGTH if horizon options do not specify a path search distance.

Throws

If search time is negative or search distance is invalid.

Constructors

Link copied to clipboard
constructor(searchTime: Duration = DEFAULT_SUB_PATH_SEARCH_TIME, searchDistance: PathSearchDistance = PathSearchDistance( maxHorizonLength = DEFAULT_MAX_HORIZON_SUB_PATH_LENGTH ))

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
Link copied to clipboard