Navigation SDK Documentation

Functions

Functions

SDK_ERROR SDK_API SDK_GetMapInformation (SDK_INT4 mapHnd, SDK_MapInformation *pMapInformation)
 
SDK_ERROR SDK_API SDK_GetGlobalMapInformation (SDK_GlobalMapInformation *pGlobalMapInformation)
 
SDK_ERROR SDK_API SDK_GetMapCount (SDK_INT4 *pMapCount)
 
SDK_ERROR SDK_API SDK_GetMap (SDK_INT4 *mapHnd)
 
SDK_ERROR SDK_API SDK_AddMapPath (const SDK_WCHAR_T *mapPath, bool bRecursive, char **mapHashes, SDK_INT4 amountHashes)
 
SDK_ERROR SDK_API SDK_RemoveMapPath (const SDK_WCHAR_T *mapPath, bool bRecursive)
 
SDK_ERROR SDK_API SDK_ChangeMap (SDK_INT4 mapHnd)
 
SDK_ERROR SDK_API SDK_GetMapByPosition (const SDK_Position *pMapPos, SDK_INT4 *pMap)
 
SDK_ERROR SDK_API SDK_GetAreaLayerCount (SDK_INT4 *pCount)
 
SDK_ERROR SDK_API SDK_IsPositionInAreaLayer (const SDK_Position *pPosition, SDK_INT4 layerID, SDK_WCHAR_T const **ppLayerName, SDK_INT4 *layerStatus)
 

Detailed Description

Map management.

Function Documentation

SDK_ERROR SDK_API SDK_GetMapInformation ( SDK_INT4  mapHnd,
SDK_MapInformation pMapInformation 
)

Query information about a map.

Bug:
A couple of fields inside the SDK_MapInformation structure is not filled, if the map is currently closed.
    Get information about a map like the name, the included countries and the version. See \ref SDK_MapInformation for more details.

    \param[in] mapHnd Parameter to identify the map. (valid range from 0 to SDK_GetMapCount()-1)
    A value of -1 returns information about the current map
    \param[out] pMapInformation structure to be filled by the API (size/version fields have to be initialized already)
    \return Error code (\ref Errorcodes)  
SDK_ERROR SDK_API SDK_GetGlobalMapInformation ( SDK_GlobalMapInformation pGlobalMapInformation)

Query global information about all installed maps.

Get information if toll data is available in at least one map.

Parameters
[out]pGlobalMapInformationstructure to be filled by the API (size/version fields have to be initialized already)
Returns
Error code (Errorcodes)
SDK_ERROR SDK_API SDK_GetMapCount ( SDK_INT4 pMapCount)

Returns the number of maps which are currently under control of NavigationSDK.

Parameters
[out]pMapCountThe number of maps currently under control of NavigationSDK
Returns
Error code (Errorcodes)
SDK_ERROR SDK_API SDK_GetMap ( SDK_INT4 mapHnd)

Get the handle of the current used map.

Parameters
[out]thehandle of the current used map
Returns
Error code (Errorcodes) SDK_ERROR_OK | SDK_ERROR_NoMap
SDK_ERROR SDK_API SDK_AddMapPath ( const SDK_WCHAR_T mapPath,
bool  bRecursive,
char **  mapHashes,
SDK_INT4  amountHashes 
)

Add a map path to the SDK. The SDK will search through this directory and add all found maps to an internal list.

Parameters
[in]mapPathThe path to the map-file containing directory.
[in]bRecursiveIf true search recursive down the whole path, else just within the current directory. Defaults to false for backwards compatibility.
[in]mapHashesfor internal use only so set to 0
[in]amountHashesfor internal use only so set to 0
Returns
Error code (Errorcodes)
SDK_ERROR SDK_API SDK_RemoveMapPath ( const SDK_WCHAR_T mapPath,
bool  bRecursive 
)

Remove a map path to the SDK. The SDK will search through this directory and remove all found maps from an internal list.

Parameters
[in]mapPathThe path to the map-file containing directory.
[in]bRecursiveIf true search recursive down the whole path, else just within the current directory. Defaults to false for backwards compatibility.
Returns
Error code (Errorcodes)
SDK_ERROR SDK_API SDK_ChangeMap ( SDK_INT4  mapHnd)

Switches to another map.

Bug:
Calling this during a navigation takes place may cause the Navigation SDK to crash
\param[in] mapHnd Parameter to identify the map. (valid range from 0 to SDK_GetMapCount()-1)
\return Error code (\ref Errorcodes)  
SDK_ERROR SDK_API SDK_GetMapByPosition ( const SDK_Position pMapPos,
SDK_INT4 pMap 
)

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.

Parameters
[in]pMapPosThe (mercator) position for which the map will be searched
[out]pMapThe found map handle for the given position (>=0) or an Error code (Errorcodes)
Returns
Error code (Errorcodes)
SDK_ERROR SDK_API SDK_GetAreaLayerCount ( SDK_INT4 pCount)

Returns the number of loaded area layers.

Layers are loaded automatically during the initialization of the navigation SDK. The layers have to reside in a directory named "areas" below the application path (e.g. <AppPath>/areas/). If the areas-directory is not found, the SDK will try to find it one directory above the application path (e.g. <AppPath>/../areas/). All files ending with .area will be loaded as area layers.

Parameters
[out]pCountThe number of area layers
Returns
Error code (Errorcodes)
SDK_ERROR SDK_API SDK_IsPositionInAreaLayer ( const SDK_Position pPosition,
SDK_INT4  layerID,
SDK_WCHAR_T const **  ppLayerName,
SDK_INT4 layerStatus 
)

Checks whether the given position is inside or outside of any area contained in the given area layer.

Parameters
[in]pPositionThe position in Mercator coordinates to check
[in]layerIDThe consecutive id of the layer to check the position against. Best practice is to iterate from 0 to numberOfLayers-1 from SDK_GetAreaLayerCount
[out]ppLayerNameThe name of the area layer
[out]layerStatus1 when the position is inside of at least one area, 0 if it is outside of any area, -1 when the position could not be checked
Returns
Error code (Errorcodes)

© PTV Group 2018 Generated on Mon Dec 17 2018 21:00:19 for NavigationSDK by doxygen 1.8.8