MSG RI ADD STOP
MSG_RI_ADD_STOP = 100
Description:
Add a stop with the given name and position (in geodecimal format) to the stop list. Please note that stops can not be added in some situations:
- During an active navigation -> please stop the navigation by using the StopNavigation message and then try again to add stops.
Attention
- The PTV Navigator will not check the plausibility of the coordinates, so for example be sure to not mix up longitude and latitude, or something similar, otherwise the route the PTV Navigator calculates will not be the desired one.
- The fields "GeoDezPosX" and "GeoDezPosY" are deprecated, use "Longitude" and "Latitude" instead.
- If both position fields are set, only the "Longitude" and "Latitude" fields will be used.
- The adding of stops is only allowed when the navigator is in the main fragment and no navigation is running.
Adding a stop will alter the current tour by adding the stop at the end of the tour. Be sure to delete all stops from a previous route calculation to ensure that only the added stops are used for routing.
Sending bundle:
| Key | Value | Type | Info |
|---|---|---|---|
| Name | Name of the stop | String | |
| MercPosX | Deprecated, use Longitude instead. Mercator x position of the stop | int | |
| MercPosY | Deprecated, use Latitude instead. Mercator y position of the stop | int | |
| GeoDezPosX | Deprecated, use Longitude instead. Geodecimal x position (longitude) of the stop | double | |
| GeoDezPosY | Deprecated, use Latitude instead. Geodecimal y position (latitude) of the stop | double | |
| Longitude | Longitude of the stop | double | |
| Latitude | Latitude of the stop | double |
Returned error codes:
- RI_ERROR_NONE if everything is ok.
- RI_ERROR_RI_DISABLED if the Remote Interface service is disabled and/or not licensed.
- RI_ERROR_NOT_INITIALIZED if the Remote Interface service is not initialized yet.
- RI_ERROR_INVALID_PARAMETER if one parameter is not valid.
- RI_ERROR_NOT_ALLOWED if the adding is not allowed in the current activity.
- RI_ERROR_NO_LICENSE if the navigator has no valid license.