Package-level declarations

Types

Link copied to clipboard

Policy that defines a search distance for the main path.

Link copied to clipboard

Interface to a Virtual Horizon engine.

Link copied to clipboard
class HorizonOptions(val elementTypes: List<HorizonElementType>, val mainPathSearchOptions: MainPathSearchOptions = MainPathSearchOptions(), val subPathSearchOptions: List<SubPathSearchOptions> = listOf(), val numberOfPaths: Int = DEFAULT_NUMBER_OF_PATHS)

Horizon configuration options.

Link copied to clipboard
class HorizonPath(val pathId: Int, val parentPathId: Int, val offsetOnParentPath: Distance?, val geometry: List<PathGeometryElement>, elements: Map<HorizonElementType, List<HorizonElement>>)

Path in the horizon. The length of the path as well as which types of horizon elements it contains are determined by the set of horizon options for which horizon data was generated. For information on how to manage horizon options see HorizonEngine.registerHorizonOptions and HorizonEngine.unregisterHorizonOptions.

Link copied to clipboard
class HorizonPosition(val pathId: Int, val offset: Distance, val isOnRoad: Boolean, val location: GeoLocation)

The best map-matched position on the horizon. It can be either on-road or off-road. If off-road, it can be either:

Link copied to clipboard
class HorizonResult(val options: HorizonOptions, val snapshot: HorizonSnapshot, val position: HorizonPosition)

Output of the horizon engine, consisting of:

Link copied to clipboard
class HorizonSnapshot(val paths: List<HorizonPath>, val state: HorizonSnapshotState, mainPathId: Int?)

Snapshot of the horizon provided by the horizon engine for a set of registered horizon options. These options define the extent of the paths on the horizon and which map attributes are collected for those paths.

Link copied to clipboard
class HorizonSnapshotState(val updateCounter: Int)

State of the horizon snapshot that the horizon engine generates based on a set of registered options.

Link copied to clipboard
class MainPathSearchOptions(val searchTime: Duration = DEFAULT_MAIN_PATH_SEARCH_TIME, val searchDistancePolicy: PathSearchDistancePolicy = ExplicitDistancePolicy( searchDistance = PathSearchDistance( maxHorizonLength = DEFAULT_MAIN_PATH_MAX_HORIZON_LENGTH ) ))

Horizon search options for the main path.

Link copied to clipboard
class PathSearchDistance(val maxHorizonLength: Distance)

Horizon path search distance configuration.

Link copied to clipboard

Interface to the path search policy.

Link copied to clipboard

Policy that binds the horizon path to the entire route.

Link copied to clipboard
class SubPathSearchOptions(val searchTime: Duration = DEFAULT_SUB_PATH_SEARCH_TIME, val searchDistance: PathSearchDistance = PathSearchDistance( maxHorizonLength = DEFAULT_SUB_PATH_MAX_HORIZON_LENGTH ))

Horizon search options for a sub-path level.