Planner/com.benomad.msdk.planner.route.options/RouteOptions

RouteOptions

open class RouteOptions(val vehicle: Vehicle? = null, val routeOptim: RouteOptim = RouteOptim.FASTEST, val routeCriteria: List<RouteCriteria> = listOf(RouteCriteria.DEFAULT), var departure: Date? = Date(), val maxAlternativeRoutes: Int = 0, val useStopRoadSide: Boolean = false, val useStartAngle: Boolean = false, val avoidUTurn: Boolean = false, var withLiveTraffic: Boolean = false, val withStatisticalTraffic: Boolean = false, val startUTurnThreshold: Int = 3000)

Class containing information about what parameters should be taken into account while computing the route

Inheritors

EVRouteOptions

Constructors

RouteOptions

constructor(vehicle: Vehicle? = null, routeOptim: RouteOptim = RouteOptim.FASTEST, routeCriteria: List<RouteCriteria> = listOf(RouteCriteria.DEFAULT), departure: Date? = Date(), maxAlternativeRoutes: Int = 0, useStopRoadSide: Boolean = false, useStartAngle: Boolean = false, avoidUTurn: Boolean = false, withLiveTraffic: Boolean = false, withStatisticalTraffic: Boolean = false, startUTurnThreshold: Int = 3000)

Properties

avoidUTurn

val avoidUTurn: Boolean = false

defines if u-turn restrictions should be avoided

departure

var departure: Date?

date of the departure (default value is the current date)

maxAlternativeRoutes

val maxAlternativeRoutes: Int = 0

maximum number of alternative routes to calculate in range 0,2

routeCriteria

val routeCriteria: List<RouteCriteria>

a list of RouteCriteria that should be used while computing the route

routeOptim

val routeOptim: RouteOptim

defines what should be prioritized when computing the route

startUTurnThreshold

val startUTurnThreshold: Int = 3000

Determines, at start point or any via point for which an avoid UTurn restriction is set, the threshold (in 1/10th seconds / meters in FASTEST / SHORTEST mode) of the difference of ETA between avoiding a UTurn or not, above which UTurn is allowed. Default value is 3000 (300 seconds or 300 meters depending on route optimization mode).

useStartAngle

val useStartAngle: Boolean = false

defines if starting angle should be used

useStopRoadSide

val useStopRoadSide: Boolean = false

defines if stop waypoint road side should be used

vehicle

val vehicle: Vehicle? = null

vehicle model and status that will travel the route or null if none specified

withLiveTraffic

var withLiveTraffic: Boolean

withStatisticalTraffic

val withStatisticalTraffic: Boolean = false

Functions

toJson

open fun toJson(): String