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

RouteOptim

enum RouteOptim : Enum<RouteOptim>

Enumeration representing what optimization criteria will be prioritized when routes will be computed

Entries

FASTEST

Optimizes routes to find the fastest ones

SHORTEST

Optimizes routes to find the shortest ones

ECO

Optimizes routes to find the most economical ones in terms of energy consumption. When using this method, a maximum speed will be defined in Route.maxSpeedEta and must be respected

Types

Companion

object Companion

Properties

entries

val entries: EnumEntries<RouteOptim>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

val name: String

ordinal

val ordinal: Int

Functions

getValue

fun getValue(): Int

valueOf

fun valueOf(value: String): RouteOptim

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<RouteOptim>

Returns an array containing the constants of this enum type, in the order they're declared.