Navigation SDK Documentation
|SDK_ERROR SDK_API||SDK_OpenGPSDevice (const SDK_GPSConfig *pGPSConfig, SDK_INT4 *pAddInfo)|
|SDK_ERROR SDK_API||SDK_QueryGPSDevice (SDK_GPSData *pGPSData, SDK_INT4 *pAddInfo)|
|SDK_ERROR SDK_API||SDK_PushNMEA (const SDK_CHAR_T *pNMEAData)|
|SDK_ERROR SDK_API||SDK_SetLocation (const SDK_GPSData *gpsData)|
|SDK_ERROR SDK_API||SDK_GetSatelliteInfo (SDK_INT4 index, SDK_BOOL bInView, SDK_GPSSatInfo *pSatelliteInfo)|
|SDK_ERROR SDK_API||SDK_CloseGPSDevice ()|
Functions for GPS.
|SDK_ERROR SDK_API SDK_OpenGPSDevice||(||const SDK_GPSConfig *||pGPSConfig,|
Open GPS (and TMC) device.
Open GPS and TMC devices so that data may be retrieved.
Any TMC functionality requires the suitable gpstmc.dll to be in the current/application's directory, or in libpath. Otherwise SDK_ERROR_MissingComponent is being returned.
This call may take a few seconds because of a) verifying that a valid device is attached, b) loading new (language) databases for TMC. It's important to evaluate the return values of this API before calling SDK_QueryGPSDevice().
|[in]||pGPSConfig||pointer to configuration struct to hold all information about the GPS device to be opened. See SDK_GPSConfig for information about the various configuration options.|
|[out]||pAddInfo||If given it may be filled with additional information about the status of the GPS device. Those values are not documented but should be used for bug reports.|
|SDK_ERROR SDK_API SDK_QueryGPSDevice||(||SDK_GPSData *||pGPSData,|
Query GPS device for data.
|[out]||pGPSData||pointer to structure to be filled with current GPS information|
|[out]||pAddInfo||If given it may be filled with additional information about the status of the GPS device. Those values are not documented but should be used for bug reports and help the vendor in analyzing GPS/TMC problems.|
|SDK_ERROR SDK_API SDK_PushNMEA||(||const SDK_CHAR_T *||pNMEAData||)|
Feed NMEA data to Navigation SDK.
By feeding (continuous) NMEA data the Navigation SDK is able to parse it and supply all relevant information via subsequent calls to SDK_QueryGPSDevice(). To use this call the device must be configured in "passive mode", check out the documentation for SDK_OpenGPSDevice() and SDK_GPSConfig.
|[in]||pNMEAData||Valid excerpt of NMEA data. It doesn't have to be a complete sentence and can be trucated anywhere in the data stream. But it shall be a part of a proper NMEA data stream.|
|SDK_ERROR SDK_API SDK_SetLocation||(||const SDK_GPSData *||gpsData||)|
Set the current location directly. The location is given as SDK_GPSData structure.
This interface is mainly used if the operating system provides some kind of location manager and you want to use this location data directly. To use this call the device must be configured in "passive mode", and the SDK_OpenGPSDevice has to be called with a SDK_GPSConfig structure for which the member useLocationDirectly is set to true. Otherwise the wrong type of Gps provider will be used.
|[in]||gpsData||The current location as SDK_GPSData data structure.|
|SDK_ERROR SDK_API SDK_GetSatelliteInfo||(||SDK_INT4||index,|
Query detail information about satellite info.
This interface returns information about a satellite currently in view.
|[in]||index||The number of the satellite to retrieve info for.|
|[in]||bInView||If true, return satellite in view with given index. If false, return satellite with given index that is used for gps position.|
|[out]||pSatelliteInfo||Holds the pointer to the returned SDK_GPSSatInfo|
|SDK_ERROR SDK_API SDK_CloseGPSDevice||(||)|
Close GPS (and TMC) device.
After the GPS (TMC) device has been closed no more access to those devices via SDK_QueryGPSDevice() is possible. Application programmers may want to store the last position information just before calling this.
|© PTV Group 2019||Generated on Thu Mar 28 2019 02:27:02 for NavigationSDK by 1.8.8|