RouteSheet

data class RouteSheet

This class contains a list of instructions called 'route sheet'. A route of n route elements provided by com.benomad.msdk.planner.Planner (see com.benomad.msdk.planner.route.Route) is used to build an array of m route sections (m <= n). For each route section, an instruction indicates what to do to go to next route section. Each instruction is composed of:

  • name of current route section

  • name of next route section (or name of sign post to follow)

  • a length information (length of current route section in meters)

  • a time information (time of current route section in seconds)

  • a manoeuvre type of instruction see ManeuverType

  • an instruction type see InstructionType

  • an exit instruction (only for exiting roundabouts)

    Examples :

    "BOULEVARD SAINT-GERMAIN"
    "RUE DES SAINTS-PERES"
    420
    45
    ManeuverType: RIGHT
    InstructionType: FOLLOW
    0
    Should be understood as :
    "From BOULEVARD SAINT-GERMAIN, at 420 meters (45 seconds), turn right on RUE DES SAINTS-PERES".

    "A1"
    "PARIS"
    14500
    560
    ManeuverType: SLIGHT_RIGHT
    InstructionType: FOLLOW_SIGN
    0
    Should be understood as : "From A1, at 14.5 km (9 min 20 s), follow sign 'PARIS' (slight right turn)".

    ""
    "N7"
    30
    9
    ManeuverType: RIGHT
    InstructionType: EXIT_ROUNDABOUT
    2
    Should be understood as : "From roundabout, at 30 meters (9 seconds), take 2nd exit (right turn) N7".

Properties

Link copied to clipboard

Functions

Link copied to clipboard
fun toJson(): String