alchemist/it.unibo.alchemist.model.interfaces/RoutingService

RoutingService

interface RoutingService<P : Position<P>, O : RoutingServiceOptions<O>> : Serializable

A service capable to generate routes into an environment. Parametric on the Position type P and the supported RoutingServiceOptions.

Functions

allowedPointClosestTo

open fun allowedPointClosestTo(position: P): P?

Retrieves (if available) the valid point closest to position, using the default options.

abstract fun allowedPointClosestTo(position: P, options: O): P?

Retrieves (if available) the valid point closest to position with the provided options. For instance, this method could be used to find the pedestrian-allowed road closer to a highway.

parseOptions

abstract fun parseOptions(options: String): O

Creates a set of options from the provided string.

route

open fun route(from: P, to: P): Route<P>

Computes a Route a P another.

abstract fun route(from: P, to: P, options: O): Route<P>

open fun route(from: P, to: P, options: String): Route<P>

Computes a Route a P another, honoring the provided set of navigation options.

Properties

defaultOptions

abstract val defaultOptions: O

The default set of options.

Inheritors

GraphHopperRoutingService