NavigationSDK (navigationSDK API)

java.lang.Object
- com.ptvag.navigation.sdk.NavigationSDK

```
public class NavigationSDK
extends java.lang.Object
```
Declarations of the native JNI-interfaces of the NavigationSDK-interfaces.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class NavigationSDK.UnitCategory

Nested Classes
Modifier and Type	Class and Description
`static class`	`NavigationSDK.UnitCategory`

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`SDK_GEOCONVERSION_FACTOR` The conversion factor with which coordinates which are stored in the format `CoordinateSystem.GEODEZ` are stored when stored as integral values.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static int`	`addBuddyAlert(int buddyId, int radius, BuddyAlertType alertType)` Define a buddy alert.
`static int`	`addImage(java.lang.String bitmapName, Position center)` Create an image that shall be rendered on the current map
`static void`	`addMapPath(java.io.File mapPath)` Add an additional path to search for POI data.
`static void`	`addMapPath(java.lang.String mapPath)` Add an additional path to search for map data.
`static void`	`addPOIPath(java.io.File mapPath)`
`static void`	`addPOIPath(java.lang.String addrPath)` Add an additional path to search for POI data.
`static CalculateTourResult`	`calculateTour(Tour tour, Observer observer)` Calculate a tour This method calculates the first route of a tour, generates its route trace, appends all route traces of the next stations (added with `NavigationSDK#addStationToTour(WayPoint)`, `NavigationSDK#addStationsToTour(NativeArray)` or `NavigationSDK#addSVPsToTour(NativeArray)`), and activates the guidance of the first route.
`static Result<MatchedWayPointArray>`	`calculateViaRoute(NativeArray<WayPoint> wayPoints, NativeArray<Position> viaPoints, int[] viaRadius)`
`static Result<MatchedWayPointArray>`	`calculateViaRoute(NativeArray<WayPoint> wayPoints, NativeArray<Position> viaPoints, int[] viaRadius, Observer observer)`
`static void`	`changeMap(int mapIdx)` Switches to another map.
`static BuddyAlertState`	`checkBuddyAlerts(Position center)` Check if alerts exist for the given position
`static boolean`	`checkIfTunnel(NavigationInformation navigationInformation, GPSData gpsData)` Check whether a given position is in a tunnel.
`static short`	`convertGeoHeading(int heading)` Convert a standard heading with 0 degrees at north, clockwise counting to the internal heading with 0 degrees at east, counter clockwise counting.
`static int`	`createBuddy(java.lang.String bitmapName, java.lang.String buddyName)` Create an item called buddy.
`static void`	`createGPSSimulation(java.io.File simFilePath)` Create a GPS simulation file for the most recent calculated route.
`static void`	`createGPSSimulation(java.lang.String simFileName)` Create a GPS simulation file for the most recent calculated route.
`static void`	`createRouteFromSVPPoints(int count, SVPWayPointArray svpWaypoints, long innerColor, long outerColor)` \brief Generates an internal route object based on given intermediate points which can be on- and offroad Creates an internal route object which is assembled by creating the appropriate routes (onroad/offroad) from the svp waypoints given by pSVPWaypoints.
`static void`	`deleteBuddy(int buddyId)` Delete a buddy.
`static int`	`deleteBuddyAlert(int buddyId, int buddyAlertId)` Delete buddy alert.
`static void`	`deleteImage(int imageId)` Delete image.
`static void`	`deleteImages()` Delete all images
`static void`	`destroyGeoCodeResult(long index)` Releases memory for geocoding results
`static void`	`destroyPOISearchResult(long searchRequestIndex)` Releases memory for POISearch results
`static void`	`destroySearchResult(long searchResultHandle)` Free memory for search results
`static void`	`finalizeSDK()` Release the NavigationSDK instance.
`static void`	`freeRouteTrace(Trace trace)` Destroys the route trace.
`static GeoCodeResult`	`geoCode(Address searchAddress)` Do a simple geocoding.
`static int`	`getAlternativeRouteActive()` Get the current active route alternative.
`static int`	`getAlternativeRouteCount()` Get the number of alternative routes including the default or original route.
`static SDKVersion`	`getAPIVersion()` Retrieve version of current supported major API set.
`static MapInformationResults`	`getAvailableMaps()`
`static int`	`getBuddyCount()` Get the number of buddies.
`static java.lang.String`	`getErrorDescription(SDKErrorCode errorCode)` Return description to a given error code Currently it just returns the name of the error code.
`static GeoCodeResult`	`getGeoCodeResult(long index)`
`static Result<NavigationInformation>`	`getGuidanceInformation(GPSData gpsData)` Retrieve guidance information for a position on the current routing.
`static java.lang.String`	`getLanguage()` Query the currently used language See `setLanguage(String)` about usage of language settings within the Navigation SDK.
`static java.lang.String`	`getLocalizedDistanceString(int value, boolean quantify, boolean allowNow, java.lang.String nowString, char decimalSeparator)` Query a localized string for a distance value
`static java.lang.String`	`getLocalizedDistanceString(long distanceInMeters, boolean quantify)` Get a localized string for the distanceInMeters parameter This is a shortcut for calling `getLocalizedDistanceString(long, boolean, boolean, String)` with the parameter allowNow set to false and no nowString.
`static java.lang.String`	`getLocalizedDistanceString(long distanceInMeters, boolean quantify, boolean allowNow, java.lang.String nowString)` Get a localized string for the distanceInMeters parameter This is a shortcut for calling `getLocalizedDistanceString(int, boolean, boolean, String, char)` with the separator set automatically from the system.
`static java.lang.String`	`getLocalizedUnitName(int category, boolean bigUnit)` Query the localized name of the unit defined by the current set metric
`static double`	`getLocalizedUnitValue(int category, boolean bigUnit, double value)` Query the transformed and localized value for a given unit and the currently set metric Use this to convert from kilometers to miles for example.
`static Result<LorryOptions>`	`getLorryOptions()` Retrieve the lorry settings
`static ManeuverArrow`	`getManeuverArrow(ManeuverDescription description, CrossingView crossing)` Retrieve a simplified arrow representation for the given maneuver situation
`static int`	`getManeuverCount(int listMode)` Returns the number of maneuver stop-off points of a calculated route.
`static Result<ManeuverGeneratorSettings>`	`getManeuverGeneratorSettings()` Get the maneuver generator settings.
`static Result<ManeuverDescription>`	`getManeuverPoint(int listMode, int stopOffId)` Get detailed information of a stop-off point.
`static java.lang.String`	`getManeuverText(NavigationInformation info, StringRetriever retriever)` Get the maneuver text for the current navigation situation.
`static int`	`getMapByPosition(Position pos)` Returns the map respectively to that position.
`static int`	`getMapCount()` Returns the number of maps which are currently under control of NavigationSDK.
`static Result<MapInformation>`	`getMapInformation(int mapIdx)` Returns detailed information about a map.
`static MapViewStyles`	`getMapViewStyles(int mapView)` Retrieve some settings about rendering details.
`static int`	`getMetric()` Query the metric used for Navigation/guidance information The returned values can be: 0 = Use metric system (m, km) 1 = Use miles (yd, mi) 2 = Use miles (yd, mi) suitable for USA The default metric is 0 (m, km)
`static Result<NavigationSettings>`	`getNavigationSettings()` Retrieve the navigation settings.
`static int`	`getPOIItemCount(int layerId)` Determine the number of POIs stored in a specific layer.
`static int`	`getPOILayerByName(java.lang.String layer)` Receives the id of a specific POI layer.
`static int`	`getPOILayerCount()` Determine the total number of available POI layers.
`static java.lang.String`	`getPOILayerName(int layerId)` Receives the name of a specific POI layer.
`static Result<POISearchResult>`	`getPOIResult(long searchRequestIndex, long searchResultIndex)` Get a single result row from the POIsearch result Retrieve a particular search result row from a search given by SearchRequestIndex.
`static java.lang.String`	`getProfileName(java.io.File profilePath, java.lang.String cc)`
`static Result<SearchResult>`	`getResult(int searchResultHandle, int searchResultIndex, boolean generalizePLZ)` Retrieve a particular result row.
`static int`	`getResultCount(long searchRequestIndex)` Get the result count for a particular search result identified by searchRequestIndex.
`static RouteInformation`	`getRouteInformation(int routeIndex, int alternative)` Return general information about one route of several alternative routes.
`static Result<Trace>`	`getRouteTrace()` Retrieve the route trace.
`static Result<Trace>`	`getRouteTraceAhead(boolean onlyToNextStation)` Retrieve the route trace ahead from the current position to either the next station or the end of the route.
`static Result<RouteTraces>`	`getRouteTraces()` Return the route traces of a tour or an A-B routing.
`static Result<RouteOptions>`	`getRoutingOptions()` Retrieve the routing options.
`static int`	`getTrafficDelayOnRoute(boolean completeRoute, int alternativeRouteIndex)` Get information about the traffic delay on the route (for the whole route or from the current position to the end of the route).
`static Result<TrafficResults>`	`getTrafficSearchResults()` Get the traffic results from the last traffic search.
`static void`	`initialize(java.io.File mapPath, java.lang.String mapName, java.io.File addrPath, java.io.File appPath)` Initialize the NavigationSDK.
`static void`	`initialize(java.lang.String mapPath, java.lang.String mapName, java.lang.String addrPath, java.lang.String appPath)` Initialize the NavigationSDK.
`static int`	`initMapView(android.graphics.Bitmap bitmap)` Initializes a new Mapview.
`static GeoCodeResult`	`inverseGeoCode(Position position)` Do an inverse geocoding.
`static void`	`loadRoute(java.lang.String routeFileName, TargetDescription targetDescription)` Load a saved route (.mre file).
`static void`	`loadVehicleProfile(java.io.File profilePath)`
`static Result<RoadMatchInformation>`	`matchRoad(WayPoint wayPoint)` Perform information about the current position on a road (does not require navigation context!)
`static ParseTownNameResult`	`parseTownName(java.lang.String townResultName)` Parse a town name returned by a search.
`static void`	`positionBuddy(int buddyId, Position center)` Position the buddy so it gets rendered next time.
`static void`	`positionImage(int imageId, Position center)` Position image
`static void`	`refreshTrafficTracesAndIcons(boolean showIconsOnlyOnRoute)` Refresh the traffic traces and the traffic icons on the map.
`static void`	`removeMapPath(java.io.File mapPath)` Remove an additional path to search for map data.
`static void`	`removeMapPath(java.lang.String mapPath)` Remove an additional path to search for map data.
`static void`	`removePOIPath(java.io.File mapPath)`
`static void`	`removePOIPath(java.lang.String addrPath)` remove an additional path to search for POI data.
`static void`	`removeTrafficTraces()` Remove manually the traffic traces from the last traffic search.
`static void`	`saveRoute(java.lang.String routeFileName, boolean overwrite)` Save the current existing route Currently only implemented for a single route within a single map
`static SearchResults`	`searchCrossing(SearchRequest searchRequest, int maxSearchResult, SearchResult streetDescription)` Search for all intersections of the given street Search for all streets which intersects the street from the given street result.
`static SearchResults`	`searchHouseNr(SearchRequest searchRequest, int maxResultCount, SearchResult townDescription, SearchResult streetDescription)` Search for a house number Searches for a house number.
`static POISearchResults`	`searchPOI(int layerId, POISearchRequest searchRequest, int maxSearchResult)` Searches for one or more entries in the POI database.
`static SearchResults`	`searchPostcode(SearchRequest searchRequest, int maxResultCount, boolean majorOnly, boolean oneEntryPerTown)` Searches for a town depending on the postcode.
`static SearchResults`	`searchPostcode(SearchRequest searchRequest, int maxResultCount, boolean majorOnly, boolean oneEntryPerTown, int distinctHouseNumber)` Searches for a town depending on the postcode.
`static SearchResults`	`searchStreet(SearchRequest searchRequest, int maxResultCount, SearchResult townDescription)` Searches for a street.
`static SearchResults`	`searchTown(SearchRequest request, int count)` Searches for a town.
`static SearchResults`	`searchTown(SearchRequest request, int count, boolean mergeTowns)` Searches for a town.
`static void`	`searchTrafficInformation(GeoPosition position, Observer observer)` Start an asynchronous search for traffic information with a previously set web configuration.
`static void`	`searchTrafficInformation(Position position, Observer observer)` This method provides the same functionality as `searchTrafficInformation(GeoPosition, Observer)` except that the position parameter is given in mercator coordinates instead of geodecimal coordinates.
`static void`	`setAlternativeRouteActive(int alternative)` Set the given route as the active route (use `getAlternativeRouteCount()` to get the number of alternative routes available.
`static void`	`setAutoZoomScaleMargins(int minZoomSlow2d, int minZoomFast2d, int maxZoom2d, int minZoomSlow3d, int minZoomFast3d, int maxZoom3d)`
`static void`	`setAutoZoomSpeedScales(boolean trackingMode, int[] marginalSpeeds, int[] scaleFactor2d, int[] scaleFactor3d)`
`static void`	`setAutoZoomSteppingValues(float stepOut, float stepIn)`
`static void`	`setLanguage(java.lang.String language)` Set the used language Set the used language for the names of POI layers.
`static void`	`setLorryOptions(LorryOptions lorryOptions)` Set the Lorry settings.
`static void`	`setManeuverGeneratorSettings(ManeuverGeneratorSettings maneuverSettings)` Set the maneuver generator settings.
`static void`	`setMapViewStyles(int mapView, boolean renderHouseNr, boolean renderStreetNames)` Configure some settings about rendering details.
`static void`	`setMetric(int metric)` Set the metric used for Navigation/guidance information Valid values are: 0 = Set to metric system (m, km) 1 = Set to miles (yd, mi) 2 = Set to miles (yd, mi) suitable for USA Bug: Currently there is no explicit error code being returned.
`static void`	`setNavigationSettings(NavigationSettings navigationSettions)` Set the navigation settings Note that some changes don't have effect unless a navigation is initiated by calling `loadRoute(String, TargetDescription)`, `#calculateRoute(NativeArray)` or `#prepareNavigationForTour(Observer)`.
`static void`	`setRoutingOptions(RouteOptions routeOptions)` Set the routing options
`static void`	`setTrafficSearchWebConfiguration(java.lang.String url, java.lang.String token)` Set the url and the security token for a traffic web search
`static void`	`showPOILayer(int layerId, boolean show)` Interface to activate/deactivate POI layers for rendering within the map.
`static void`	`skipCurrentTarget()` Skip the current target Sometimes the current target (stop over point) can not be reached or the client decides to go already to the next stop over point.
`static void`	`trackingMode(boolean enable, int i, int j)` Start tracking mode The tracking mode should be used if there is no need for navigation any longer.
`static int`	`transformCountryCodeToPtvCode(CountryCodeFormat sourceFormat, java.lang.String cc)`
`static java.lang.String`	`transformPtvCodeToCountryCode(CountryCodeFormat destinationFormat, int ptvCode)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SDK_GEOCONVERSION_FACTOR
```
public static int SDK_GEOCONVERSION_FACTOR
```
    The conversion factor with which coordinates which are stored in the format CoordinateSystem.GEODEZ are stored when stored as integral values.
- Method Detail
  - initialize
```
public static void initialize(java.lang.String mapPath,
                              java.lang.String mapName,
                              java.lang.String addrPath,
                              java.lang.String appPath)
                       throws NavigationException
```
    Initialize the NavigationSDK. The first call to the Navigation SDK to create an instance of NavigationSDK. In addition to setting up the Navigation SDK internally there are a number of checks done. The library itself is analyzed and the system. If there is less than 12MB of virtual memory left then SDK_ERROR_NoMem is returned. If this gets called a second time on an already initalized instance then SDK_ERROR_AlreadyInitialized is returned and the call has no effect.
    
    Parameters:
    
    mapPath - The physical path to the map files (e.g. L"c:\\map\\" or "/storage card/maps/") Don't forget the trailing path separator. Both slash and backslash are supported.
    
    mapName - The name of the map used (e.g. L"dac" or L"ita_130_eur"). Don't specify a file name with file extension here! May be empty.
    
    addrPath - Directory which contains the POI data (.dat and .opm) and the addr.uni (if available). This parameter may be NULL. Even if no path is specified the bmp/ subdirectory within the application's directory will be searched for bitmaps (.opm).
    
    Throws:
    
    NavigationException - In case the error code is neither SDKErrorCode.Ok nor SDKErrorCode.AlreadyInitialized the initialization has failed. E.g. SDKErrorCode.NoMap is being returned when there was no map to be opened, but nevertheless the SDK itself is initialized now.
  - initialize
```
public static void initialize(java.io.File mapPath,
                              java.lang.String mapName,
                              java.io.File addrPath,
                              java.io.File appPath)
                       throws NavigationException
```
    Initialize the NavigationSDK. The first call to the Navigation SDK to create an instance of NavigationSDK. In addition to setting up the Navigation SDK internally there are a number of checks done. The library itself is analyzed and the system. If there is less than 12MB of virtual memory left then SDK_ERROR_NoMem is returned. If this gets called a second time on an already initalized instance then SDK_ERROR_AlreadyInitialized is returned and the call has no effect.
    
    Parameters:
    
    mapPath - The physical path to the map files (e.g. L"c:\\map\\" or "/storage card/maps/") Don't forget the trailing path separator. Both slash and backslash are supported.
    
    mapName - The name of the map used (e.g. L"dac" or L"ita_130_eur"). Don't specify a file name with file extension here! May be empty.
    
    addrPath - Directory which contains the POI data (.dat and .opm) and the addr.uni (if available). This parameter may be NULL. Even if no path is specified the bmp/ subdirectory within the application's directory will be searched for bitmaps (.opm).
    
    Throws:
    
    NavigationException - In case the error code is neither SDKErrorCode.Ok nor SDKErrorCode.AlreadyInitialized the initialization has failed. E.g. SDKErrorCode.NoMap is being returned when there was no map to be opened, but nevertheless the SDK itself is initialized now.
  - finalizeSDK
```
public static void finalizeSDK()
                        throws NavigationException
```
    Release the NavigationSDK instance. This function deletes the instance of NavigationSDK. All resources created by the NavigationSDK are released. All manually created objects (e.g. by SearchRequests, MapViews) have to be released by the client application before. They will be invalid afterwards!
    
    Throws:
    
    NavigationException
  - getAPIVersion
```
public static SDKVersion getAPIVersion()
                                throws NavigationException
```
    Retrieve version of current supported major API set. The signature of this API remains constant across different version of the Navigation SDK!
    Returns:
    The version information of the SDK. major version
    
    1: for API prior to September 2005
    
    2: for API since September 2005
    
    3: for API since July 2006
    
    4: for API since April 2008
    
    5: for API since November 2008
    
    6: for API since March 2012
    Throws:
    
    NavigationException
  - initMapView
```
public static int initMapView(android.graphics.Bitmap bitmap)
                       throws NavigationException
```
    Initializes a new Mapview. Please note that for a regular use of the PTV Navigation SDK there should be no need to call this method directly. The display of a map should by done using the convenience class MapView. An application can contain more than one MapView. This allows to show multiple maps in one application. The MapViews are independent from each other. This means they can show different sections of a map at the same time. MapViews are memory consuming (a multiple of the amount required just for the internal bitmap representation. So watch the memory footprint and avoid creating too many unused MapViews.
    
    Parameters:
    
    bitmap - The bitmap into which to draw the map.
    
    Returns:
    
    The handle to the generated map view.
    
    Throws:
    
    NavigationException - Typical error codes are SDKErrorCode.InvalidParameter or SDKErrorCode.OutOfResources.
  - getAvailableMaps
```
public static MapInformationResults getAvailableMaps()
```
  - getMapInformation
```
public static Result<MapInformation> getMapInformation(int mapIdx)
                                                throws NavigationRuntimeException
```
    Returns detailed information about a map. Hint: A couple of fields inside the MapInformation structure is not filled, if the map is currently closed.
    
    Parameters:
    
    mapIdx - Parameter to identify the map. (valid range from 0 to getMapCount() - 1). A value of "-1" returns information about the current map
    
    Returns:
    
    Structure to be filled by the API.
    
    Throws:
    
    NavigationException - if an error occurs.
    
    NavigationRuntimeException
  - getMapByPosition
```
public static int getMapByPosition(Position pos)
                            throws NavigationException,
                                   NavigationException
```
    Returns the map respectively to that position. If there is more than a single map available for that given position, the map with the highest priority will be returned.
    
    Returns:
    
    The found map handle for the given position (>=0) or an error code.
    
    Throws:
    
    NavigationException - if an error occurs.
  - setMapViewStyles
```
public static void setMapViewStyles(int mapView,
                                    boolean renderHouseNr,
                                    boolean renderStreetNames)
                             throws NavigationException
```
    Configure some settings about rendering details. This call is not yet officially supported, especially the interface is likely to change in near future. However all the documented functionality is supposed to work.
    
    Parameters:
    
    mapView - Handle to the MapView/MapDC.
    
    renderHouseNr - Dis/enable rendering of house numbers in 2d mode. In 3d they get never rendered.
    
    renderStreetNames - Dis/enable rendering of street names in 2d mode. In 3d they get never rendered.
    
    Throws:
    
    NavigationException - if an error occurs.
  - getMapViewStyles
```
public static MapViewStyles getMapViewStyles(int mapView)
                                      throws NavigationException
```
    Retrieve some settings about rendering details. This call is not yet officially supported, especially the interface is likely to change in near future. However if an error occurs.all the documented functionality is supposed to work.
    
    Parameters:
    
    mapView - Handle to the MapView/MapDC.
    
    Returns:
    
    the MapViewStyles of the MapView/MapDC.
    
    Throws:
    
    NavigationException - if an error occurs.
  - getMapCount
```
public static int getMapCount()
                       throws NavigationRuntimeException
```
    Returns the number of maps which are currently under control of NavigationSDK.
    
    Returns:
    
    The number of available maps.
    
    Throws:
    
    NavigationException - if an error occurs.
    
    NavigationRuntimeException
  - changeMap
```
public static void changeMap(int mapIdx)
                      throws NavigationRuntimeException
```
    Switches to another map. Attention: Calling this during a navigation takes place may cause the Navigation SDK to crash
    
    Parameters:
    
    mapIdx - Parameter to identify the map. (valid range from 0 to - 1 )
    
    Throws:
    
    NavigationException - if an error occurs.
    
    NavigationRuntimeException
  - convertGeoHeading
```
public static short convertGeoHeading(int heading)
```
    Convert a standard heading with 0 degrees at north, clockwise counting to the internal heading with 0 degrees at east, counter clockwise counting.
    
    Parameters:
    
    heading - The standard heading to convert [0=north, clockwise]
    
    Returns:
    
    The internal heading [0=east, counter clockwise]
  - calculateViaRoute
```
public static Result<MatchedWayPointArray> calculateViaRoute(NativeArray<WayPoint> wayPoints,
                                                             NativeArray<Position> viaPoints,
                                                             int[] viaRadius)
                                                      throws NavigationException
```
    Throws:
    
    NavigationException
  - calculateViaRoute
```
public static Result<MatchedWayPointArray> calculateViaRoute(NativeArray<WayPoint> wayPoints,
                                                             NativeArray<Position> viaPoints,
                                                             int[] viaRadius,
                                                             Observer observer)
                                                      throws NavigationException
```
    Throws:
    
    NavigationException
  - createRouteFromSVPPoints
```
public static void createRouteFromSVPPoints(int count,
                                            SVPWayPointArray svpWaypoints,
                                            long innerColor,
                                            long outerColor)
                                     throws NavigationException
```
    \brief Generates an internal route object based on given intermediate points which can be on- and offroad Creates an internal route object which is assembled by creating the appropriate routes (onroad/offroad) from the svp waypoints given by pSVPWaypoints. An SVP point has a mercator coordinate, a direction and a type (see SVPKinds for details). The route is ready for navigation when no error occurred during the calculation. \param count - number of SVP waypoints \param svpWaypoints - array of svp points \param innerColor - Color for the inner of the offroad traces \param outerColor - Color for the outer of the offroad traces
    
    Throws:
    
    NavigationException
  - searchTown
```
public static SearchResults searchTown(SearchRequest request,
                                       int count,
                                       boolean mergeTowns)
                                throws NavigationException
```
    Searches for a town. Searches for a town depending on the name. The returned result is an iterable object. To get a single result, call SearchResults.get(int) with the appropriate index or iterate over the results in a foreach loop. The memory allocated by the API has to be freed by calling SearchResults.destroy();
    
    Parameters:
    
    request - SearchRequest that contains the information to search for. Valid parameters for the SearchKind in the SearchRequest are: SDK_SK_TOWNBYNAME for a standard town search SDK_SK_TOWNBYNAME_SORTED for sorting the result by the category (an indication of the size of a town).
    
    count - maximum number of returned results.
    
    mergeTowns - Only one entry per town will be returned.
    
    Returns:
    
    The search results as an iterable object. Call SearchResults.get(int) with the appropriate index to get a single result or iterate over the elements with a foreach loop.
    
    Throws:
    
    NavigationException - if an error occurs.
  - searchTown
```
public static SearchResults searchTown(SearchRequest request,
                                       int count)
                                throws NavigationException
```
    Searches for a town. Searches for a town depending on the name. This is a shortcut for calling searchTown with the mergeTowns parameter set to true. The returned result is an iterable object. To get a single result, call SearchResults.get(int) with the appropriate index or iterate over the results in a foreach loop. The memory allocated by the API has to be freed by calling SearchResults.destroy();
    
    Parameters:
    
    request - SearchRequest that contains the information to search for. Valid parameters for the SearchKind in the SearchRequest are: SDK_SK_TOWNBYNAME for a standard town search SDK_SK_TOWNBYNAME_SORTED for sorting the result by the category (an indication of the size of a town).
    
    count - maximum number of returned results.
    
    Returns:
    
    The search results as an iterable object. Call SearchResults.get(int) with the appropriate index to get a single result or iterate over the elements with a foreach loop.
    
    Throws:
    
    NavigationException - if an error occurs.
  - searchStreet
```
public static SearchResults searchStreet(SearchRequest searchRequest,
                                         int maxResultCount,
                                         SearchResult townDescription)
                                  throws NavigationException
```
    Searches for a street. Searches for a street depending on the name. A former SearchResult specifying a town must be available. The returned result is an iterable object. To get a single result, call SearchResults.get(int) with the appropriate index or iterate over the results in a foreach loop. The memory allocated by the API has to be freed by calling SearchResults.destroy();
    
    Parameters:
    
    searchRequest - SearchRequest that contains the information to search for. Valid parameters for the SearchKind in the SearchRequest are: SDK_SK_STREETBYNAME for a standard street search SDK_SK_STREETBYNAME_SORTED for sorting the result by the distance to the town given in the townDescription. By specifying SearchRequest.request="*" one may search for all streets within a town.
    
    maxResultCount - Number of the maximum returned results.
    
    townDescription - Existing SearchResult with town to search in.
    
    Returns:
    
    The search results as an iterable object. Call SearchResults.get(int) with the appropriate index to get a single result or iterate over the elements with a foreach loop.
    
    Throws:
    
    NavigationException - if an error occurs.
  - searchHouseNr
```
public static SearchResults searchHouseNr(SearchRequest searchRequest,
                                          int maxResultCount,
                                          SearchResult townDescription,
                                          SearchResult streetDescription)
                                   throws NavigationException
```
    Search for a house number Searches for a house number. A former SearchResult specifying a street must be available. The returned result is an iterable object. To get a single result, call SearchResults.get(int) with the appropriate index or iterate over the results in a foreach loop. The memory allocated by the API has to be freed by calling SearchResults.destroy();
    
    Parameters:
    
    searchRequest - SearchRequest that contains the information to search for. Valid parameters for the SearchKind in the SearchRequest are: SDK_SK_HNR.
    
    maxResultCount - Number of the maximum returned results. So far only single house numbers may be searched. If the result however contains a range as indicated by the name (string) the result is an explicit extrapolation of existing data. E.g. the search for the house number "11" may have the result string "3-11" to indicate that the closest match (numerically!) within the data was house number "3", there is no dataset for "11".
    
    townDescription - Existing SearchResult with town to search in.
    
    streetDescription - Existing SearchResult with street to search in.
    
    Returns:
    
    The search results as an iterable object. Call SearchResults.get(int) with the appropriate index to get a single result or iterate over the elements with a foreach loop.
    
    Throws:
    
    NavigationException - if an error occurs.
  - searchPostcode
```
public static SearchResults searchPostcode(SearchRequest searchRequest,
                                           int maxResultCount,
                                           boolean majorOnly,
                                           boolean oneEntryPerTown,
                                           int distinctHouseNumber)
                                    throws NavigationException
```
    Searches for a town depending on the postcode. The returned result is an iterable object. To get a single result, call SearchResults.get(int) with the appropriate index or iterate over the results in a foreach loop. The memory allocated by the API has to be freed by calling SearchResults.destroy();
    
    Parameters:
    
    searchRequest - SearchRequest that contains the information to search for. Valid parameters for the SearchKind in the SearchRequest are: SDK_SK_TOWNBYPOSTCODE for standard postcode search in all countries, SDK_SK_NL6POSTCODE for 6 digit postcode search in NL and SDK_SK_UK7POSTCODE for 7 digit postcode search in the UK
    
    maxResultCount - Number of the maximum returned results.
    
    majorOnly - Only major cities are considered. Only used in standard postcode search (SearchKind == SDK_SK_TOWNBYPOSTCODE)
    
    oneEntryPerTown - Only one entry per town is found. Only used in standard postcode search (SearchKind == SDK_SK_TOWNBYPOSTCODE)
    
    distinctHouseNumber - House number to get an exacter match of the results. If set to -1, all results for the given postcode will be returned. Only used for NL6 postcodes(SearchKind == SDK_SK_NL6POSTCODE), standard postcode searches will ignore the number.
    
    Returns:
    
    The search results as an iterable object. Call SearchResults.get(int) with the appropriate index to get a single result or iterate over the elements with a foreach loop.
    
    Throws:
    
    NavigationException - if an error occurs.
  - searchPostcode
```
public static SearchResults searchPostcode(SearchRequest searchRequest,
                                           int maxResultCount,
                                           boolean majorOnly,
                                           boolean oneEntryPerTown)
                                    throws NavigationException
```
    Searches for a town depending on the postcode. This is a shortcut of calling searchPostCode with distinctHouseNumber set to -1. The returned result is an iterable object. To get a single result, call SearchResults.get(int) with the appropriate index or iterate over the results in a foreach loop. The memory allocated by the API has to be freed by calling SearchResults.destroy();
    
    Parameters:
    
    searchRequest - SearchRequest that contains the information to search for. Valid parameters for searchRequest.SearchKind are: SDK_SK_TOWNBYPOSTCODE for standard postcode search in all countries, SDK_SK_NL6POSTCODE for 6 digit postcode search in NL and SDK_SK_UK7POSTCODE for 7 digit postcode search in the UK
    
    maxResultCount - Number of the maximum returned results.
    
    majorOnly - Only major cities are considered. Only used in standard postcode search (SearchKind == SDK_SK_TOWNBYPOSTCODE)
    
    oneEntryPerTown - Only one entry per town is found. Oonly used in standard postcode search (SearchKind == SDK_SK_TOWNBYPOSTCODE)
    
    Returns:
    
    The search results as an iterable object. Call SearchResults.get(int) with the appropriate index to get a single result or iterate over the elements with a foreach loop.
    
    Throws:
    
    NavigationException - if an error occurs.
  - searchCrossing
```
public static SearchResults searchCrossing(SearchRequest searchRequest,
                                           int maxSearchResult,
                                           SearchResult streetDescription)
                                    throws NavigationException
```
    Search for all intersections of the given street Search for all streets which intersects the street from the given street result. The returned result is an iterable object. To get a single result, call SearchResults.get(int) with the appropriate index or iterate over the results in a foreach loop. The memory allocated by the API has to be freed by calling SearchResults.destroy();
    
    Parameters:
    
    searchRequest - SearchRequest that contains the information to search for. Valid parameters for searchRequest.SearchKind are: SDK_SK_CROSSING
    
    maxSearchResult - Number of the maximum returned results.
    
    streetDescription - Former SearchResult with town and street to search in.
    
    Returns:
    
    The search results as an iterable object. Call SearchResults.get(int) with the appropriate index to get a single result or iterate over the elements with a foreach loop.
    
    Throws:
    
    NavigationException - if an error occurs.
  - getResult
```
public static Result<SearchResult> getResult(int searchResultHandle,
                                             int searchResultIndex,
                                             boolean generalizePLZ)
                                      throws NavigationRuntimeException
```
    Retrieve a particular result row. Retrieve a particular search result row from a search given by searchRequestIndex.
    
    Parameters:
    
    searchResultHandle - handle to the search results.
    
    searchResultIndex - Row index of the wanted result.
    
    generalizePLZ - summarize postal codes?
    
    Returns:
    
    The desired search result. if an error occurs.
    
    Throws:
    
    NavigationRuntimeException
  - destroySearchResult
```
public static void destroySearchResult(long searchResultHandle)
                                throws NavigationException
```
    Free memory for search results
    
    Parameters:
    
    searchResultHandle - handle to the search results of which to free the memory.
    
    Throws:
    
    NavigationException - if an error occurs.
  - getErrorDescription
```
public static java.lang.String getErrorDescription(SDKErrorCode errorCode)
                                            throws NavigationException
```
    Return description to a given error code Currently it just returns the name of the error code.
    
    Parameters:
    
    errorCode - Error code. See the enumeration SDKErrorCode for valid error codes.
    
    Throws:
    
    NavigationException - if an error occurs.
  - getMetric
```
public static int getMetric()
                     throws NavigationException
```
    Query the metric used for Navigation/guidance information The returned values can be: 0 = Use metric system (m, km) 1 = Use miles (yd, mi) 2 = Use miles (yd, mi) suitable for USA The default metric is 0 (m, km)
    
    Returns:
    
    the current metric.
    
    Throws:
    
    NavigationException - if an error occurs.
  - setMetric
```
public static void setMetric(int metric)
                      throws NavigationException
```
    Set the metric used for Navigation/guidance information Valid values are: 0 = Set to metric system (m, km) 1 = Set to miles (yd, mi) 2 = Set to miles (yd, mi) suitable for USA Bug: Currently there is no explicit error code being returned. If the value is invalid then the metric will automatically be set to 0 (m, km) !
    
    Parameters:
    
    metric - the current set metric
    
    Throws:
    
    NavigationException - if an error occurs.
  - getLocalizedDistanceString
```
public static java.lang.String getLocalizedDistanceString(int value,
                                                          boolean quantify,
                                                          boolean allowNow,
                                                          java.lang.String nowString,
                                                          char decimalSeparator)
                                                   throws NavigationException
```
    Query a localized string for a distance value
    
    Parameters:
    
    value - The distance in meters to convert to a well human readable string for the currently set metric
    
    quantify - Flag whether the distance should be quantified to a reasonable value for the current set metric
    
    allowNow - If set, replace the distance in case of a "now" maneuver with the string given in nowString
    
    nowString - The string to be returned if allowNow is set and we have a "now" maneuver
    
    decimalSeparator - decimal separator used for the string formatting
    
    Returns:
    
    The localized and quantified distance string
    
    Throws:
    
    NavigationException - if an error occurs.
  - getLocalizedDistanceString
```
public static java.lang.String getLocalizedDistanceString(long distanceInMeters,
                                                          boolean quantify)
```
    Get a localized string for the distanceInMeters parameter This is a shortcut for calling getLocalizedDistanceString(long, boolean, boolean, String) with the parameter allowNow set to false and no nowString.
    
    Parameters:
    
    distanceInMeters - The distance in meters to convert to a well human readable string for the currently set metric
    
    quantify - Flag whether the distance should be quantified to a reasonable value for the current set metric
    
    Returns:
  - getLocalizedDistanceString
```
public static java.lang.String getLocalizedDistanceString(long distanceInMeters,
                                                          boolean quantify,
                                                          boolean allowNow,
                                                          java.lang.String nowString)
```
    Get a localized string for the distanceInMeters parameter This is a shortcut for calling getLocalizedDistanceString(int, boolean, boolean, String, char) with the separator set automatically from the system.
    
    Parameters:
    
    distanceInMeters - The distance in meters to convert to a well human readable string for the currently set metric
    
    quantify - Flag whether the distance should be quantified to a reasonable value for the current set metric
    
    allowNow - If set, replace the distance in case of a "now" maneuver with the string given in nowString
    
    nowString - The string to be returned if allowNow is set and we have a "now" maneuver
    
    Returns:
    
    The localized and quantified distance string if an error occurs.
  - getLocalizedUnitName
```
public static java.lang.String getLocalizedUnitName(int category,
                                                    boolean bigUnit)
                                             throws NavigationException
```
    Query the localized name of the unit defined by the current set metric
    
    Parameters:
    
    category - The physical quantity. 0 for distances. 1 for heights. 2 for velocity.
    
    bigUnit - true, if "big" units (i.e. kilometers, miles) or false, if "small" units (meters, yards, feet) should be used
    
    Returns:
    
    The name of the selected unit.
    
    Throws:
    
    NavigationException - if an error occurs.
  - getLocalizedUnitValue
```
public static double getLocalizedUnitValue(int category,
                                           boolean bigUnit,
                                           double value)
                                    throws NavigationException
```
    Query the transformed and localized value for a given unit and the currently set metric Use this to convert from kilometers to miles for example. If the category is SDK_uc_LENGTH, the value is expected in meters. If the category is SDK_uc_HEIGHT, the value is expected in meters. If the category is SDK_uc_VELOCITY, the value is expected in kilometers per hour.
    
    Parameters:
    
    category - The physical quantity. 0 for distances. 1 for heights. 2 for velocity.
    
    bigUnit - true, if "big" units (i.e. kilometers, miles) or false, if "small" units (meters, yards, feet) should be used
    
    value - The value to transform and localize
    
    Returns:
    
    The localized and quantified distance string
    
    Throws:
    
    NavigationException - if an error occurs.
  - getLanguage
```
public static java.lang.String getLanguage()
                                    throws NavigationException
```
    Query the currently used language See setLanguage(String) about usage of language settings within the Navigation SDK.
    
    Returns:
    
    the language code according to ISO 639-1 (alpha-2). Note that the content of the returned pointer may change (e.g. by calling setLanguage(String)), so one should not keep references around, but copy that string.
    
    Throws:
    
    NavigationException - if an error occurs.
  - setLanguage
```
public static void setLanguage(java.lang.String language)
                        throws NavigationException
```
    Set the used language Set the used language for the names of POI layers. Prior to calling this there is no defined default language!
    
    Parameters:
    
    language - Language code according to ISO 639-1 (alpha-2) (e.g. L"de"=German, L"en"=English, L"da"=Danish, L"fr"=French). Use lower-case strings, parsing may be case-sensitive.
    
    Throws:
    
    NavigationException - if an error occurs.
  - getRoutingOptions
```
public static Result<RouteOptions> getRoutingOptions()
                                              throws java.lang.NullPointerException,
                                                     NavigationException
```
    Retrieve the routing options.
    
    Returns:
    
    the routing options
    
    Throws:
    
    java.lang.NullPointerException - if there are no routing options.
    
    NavigationException - if an error occurs.
  - setRoutingOptions
```
public static void setRoutingOptions(RouteOptions routeOptions)
                              throws NavigationException
```
    Set the routing options
    
    Parameters:
    
    routeOptions - Structure with the new routing options to set. If NULL the default routing options are restored. One may use getRoutingOptions() before calling setRoutingOptions(RouteOptions) to retrieve the default values.
    
    Throws:
    
    NavigationException - if an error occurs.
  - getLorryOptions
```
public static Result<LorryOptions> getLorryOptions()
                                            throws java.lang.NullPointerException,
                                                   NavigationException
```
    Retrieve the lorry settings
    
    Returns:
    
    the lorry settings
    
    Throws:
    
    java.lang.NullPointerException - if there are no lorry settings
    
    NavigationException - if an error occurs.
  - setLorryOptions
```
public static void setLorryOptions(LorryOptions lorryOptions)
                            throws NavigationException
```
    Set the Lorry settings.
    
    Parameters:
    
    lorryOptions - Structure to be filled with the new settings. If null the default settings are restored. One may use getLorryOptions() before calling getLorryOptions() to retrieve the default values.
    
    Throws:
    
    NavigationException - if an error occurs.
  - loadRoute
```
public static void loadRoute(java.lang.String routeFileName,
                             TargetDescription targetDescription)
                      throws NavigationException
```
    Load a saved route (.mre file). Note that a route is tied to a map and can only be loaded if the very same map is available. The same map means it's not possible to use an updated or newer one even for the same country.
    
    Parameters:
    
    routeFileName - Name of existing route file. The route will be appended to existing routes which have been calculated: #calculateRoute(NativeArray), or loaded: loadRoute(String, TargetDescription). If the file name is null, all previous routes will be discarded.
    
    targetDescription - Supply additional information about route. Maybe null.
    
    Throws:
    
    NavigationException - if an error occurs.
  - saveRoute
```
public static void saveRoute(java.lang.String routeFileName,
                             boolean overwrite)
                      throws NavigationException
```
    Save the current existing route Currently only implemented for a single route within a single map
    
    Parameters:
    
    routeFileName - file name where the route will be saved to
    
    overwrite - If true, overwrite an existing file, else return an error if the file already exists
    
    Throws:
    
    NavigationException - if an error occurs.
  - getManeuverCount
```
public static int getManeuverCount(int listMode)
                            throws NavigationException
```
    Returns the number of maneuver stop-off points of a calculated route.
    
    Parameters:
    
    listMode - ListMode The list mode of the result. Valid values are: 0 = only the navigation relevant maneuver stop-off points will be returned 1 = all maneuver stop-off points on the route will be returned
    
    Returns:
    
    Number of stop-off points or ErrorCode
    
    Throws:
    
    NavigationException - if an error occurs.
  - getManeuverPoint
```
public static Result<ManeuverDescription> getManeuverPoint(int listMode,
                                                           int stopOffId)
                                                    throws java.lang.NullPointerException,
                                                           NavigationException
```
    Get detailed information of a stop-off point.
    
    Parameters:
    
    listMode - The desired ListMode type (lmComplete or lmImportant).
    
    stopOffId - The ID of the stop-off point. The first stop-off has id=1!
    
    Returns:
    
    a Result object which holds the error code and the current results. To get the error code, call Result.getError(). To retrieve the results itself, call Result.getResult().
    
    Throws:
    
    java.lang.NullPointerException - if no ManeuverDescription-Information received
    
    NavigationException - if an error occurs.
  - createGPSSimulation
```
public static void createGPSSimulation(java.lang.String simFileName)
                                throws NavigationException
```
    Create a GPS simulation file for the most recent calculated route.
    
    Parameters:
    
    simFileName - Name of file to be created.
    
    Throws:
    
    NavigationException - if an error occurs.
  - createGPSSimulation
```
public static void createGPSSimulation(java.io.File simFilePath)
                                throws NavigationException
```
    Create a GPS simulation file for the most recent calculated route.
    
    Parameters:
    
    simFilePath - Path of file to be created.
    
    Throws:
    
    NavigationException - if an error occurs.
  - getNavigationSettings
```
public static Result<NavigationSettings> getNavigationSettings()
                                                        throws java.lang.NullPointerException,
                                                               NavigationException
```
    Retrieve the navigation settings.
    
    Returns:
    
    The structure will be filled with the current settings.
    
    Throws:
    
    java.lang.NullPointerException - if no NavigationSettings
    
    NavigationException - if an error occurs.
  - setNavigationSettings
```
public static void setNavigationSettings(NavigationSettings navigationSettions)
                                  throws NavigationException
```
    Set the navigation settings Note that some changes don't have effect unless a navigation is initiated by calling loadRoute(String, TargetDescription), #calculateRoute(NativeArray) or #prepareNavigationForTour(Observer).
    
    Parameters:
    
    navigationSettions - New settings. One may use getNavigationSettings() before calling setNavigationSettings(NavigationSettings)() to retrieve the default values.
    
    Throws:
    
    NavigationException - if an error occurs.
  - getGuidanceInformation
```
public static Result<NavigationInformation> getGuidanceInformation(GPSData gpsData)
                                                            throws NavigationException,
                                                                   java.lang.NullPointerException
```
    Retrieve guidance information for a position on the current routing. Guidance information is necessary to interpret actual routing data. Note that this call may change the currently open map within the Navigation SDK! Due to the nature of "navigation" this call may take a while to return. Especially in the case of cross-border routing and if a reroute calculation has to be performed internally. So be prepared for this, e.g. by using the callback parameter. Don't forget that the SDK is not re-entrant, during this call there is no map rendering, etc. available!
    
    Parameters:
    
    gpsData - object with actual GPS information. This argument must not be NULL! (as it was allowed in previous versions of the Navigation SDK)
    
    Returns:
    
    object that contains all relevant information of the actual routing. See NavigationInformation for more details.
    
    Throws:
    
    NavigationException - if an error occurs
    
    java.lang.NullPointerException - if no GPSData given or no result from the SDK.
  - checkIfTunnel
```
public static boolean checkIfTunnel(NavigationInformation navigationInformation,
                                    GPSData gpsData)
                             throws NavigationException,
                                    java.lang.NullPointerException
```
    Check whether a given position is in a tunnel. This method automatically activates the GPS position extrapolator if the position was detected to be in a tunnel. Note that you have to use the extrapolated coordinates stored in GPSData.getExtraPolatedPos() in the GPSData class as long as the extrapolation is active.
    
    Parameters:
    
    navigationInformation - the NavigationInformation
    
    gpsData - object with actual GPS information.
    
    Returns:
    
    whether the given position is in a tunnel.
    
    Throws:
    
    NavigationException - if an error occurred.
    
    java.lang.NullPointerException - if no GPSData or NavigationInformation
  - getRouteTrace
```
public static Result<Trace> getRouteTrace()
                                   throws NavigationException,
                                          java.lang.NullPointerException
```
    Retrieve the route trace. This function is deprecated, use getRouteTraces() instead. That call must be matched with suitable calls to freeRouteTrace(Trace) to avoid memory leaks.
    
    Returns:
    
    trace for the current route. If there's no current route an error code is returned.
    
    Throws:
    
    NavigationException - if an error occurs.
    
    java.lang.NullPointerException - if no Trace returned*
  - getRouteTraceAhead
```
public static Result<Trace> getRouteTraceAhead(boolean onlyToNextStation)
                                        throws NavigationException,
                                               java.lang.NullPointerException
```
    Retrieve the route trace ahead from the current position to either the next station or the end of the route. That call must be matched with suitable calls to freeRouteTrace(Trace) to avoid memory leaks.
    
    Parameters:
    
    onlyToNextStation - if set to true, return the trace from the current position to the next station
    
    Returns:
    
    trace for the current route. If there's no current route an error code is returned.
    
    Throws:
    
    NavigationException - if an error occurs.
    
    java.lang.NullPointerException - if no Trace returned*
  - freeRouteTrace
```
public static void freeRouteTrace(Trace trace)
                           throws NavigationException,
                                  java.lang.NullPointerException
```
    Destroys the route trace.
    
    Parameters:
    
    trace - route trace structure which had been previously set by or {@link #getRouteTraceAhead(boolean)}.
    
    Throws:
    
    NavigationException - if an error occurs
    
    java.lang.NullPointerException - if no trace was given in.
  - getRouteTraces
```
public static Result<RouteTraces> getRouteTraces()
                                          throws NavigationException
```
    Return the route traces of a tour or an A-B routing. If a tour was calculated, the traces between the different stations will be returned. If the calculation was a normal A-B routing, one trace will be returned.
    
    Returns:
    
    RouteTraces with the information of the traces and the number of traces.
    
    Throws:
    
    NavigationException - if an error occurs
  - skipCurrentTarget
```
public static void skipCurrentTarget()
                              throws NavigationException
```
    Skip the current target Sometimes the current target (stop over point) can not be reached or the client decides to go already to the next stop over point. Then one may skip that and launch the navigation to the next.
    
    Throws:
    
    NavigationException - if an error occurs.
  - trackingMode
```
public static void trackingMode(boolean enable,
                                int i,
                                int j)
                         throws NavigationException
```
    Start tracking mode The tracking mode should be used if there is no need for navigation any longer. Any internal data about navigation will be cleared. Calls to MapView.setCenter(GeoPosition) to adjust the map position result in setting the most suitable map, so there's always the best map available!. Since switching maps may not be always the intent of the user this mode can be switched off. There is no need to stop this mode prior to calculating a new route and starting navigation afterwards.
    
    Parameters:
    
    enable - If set to true activate the map tracking mode, otherwise deactivate
    
    i - reserved for future applications. Use 0 for now.
    
    j - reserved for future applications. Use 0 for now.
    
    Throws:
    
    NavigationException - if an error occurs
  - getResultCount
```
public static int getResultCount(long searchRequestIndex)
                          throws NavigationException
```
    Get the result count for a particular search result identified by searchRequestIndex.
    
    Parameters:
    
    searchRequestIndex - Index of the search.
    
    Returns:
    
    The number of search results in the search given by searchRequestIndex.
    
    Throws:
    
    NavigationException - if an error occurs.
  - parseTownName
```
public static ParseTownNameResult parseTownName(java.lang.String townResultName)
                                         throws NavigationException
```
    Parse a town name returned by a search.
    
    Parameters:
    
    townResultName - town name as returned from a suitable interface, e.g. SearchTown. That's the value found in the name field of a SearchResult
    
    Returns:
    
    the string representing the town name. The result may still contain combined major and minor entries like "Capital/Suburb". may be null!
    
    Throws:
    
    NavigationException - if an error occurs
  - geoCode
```
public static GeoCodeResult geoCode(Address searchAddress)
                             throws NavigationException
```
    Do a simple geocoding. Geocoding delivers a coordinate from the given address. Fill the Address object with the address information. The function geocodes the given address and return the index of the search result. To get the result from the returned index, call getGeoCodeResult(long). To avoid memory leaks, clear the result with GeoCodeResult.destroy()
    
    Parameters:
    
    searchAddress - address to search for.
    
    Returns:
    
    the index of the geocode result
    
    Throws:
    
    NavigationException - if an error occurs.
  - inverseGeoCode
```
public static GeoCodeResult inverseGeoCode(Position position)
                                    throws NavigationException,
                                           java.lang.NullPointerException
```
    Do an inverse geocoding. Inverse geocoding delivers a postal address for a given coordinate. Note that there is not always a precise or even unique result. Also note that this may be a very time-consuming task because a lot of data has to be looked up for inverse references. To get the result from the returned index, call getGeoCodeResult(long) To avoid memory leaks, clear the result with destroyGeoCodeResult(long)
    
    Parameters:
    
    position - position (Mercator coordinate) to be geocoded
    
    Returns:
    
    the index of the geocode result
    
    Throws:
    
    NavigationException - if an error occurs;
    
    java.lang.NullPointerException
  - getGeoCodeResult
```
public static GeoCodeResult getGeoCodeResult(long index)
                                      throws NavigationException
```
    Throws:
    
    NavigationException
  - destroyGeoCodeResult
```
public static void destroyGeoCodeResult(long index)
                                 throws NavigationException
```
    Releases memory for geocoding results
    
    Parameters:
    
    index - the index of the geocode result
    
    Throws:
    
    NavigationException - if an error occurs.
  - matchRoad
```
public static Result<RoadMatchInformation> matchRoad(WayPoint wayPoint)
                                              throws NavigationException,
                                                     java.lang.NullPointerException
```
    Perform information about the current position on a road (does not require navigation context!) This interface may be used to perform a roadmatch for the current gps position.
    
    Parameters:
    
    wayPoint - The data that is returned by a gps device. If it is NULL, road match uses the last result of getGuidanceInformation() to fill the data structure pRoadMatchInformation.
    
    Returns:
    
    The RoadMatchInformation - this data structure stores the information that is returned by this interface
    
    Throws:
    
    NavigationException - if an error occurs.
    
    java.lang.NullPointerException - if no result came back
  - addPOIPath
```
public static void addPOIPath(java.lang.String addrPath)
                       throws NavigationException
```
    Add an additional path to search for POI data.
    
    Parameters:
    
    addrPath - New search path for POI data to be added. If null then all paths are removed.
    
    Throws:
    
    NavigationException - if an error occurs.
  - addPOIPath
```
public static void addPOIPath(java.io.File mapPath)
                       throws NavigationException
```
    Throws:
    
    NavigationException
  - removePOIPath
```
public static void removePOIPath(java.lang.String addrPath)
                          throws NavigationException
```
    remove an additional path to search for POI data.
    
    Parameters:
    
    addrPath - Search path for POI data to be removed.
    
    Throws:
    
    NavigationException - if an error occured.
  - removePOIPath
```
public static void removePOIPath(java.io.File mapPath)
                          throws NavigationException
```
    Throws:
    
    NavigationException
  - addMapPath
```
public static void addMapPath(java.lang.String mapPath)
                       throws NavigationException
```
    Add an additional path to search for map data.
    
    Parameters:
    
    mapPath - New search path for map data to be added.
    
    Throws:
    
    NavigationException - if an error occurs.
  - removeMapPath
```
public static void removeMapPath(java.io.File mapPath)
                          throws NavigationException
```
    Remove an additional path to search for map data.
    
    Parameters:
    
    mapPath - Search path for map data to be removed.
    
    Throws:
    
    NavigationException - if an error occurs.
  - removeMapPath
```
public static void removeMapPath(java.lang.String mapPath)
                          throws NavigationException
```
    Remove an additional path to search for map data.
    
    Parameters:
    
    mapPath - Search path for map data to be removed.
    
    Throws:
    
    NavigationException - if an error occurs.
  - addMapPath
```
public static void addMapPath(java.io.File mapPath)
                       throws NavigationException
```
    Add an additional path to search for POI data.
    
    Parameters:
    
    mapPath - New search path for map data to be added.
    
    Throws:
    
    NavigationException - if an error occurs.
  - searchPOI
```
public static POISearchResults searchPOI(int layerId,
                                         POISearchRequest searchRequest,
                                         int maxSearchResult)
                                  throws NavigationException
```
    Searches for one or more entries in the POI database. The returned result is an iterable object. To get a single result, call POISearchResults.get(int) with the appropriate index or iterate over the results in a foreach loop. The memory allocated by the API has to be freed by calling POISearchResults.destroy().
    
    Parameters:
    
    layerId - unique (during runtime) identifier to a POI layer (see @link getPOILayerByName(String) for more details). If -1 is specified then all layers are being used. Note that this may fail if the POI data files have been generated with a goalconv.dll earlier than 2006-11-07! POIs generated by POIImporter are fine.
    
    searchRequest - a parameter of type POISearchRequest
    
    maxSearchResult - Number of the maximum returned results
    
    Returns:
    
    The search results as an iterable object. Call POISearchResults.get(int) with the appropriate index to get a single result or iterate over the elements with a foreach loop. Note: the result object has to be freed by a call of POISearchResults.destroy().
    
    Throws:
    
    NavigationException - if an error occurs.
  - getPOIResult
```
public static Result<POISearchResult> getPOIResult(long searchRequestIndex,
                                                   long searchResultIndex)
                                            throws NavigationRuntimeException,
                                                   java.lang.NullPointerException
```
    Get a single result row from the POIsearch result Retrieve a particular search result row from a search given by SearchRequestIndex.
    
    Parameters:
    
    searchRequestIndex - Index of the search result
    
    searchResultIndex - Index of the wanted result row
    
    Returns:
    
    POISearch result for the given row
    
    Throws:
    
    NavigationRuntimeException - if an error occurs.
    
    java.lang.NullPointerException - if no result from the SDK
  - destroyPOISearchResult
```
public static void destroyPOISearchResult(long searchRequestIndex)
                                   throws NavigationException
```
    Releases memory for POISearch results
    
    Parameters:
    
    searchRequestIndex - Index of the result to destroy.
    
    Throws:
    
    NavigationException - if an error occurs.
  - getPOILayerCount
```
public static int getPOILayerCount()
                            throws NavigationException
```
    Determine the total number of available POI layers. POI layers are found in the same directory as the executable and the path specified within the addrPath parameter of initialize(File, String, File, File). To each POI layer an ID between 0 and getPOILayerCount() - 1 gets assigned. Use getPOILayerName(int) and getPOIItemCount(int) to retrieve more information about the POI layer.
    
    Returns:
    
    Number of available POI layers (>=0)
    
    Throws:
    
    NavigationException - if an error occurs.
  - getPOILayerName
```
public static java.lang.String getPOILayerName(int layerId)
                                        throws NavigationException
```
    Receives the name of a specific POI layer.
    
    Parameters:
    
    layerId - The ID of the POI layer.
    
    Returns:
    
    the name of the requested layer.
    
    Throws:
    
    NavigationException - if an error occurs.
  - getPOILayerByName
```
public static int getPOILayerByName(java.lang.String layer)
                             throws NavigationException
```
    Receives the id of a specific POI layer.
    
    Parameters:
    
    layer - the name of the requested layer
    
    Returns:
    
    The ID of the POI layer..
    
    Throws:
    
    NavigationException - if an error occurs.
  - getPOIItemCount
```
public static int getPOIItemCount(int layerId)
                           throws NavigationException
```
    Determine the number of POIs stored in a specific layer.
    
    Parameters:
    
    layerId - The ID of the POI layer.
    
    Returns:
    
    The number of POIs stored in the layer.
    
    Throws:
    
    NavigationException - if an error occurs.
  - showPOILayer
```
public static void showPOILayer(int layerId,
                                boolean show)
                         throws NavigationException
```
    Interface to activate/deactivate POI layers for rendering within the map.
    
    Parameters:
    
    layerId - The ID of the POI layer.
    
    show - Use true to activate POI layer rendering on the map, false to disable
    
    Throws:
    
    NavigationException - if an error occurs.
  - createBuddy
```
public static int createBuddy(java.lang.String bitmapName,
                              java.lang.String buddyName)
                       throws NavigationRuntimeException
```
    Create an item called buddy. This buddy is an image with an optional name which may be rendered on the map. You can position the buddy on the map by calling positionBuddy(int, long). It is also possible to add alerts to it (like entering or leaving certain areas around the buddy) and to check, if the alert has been fired. If the buddy is not needed anymore, you can remove it by calling deleteBuddy(int). Creation of the buddy doesn't show it, because it initially has no position on the map. You have to call positionBuddy(int, long) once to render it.
    
    Parameters:
    
    bitmapName - Path to a bitmap.
    
    buddyName - Name of the buddy that will be displayed on the map.
    
    Returns:
    
    A unique buddy id for identification, or -1 in case of error.
    
    Throws:
    
    NavigationRuntimeException - if an error occurs.
  - positionBuddy
```
public static void positionBuddy(int buddyId,
                                 Position center)
                          throws NavigationRuntimeException
```
    Position the buddy so it gets rendered next time.
    
    Parameters:
    
    buddyId - Valid buddy id (returned formerly by a call to createBuddy(String, String).
    
    center - The coordinates of the center (Mercator).
    
    Throws:
    
    NavigationRuntimeException - if an error occurs.
  - addBuddyAlert
```
public static int addBuddyAlert(int buddyId,
                                int radius,
                                BuddyAlertType alertType)
                         throws NavigationRuntimeException
```
    Define a buddy alert. Alerts are used to recognize if a circular area around a buddy is entered or leaved. Alert types are 0 for an entering alert and 1 for a leaving alert. The status of the alert must be checked by checkBuddyAlerts(Position). The position parameter in checkBuddyAlerts(Position) is checked against the circular area around the buddy. A buddy can have multiple alerts like in-alerts at 200, 300 and 400m and out-alerts at 100 and 300m. Attention: An alert will rise only one time: When the position, given in checkBuddyAlerts(Position), switches between inside and outside the area. So, if you get a positive check from checkBuddyAlerts(Position) for a particular event, this event will not show up anymore, even if the transition situation reoccurs. You can't use an alert for checking if someone is inside or outside the radius. You only can check, if someone transits the zone. Because the alert will only rise once, you have to create a new one for this buddy if you wanted to be informed multiple times.
    
    Parameters:
    
    buddyId - Valid buddy id.
    
    radius - radius of alert
    
    alertType - Set the alertType, inside or outside
    
    Throws:
    
    NavigationRuntimeException - if an error occurs.
  - deleteBuddyAlert
```
public static int deleteBuddyAlert(int buddyId,
                                   int buddyAlertId)
                            throws NavigationRuntimeException
```
    Delete buddy alert.
    
    Parameters:
    
    buddyId - Valid buddy id.
    
    buddyAlertId - Valid buddy alert id.
    
    Throws:
    
    NavigationRuntimeException - if an error occurs.
  - checkBuddyAlerts
```
public static BuddyAlertState checkBuddyAlerts(Position center)
                                        throws NavigationRuntimeException
```
    Check if alerts exist for the given position
    
    Parameters:
    
    center - position current gps-position
    
    Returns:
    
    state of all alerts
    
    Throws:
    
    NavigationRuntimeException - if an error occurs.
  - deleteBuddy
```
public static void deleteBuddy(int buddyId)
                        throws NavigationRuntimeException
```
    Delete a buddy.
    
    Parameters:
    
    buddyId - Valid buddy id.
    
    Throws:
    
    NavigationRuntimeException - if an error occurs.
  - getBuddyCount
```
public static int getBuddyCount()
                         throws NavigationRuntimeException
```
    Get the number of buddies.
    
    Throws:
    
    NavigationRuntimeException - if an error occurs.
  - addImage
```
public static int addImage(java.lang.String bitmapName,
                           Position center)
                    throws NavigationRuntimeException
```
    Create an image that shall be rendered on the current map
    
    Parameters:
    
    bitmapName - Path to a bitmap.
    
    center - The coordinates of the center (Mercator)
    
    Returns:
    
    A unique image id, or -1 in case of error.
    
    Throws:
    
    NavigationRuntimeException - if an error occurs.
  - positionImage
```
public static void positionImage(int imageId,
                                 Position center)
                          throws NavigationRuntimeException
```
    Position image
    
    Parameters:
    
    imageId - Valid image id.
    
    center - The coordinates of the center (Mercator).
    
    Throws:
    
    NavigationRuntimeException - if an error occurs.
  - deleteImage
```
public static void deleteImage(int imageId)
                        throws NavigationRuntimeException
```
    Delete image.
    
    Parameters:
    
    imageId - Valid image id.
    
    Throws:
    
    NavigationRuntimeException - if an error occurs.
  - deleteImages
```
public static void deleteImages()
                         throws NavigationRuntimeException
```
    Delete all images
    
    Throws:
    
    NavigationRuntimeException - if an error occurs.
  - getManeuverText
```
public static java.lang.String getManeuverText(NavigationInformation info,
                                               StringRetriever retriever)
                                        throws NavigationRuntimeException
```
    Get the maneuver text for the current navigation situation. This function builds and returns a string that can be used for navigation announcements. The navigation information given will be interpreted, decoded and a corresponding sentence will be built. The function only returns a string if the current maneuver situation should be spoken, multiple identical outputs will be avoided. If the returned string is not empty, the announcement is valid and should be spoken or outputted by a player. The grammar and the localization of the strings is not done in the function itself. Instead, the getText() method is called from the given parameter retriever to get the correct grammar and sentence portions from outside the SDK. getText() will be called with the ID for the needed string when building the announcement text. This has the great advantage that no localization is needed inside the SDK, the grammar and sentences will all be declared in a separate place and the callee will return the correct portions of the sentence by the callback. The string IDs used for the sentences and the grammar can be found in SDKManeuverTextID. We have mappings for several languages, both for TTS and sound output.
    
    Parameters:
    
    info - current navigation information see NavigationInformation for more details
    
    retriever - The retriever class (must be sublcassed from StringRetriever class and must override the getText() function
    
    Returns:
    
    the current announcement string
    
    Throws:
    
    NavigationRuntimeException - if an error occurs.
  - getManeuverGeneratorSettings
```
public static Result<ManeuverGeneratorSettings> getManeuverGeneratorSettings()
                                                                      throws java.lang.NullPointerException,
                                                                             NavigationRuntimeException
```
    Get the maneuver generator settings.
    
    Throws:
    
    java.lang.NullPointerException - if there are no maneuver settings.
    
    NavigationRuntimeException - if an error occurs.
  - setManeuverGeneratorSettings
```
public static void setManeuverGeneratorSettings(ManeuverGeneratorSettings maneuverSettings)
                                         throws NavigationRuntimeException,
                                                java.lang.NullPointerException
```
    Set the maneuver generator settings.
    
    Parameters:
    
    maneuverSettings - the ManeuverGeneratorSettings
    
    Throws:
    
    NavigationRuntimeException - if an error occurred.
    
    java.lang.NullPointerException - if no ManeuverGeneratorSettings
  - setTrafficSearchWebConfiguration
```
public static void setTrafficSearchWebConfiguration(java.lang.String url,
                                                    java.lang.String token)
                                             throws NavigationRuntimeException
```
    Set the url and the security token for a traffic web search
    
    Parameters:
    
    url - The url of the traffic web service.
    
    token - The security token needed for the request.
    
    Throws:
    
    NavigationRuntimeException - if an error occurs.
  - getTrafficDelayOnRoute
```
public static int getTrafficDelayOnRoute(boolean completeRoute,
                                         int alternativeRouteIndex)
                                  throws NavigationRuntimeException
```
    Get information about the traffic delay on the route (for the whole route or from the current position to the end of the route).
    
    Parameters:
    
    completeRoute - If set to true, the delay on the whole route will be returned, otherwise, the delay from the current position on (in this case, a navigation must have been started to get the delay, if not, 0 will be returned).
    
    alternativeRouteIndex - The index of the corresponding alternative route. Set to 0 if you don't use alternative routes.
    
    Returns:
    
    The current delay on route in [s] or 0, if no route is given.
    
    Throws:
    
    NavigationRuntimeException - if an error occurs.
  - refreshTrafficTracesAndIcons
```
public static void refreshTrafficTracesAndIcons(boolean showIconsOnlyOnRoute)
                                         throws NavigationRuntimeException
```
    Refresh the traffic traces and the traffic icons on the map.
    
    Parameters:
    
    showIconsOnlyOnRoute - If set to true, only traffic incidents on the route will show an icon, otherwise all traffic icons will be shown.
    
    Throws:
    
    NavigationRuntimeException - if an error occurs.
  - removeTrafficTraces
```
public static void removeTrafficTraces()
                                throws NavigationRuntimeException
```
    Remove manually the traffic traces from the last traffic search. Traffic traces will be removed and rerendered automatically when searchTrafficInformation(GeoPosition, Observer) was executed successfully. This interface is for clearing the traces manually, for instance, if the traffic search will not be needed anymore.
    
    Throws:
    
    NavigationRuntimeException - if an error occurs.
  - searchTrafficInformation
```
public static void searchTrafficInformation(GeoPosition position,
                                            Observer observer)
                                     throws NavigationRuntimeException
```
    Start an asynchronous search for traffic information with a previously set web configuration. The search will be around the current route or around the given position, dependent if there is a current route or not. Because the search will be started in a separate thread, the function call returns immediately. An observer is used to get information if the search succeeded or not. The caller has to subclass the Observer class and override the onFinished(int error, int index) method of it to get informed when the search has finished. To show traffic traces and icons on the map, call refreshTrafficTracesAndIcons(boolean) The traffic incidents can be retrieved by calling getTrafficSearchResults()
    
    Parameters:
    
    position - The geodecimal position from where to search from (if a route is available, the search will be done around the route).
    
    observer - The onFinished() method of the observer will be called when the search has finished (must be implemented by the caller).
    
    Throws:
    
    NavigationRuntimeException - if an error occurs.
  - searchTrafficInformation
```
public static void searchTrafficInformation(Position position,
                                            Observer observer)
                                     throws NavigationRuntimeException
```
    This method provides the same functionality as searchTrafficInformation(GeoPosition, Observer) except that the position parameter is given in mercator coordinates instead of geodecimal coordinates.
    
    Parameters:
    
    position - The mercator position from where to search from.
    
    observer - See searchTrafficInformation(GeoPosition, Observer) for details
    
    Throws:
    
    NavigationRuntimeException - if an error occurs.
  - getTrafficSearchResults
```
public static Result<TrafficResults> getTrafficSearchResults()
```
    Get the traffic results from the last traffic search. The returned object includes the actual traffic results and the error code from the search Result.getError() To get the actual results as an array of TrafficSearchResults, call Result.getResult().
    
    Returns:
    
    the result of a former traffic search
    
    Throws:
    
    java.lang.NullPointerException - if there is no search result object
    
    NavigationRuntimeException - if an error occurs.
  - getRouteInformation
```
public static RouteInformation getRouteInformation(int routeIndex,
                                                   int alternative)
```
    Return general information about one route of several alternative routes. The first routes' number is 0, the next alternatives number is 1 and so on. The total number of route alternatives can be retrieved via getAlternativeRouteCount().
    
    Parameters:
    
    routeIndex - the index of the route about which to return the route information for a multi station tour. This value is ignored if no multi station tour is calculated. In the case of a multi station tour '-1' will return the accumulated route information over all routes. '0' returns the route information of the current route. '1' returns the route information of the first inactive route, '2' returns the route information of the second inactive route, and so on.
    
    alternative - the index of the route alternative. If alternative route calculation is not activated or the routeIndex parameter is not set to the current route (routeIndex == 0) this parameter will be ignored.
    
    Returns:
  - setAlternativeRouteActive
```
public static void setAlternativeRouteActive(int alternative)
```
    Set the given route as the active route (use getAlternativeRouteCount() to get the number of alternative routes available. The active route will be highlighted in the map view, while the other alternative routes will get greyed out.
    
    Parameters:
    
    alternative - The index of the alternative route to highlight.
  - getAlternativeRouteActive
```
public static int getAlternativeRouteActive()
```
    Get the current active route alternative.
    
    Returns:
    
    The index of the current alternative route.
  - getAlternativeRouteCount
```
public static int getAlternativeRouteCount()
```
    Get the number of alternative routes including the default or original route.
    
    Returns:
    
    The number of alternative routes.
  - calculateTour
```
public static CalculateTourResult calculateTour(Tour tour,
                                                Observer observer)
                                         throws CalculateTourException
```
    Calculate a tour This method calculates the first route of a tour, generates its route trace, appends all route traces of the next stations (added with NavigationSDK#addStationToTour(WayPoint), NavigationSDK#addStationsToTour(NativeArray) or NavigationSDK#addSVPsToTour(NativeArray)), and activates the guidance of the first route. This method has to be called before a navigation on a tour can be started. It also needs to be called if another station was added after the navigation on a tour was started. Calculating a tour to one or multiple stations is done by the following steps: - Optionally set the RouteOptions to the wanted values. - Create a tour with NavigationSDK#createTour(WayPoint) (this sets also the start position) - Add as many stations as wanted by calling NavigationSDK#addStationToTour(WayPoint), NavigationSDK#addStationsToTour(NativeArray) or NavigationSDK#addSVPsToTour(NativeArray). - Call this function to calculate the tour You can also use this function to calculate standard A-B routes by adding only one station with NavigationSDK#addStationToTour(WayPoint). In this case, there is also the possibility to calculate alternative routes (up to 3) by setting the routing type with RouteOptions.setRouteCalculationType(long, int) and setting the route options before calling this function. See also setAlternativeRouteActive(int), getAlternativeRouteActive(), getAlternativeRouteCount() and NavigationSDK#getAlternativeRouteInformation(int, int) When an error in the calculation of tour section occurs, the error code can be get by calling ErrorResultHandler.getError(). The tour section which caused the error can be retrieved by CalculateTourResult.getTourSection().
    
    Parameters:
    
    observer - optional progress observer
    
    Returns:
    
    CalculateTourResult
    
    Throws:
    
    CalculateTourException
  - setAutoZoomSpeedScales
```
public static void setAutoZoomSpeedScales(boolean trackingMode,
                                          int[] marginalSpeeds,
                                          int[] scaleFactor2d,
                                          int[] scaleFactor3d)
                                   throws NavigationException
```
    Parameters:
    
    trackingMode - If set to SDK_TRUE, set the tracking speeds and scales, else the navigation speeds and scales will be set
    
    marginalSpeeds - The speeds at which the scale should change
    
    scaleFactor2d - The scales for the MarginalSpeeds in 2d
    
    scaleFactor3d - The scales for the MarginalSpeeds in 3d
    
    Throws:
    
    NavigationException - if an error occurs.
  - setAutoZoomScaleMargins
```
public static void setAutoZoomScaleMargins(int minZoomSlow2d,
                                           int minZoomFast2d,
                                           int maxZoom2d,
                                           int minZoomSlow3d,
                                           int minZoomFast3d,
                                           int maxZoom3d)
                                    throws NavigationException
```
    Parameters:
    
    minZoomSlow2d - Minimum zoom level for velocities < 72 km/h in maneuver zoom (2d)
    
    minZoomFast2d - Minimum zoom level for velocities >= 72 km/h in maneuver zoom (2d)
    
    maxZoom2d - Maximum zoom level in maneuver zoom (2d)
    
    minZoomSlow3d - Minimum zoom level for velocities < 72 km/h in maneuver zoom (3d)
    
    minZoomFast3d - Minimum zoom level for velocities >= 72 km/h in maneuver zoom (3d)
    
    maxZoom3d - Maximum zoom level in maneuver zoom (3d)
    
    Throws:
    
    NavigationException - if an error occurs.
  - setAutoZoomSteppingValues
```
public static void setAutoZoomSteppingValues(float stepOut,
                                             float stepIn)
                                      throws NavigationException
```
    Parameters:
    
    stepOut - Incremental scale value for stepping out, default is 1
    
    stepIn - Incremental scale value for stepping in, default is 30
    
    Throws:
    
    NavigationException - if an error occurs.
  - getManeuverArrow
```
public static ManeuverArrow getManeuverArrow(ManeuverDescription description,
                                             CrossingView crossing)
```
    Retrieve a simplified arrow representation for the given maneuver situation
    
    Parameters:
    
    description -
    
    crossing -
    
    Returns:
  - transformCountryCodeToPtvCode
```
public static int transformCountryCodeToPtvCode(CountryCodeFormat sourceFormat,
                                                java.lang.String cc)
```
  - transformPtvCodeToCountryCode
```
public static java.lang.String transformPtvCodeToCountryCode(CountryCodeFormat destinationFormat,
                                                             int ptvCode)
```
  - loadVehicleProfile
```
public static void loadVehicleProfile(java.io.File profilePath)
```
  - getProfileName
```
public static java.lang.String getProfileName(java.io.File profilePath,
                                              java.lang.String cc)
```

Class NavigationSDK

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SDK_GEOCONVERSION_FACTOR

Method Detail

initialize

initialize

finalizeSDK

getAPIVersion

initMapView

getAvailableMaps

getMapInformation

getMapByPosition

setMapViewStyles

getMapViewStyles

getMapCount

changeMap

convertGeoHeading

calculateViaRoute

calculateViaRoute

createRouteFromSVPPoints

searchTown

searchTown

searchStreet

searchHouseNr

searchPostcode

searchPostcode

searchCrossing

getResult

destroySearchResult

getErrorDescription

getMetric

setMetric

getLocalizedDistanceString

getLocalizedDistanceString

getLocalizedDistanceString

getLocalizedUnitName

getLocalizedUnitValue

getLanguage

setLanguage

getRoutingOptions

setRoutingOptions

getLorryOptions

setLorryOptions

loadRoute

saveRoute

getManeuverCount

getManeuverPoint

createGPSSimulation

createGPSSimulation

getNavigationSettings

setNavigationSettings

getGuidanceInformation

checkIfTunnel

getRouteTrace

getRouteTraceAhead

freeRouteTrace

getRouteTraces

skipCurrentTarget

trackingMode

getResultCount

parseTownName

geoCode

inverseGeoCode

getGeoCodeResult

destroyGeoCodeResult

matchRoad

addPOIPath

addPOIPath

removePOIPath

removePOIPath

addMapPath

removeMapPath

removeMapPath

addMapPath

searchPOI

getPOIResult