2.2.5   Start route planning

The .in file

Attributes in [Head] section:

Type: 104
Allowed Mode: 0 (try once), 1 (try until success)
Allowed Blocking: 0 (non blocking), 1 (blocking)

Attributes in [StartRoutePlanning] section:

• LocationFrom: The location of the start stop-off point. Location can be entered in 3 formats:
  • Address: country code,zip code,town,street,house number
    e.g. D,76131,Karlsruhe,Tullastrasse,1
  • Mercator coordinates: xxxxxx,yyyyyyy
    e.g. 951215,6261940
  • Geodez-Tupel: x.xxxxxxx,y.yyyyyyyy
    e.g. 8.5545,48.9652
• CaptionFrom: The caption which appears in the stop-off point list
• LocationTo: The location of the end stop-off point. Location can be entered in 3 formats:
  • Address: country code,zip code,town,street,house number
    e.g. D,76131,Karlsruhe,Tullastrasse,1
  • Mercator coordinates: xxxxxx,yyyyyyy
    e.g. 951215,6261940
  • Geodez-Tupel: x.xxxxxxx,y.yyyyyyyy
    e.g. 8.5545,48.9652
• Vehicle: The vehicle profile. This attribute is optional.

  Vehicle	Description
  0	Fast car
  1	Slow car
  2	Pedestrian

• Optimisation: The route optimisation. This attribute is optional.

  Optimisation	Description
  -1	Don't change
  0	According to roads
  1	According to time
  2	Economical route

• SearchAddress: Output the location as an address in the .out file. 0=disabled, 1=enabled. This attribute is optional. Default is 0.
• ShowItinerary: Show the complete itinerery in the .out file. 0=Off, 1=On. This attribute is optional. Default is 1.
• ItineraryManoeuvreText: Show the manoeuvre texts in the itinerary. 0=Off, 1=On. This attribute is optional. Default is 1.
• ItineraryDuration: Show the duration from start (in seconds) in the itinerary. 0=Off, 1=On. This attribute is optional. Default is 1.
• ItineraryRoad: Show the distance from start (in meters) in the itinerary. 0=Off, 1=On. This attribute is optional. Default is 1.
• ItineraryDirection: Show the direction (in degrees) in the itinerary. 0=Off, 1=On. This attribute is optional. Default is 1.
• ItineraryCoordinates: Show the mercator coordinates in the itinerary. 0=Off, 1=On. This attribute is optional. Default is 1.

Sample .in file: This request starts a route planning and shows the itinerary without durations

[Head] Type=104 Mode=0 Blocking=0 [StartRoutePlanning] LocationFrom=938650,6271155 CaptionFrom=(RC) Map&Guide LocationTo=D,76131,Karlsruhe,Durlacher Tor, CaptionTo=(RC) Durlacher Tor Vehicle=0 Optimisation=2 ShowItinerary=1 ItineraryDuration=0

The .out file

Attributes in [StartRoutePlanning] section:

• LocationFrom: The LocationFrom attribute given in the .in file
• CaptionFrom: The CaptionFrom attribute given in the .in file
• LocationTo: The LocationTo attribute given in the .in file
• CaptionTo: The CaptionTo attribute given in the .in file
• SearchAddress: The SearchAddress attribute given in the .in file
• Vehicle: The Vehicle attribute given in the .in file
• Optimisation: The Optimisation attribute given in the .in file
• StartRoutePlanningResult: Result code

  StartRoutePlanningResult	Description
  -6	Route planning not started; Can't calculate route
  -5	Route planning not started; Application is currently in navigation mode or in option menu
  -4	Route planning not started; Stop-off point (to) not on map
  -3	Route planning not started; Stop-off point (to) not found
  -2	Route planning not started; Stop-off point (from) not on map
  -1	Route planning not started; Stop-off point (from) not found
  1	Route planning started

• LocationFromMercator: Mercator coordinates of the start stop-off point
• LocationFromGeodecimal: Geographical coordinates of the start stop-off point
• LocationFromAddress: Address of the start stop-off point
• LocationToMercator: Mercator coordinates of the end stop-off point
• LocationToGeodecimal: Geographical coordinates of the end stop-off point
• LocationToAddress: Address of the end stop-off point
• NumberOfManoeuvres: Number of manoeuvres from start to end
• TotalDuration: The estimated duration to get from start to end in seconds
• TotalRoad: The distance from start to end in meters
• A separate section is created for each manoeuvre in the itinerary. The section names are sequentially named starting with 1, e.g. manoeuvre ones' section is named [Station_1] ....
  Attributes in [Station_i] section:
  • ManoeuvreText: A textual description of the manoeuvre for this stop-off point
  • Road: Distance from start to this stop-off point in meters
  • Duration: Estimated duration from start to this stop-off point in seconds
  • Direction: The actual direction in degrees
  • Coordinates: The mercator coordinates for this stop-off point

Sample .out file: The route planning started succesfully

[Head] Type=104 TypeDesc=start route planning Mode=0 ModeDesc=try once Blocking=0 BlockingDesc=not blocking Timestamp=945743875 Id=945743843 Result=2 ResultDesc=success and request deleted ExecuteDuration=531 [StartRoutePlanning] LocationFrom=938650,6271155 CaptionFrom=(RC) Map&Guide LocationTo=D,76131,Karlsruhe,Durlacher Tor, CaptionTo=(RC) Durlacher Tor SearchAddress=0 Vehicle=0 Optimisation=2 StartRoutePlanningResult=1 StartRoutePlanningResultDesc=route planning started LocationFromMercator=938650,6271155 LocationFromGeodecimal=+8.441482,+49.019555 LocationFromAddress=,,,, LocationToMercator=935900,6269380 LocationToGeodecimal=+8.416751,+49.009086 LocationToAddress=,,,, NumberOfManoeuvres=9 TotalDuration=294 TotalRoad=2384 [station_1] ManoeuvreText=Continue Road=0 Direction=-90 Coordinates=938555,6271205 [station_2] ManoeuvreText=Turn right Road=146 Direction=0 Coordinates=938755,6271105 [station_3] ManoeuvreText=Turn left into Hirtenweg Road=341 Direction=218 Coordinates=938530,6270910 [station_4] ManoeuvreText=Turn left into Haid-und-Neu-Straße Road=359 Direction=-21 Coordinates=938555,6270900 [station_5] ManoeuvreText=Keep driving straight ahead Road=1825 Direction=194 Coordinates=936645,6269785 [station_6] ManoeuvreText=Keep left on Karl-Wilhelm-Straße Road=2204 Direction=180 Coordinates=936150,6269495 [station_7] ManoeuvreText=keep right on Adenauerring Road=2337 Direction=243 Coordinates=935980,6269435 [station_8] ManoeuvreText=Turn right into Durlacher Tor Road=2384 Direction=233 Coordinates=935940,6269380 [station_9] ManoeuvreText=You have reached your destination! Road=2384 Direction=180 Coordinates=935900,6269380