TMC Functions

Functions
SDK_ERROR SDK_API	SDK_TMCSetDataPath (const SDK_WCHAR_T *pTMCDataPath)
SDK_ERROR SDK_API	SDK_TMCSetTuningMode (SDK_INT2 frequency, SDK_INT4 mode)
SDK_ERROR SDK_API	SDK_TMCGetTuningMode (SDK_INT2 *pFrequency, SDK_INT4 *pMode)
SDK_ERROR SDK_API	SDK_TMCSetStationFilter (SDK_UINT4 countryFilter, SDK_UINT4 ltnFilter)
SDK_ERROR SDK_API	SDK_TMCGetStationInfo (SDK_TMCRadioStationInfo *pStation)
SDK_ERROR SDK_API	SDK_TMCSetDefaultStatus (SDK_UINT4 status)
SDK_ERROR SDK_API	SDK_TMCSetEventStatus (SDK_TMCEvent *pEvent, SDK_UINT4 state)
SDK_ERROR SDK_API	SDK_TMCGetEvent (SDK_UINT4 statefilter, SDK_INT4 lastUniqueId, SDK_TMCEvent *pEvent)
SDK_ERROR SDK_API	SDK_TMCRenderEventsInMap (SDK_INT4 MapView, SDK_BOOL bEnable)

Detailed Description

Functions for TMC. Only available under Win32 and WinCE on devices that supports special TMC hardware.

Function Documentation

SDK_ERROR SDK_API SDK_TMCSetDataPath

(

const SDK_WCHAR_T *

pTMCDataPath

)

Configure path for TMC databases.

Set the patch for loading the map-independent TMC databases (*.cz). If not called the standard path (L"./tmc") is being used. It has to be called before any loading of the TMC databases may occur, probably right after initializing the SDK.

Parameters

[in]

pTMCDataPath

Path to the directory which holds the TMC databases delivered with the Navigation SDK (*.cz). Use a trailing slash (L'/') or backslash (L'\'). Supply NULL to restore the default value.

Returns

Error code (Errorcodes)

SDK_ERROR SDK_API SDK_TMCSetTuningMode	(	SDK_INT2	frequency,
		SDK_INT4	mode
	)

Control TMC tuning mode.

Parameters

[in]	frequency	[100 kHz] For suitable tuning modes (e.g. 2) use any value >0 to start search by scanning frequencies upwards, and any value <0 to scan downwards
[in]	mode	Tuning mode 0 default, automatic tuning mechanism. That should be used unless there's strong indication to use other modes! 1 fixed frequency 2 down-/upward according to a second parameter

Returns

Error code (Errorcodes)

SDK_ERROR SDK_API SDK_TMCGetTuningMode	(	SDK_INT2 *	pFrequency,
		SDK_INT4 *	pMode
	)

Get info about TMC tuning mode.

Parameters

[out]	pFrequency	[100 kHz]. See SDK_TMCSetTuningMode() for details. For suitable tuning modes (e.g. 2) use any value >0 to start search by scanning frequencies upwards, and any value <0 to scan downwards
[out]	pMode	Tuning mode. See SDK_TMCSetTuningMode() for details.

Returns

Error code (Errorcodes).

SDK_ERROR SDK_API SDK_TMCSetStationFilter	(	SDK_UINT4	countryFilter,
		SDK_UINT4	ltnFilter
	)

Set a filter for RDS TMC stations.

Set a filter for RDS TMC stations

Parameters

[in]	countryFilter	country code filter. Use the official TMC country code, see primary and secondary country code in ptv-proprietary TMC country codes
[in]	ltnFilter	location table filter. Use the location table number for the given country or chosen provider

Returns

Error code (Errorcodes)

SDK_ERROR SDK_API SDK_TMCGetStationInfo

(

SDK_TMCRadioStationInfo *

pStation

)

Query info about current FM/RDS station.

Query info about current FM/RDS station.

Parameters

[out]

pStation

Structure to be filled

Returns

Error code (Errorcodes)

SDK_ERROR SDK_API SDK_TMCSetDefaultStatus

(

SDK_UINT4

status

)

Assign a default status for all new TMC events. Assign a default status for all new TMC events. E.g. tell the SDK to consider all events by default, so that the application doesn't have to care about it.

Parameters

[in]

status

new default status value, see SDK_TMCEvent::state

Returns

Error code (Errorcodes)

SDK_ERROR SDK_API SDK_TMCSetEventStatus	(	SDK_TMCEvent *	pEvent,
		SDK_UINT4	state
	)

Set status for a single TMC event Set the event status, whether an event should be considered for navigation/routing or not. Will take effect upon the next call to SDK_GetGuidanceInformation().

Parameters

[in,out]	pEvent	Pointer to TMC event structure
[in]	state	state flag to be set

Returns

Error code (Errorcodes)

SDK_ERROR SDK_API SDK_TMCGetEvent	(	SDK_UINT4	statefilter,
		SDK_INT4	lastUniqueId,
		SDK_TMCEvent *	pEvent
	)

Retrieve a single tmc event.

This call can be used to retrieve TMC events

Parameters

[in]	statefilter	Retrieve only events with state equal statefilter as of SDK_TMCEvent::state Use 0 to list all events
[in]	lastUniqueId	Used as an anchor. Use 0 to start retrieving
[out]	pEvent	Pointer to event to be modified

Returns

Error code (Errorcodes). SDK_Error_NoMoreTMCEvents indicates that the last available event was retrieved

SDK_ERROR SDK_API SDK_TMCRenderEventsInMap	(	SDK_INT4	MapView,
		SDK_BOOL	bEnable
	)

Toggle rendering of TMC events in map.

(de) activate rendering of tmc events (traces) in a specific mapview

Parameters

[in]	MapView	Handle to the MapView
[in]	bEnable	SDK_TRUE to enable, SDK_FALSE to disable

Returns

Error code (Errorcodes)