SDK_TrafficSearchRequest Struct Reference

Data Fields
SDK_HDRINFO	size
SDK_HDRINFO	version
SDK_Position	pos
SDK_Position	targetPos
SDK_UINT4	distance
SDK_UINT4	distance2
SDK_UINT4	distance3
SDK_UINT4	radius
SDK_UINT4	radius2
SDK_UINT4	radius3
const SDK_WCHAR_T *	filter
const SDK_WCHAR_T *	filter2
const SDK_WCHAR_T *	filter3
SDK_INT4	languageCode
SDK_INT4	type

Detailed Description

Search request structure definition This struct defines the details of a search request. The distance and radius values describe the search distances in different situations. If type is set to SDK_TI_SEARCH_NORMAL, one search request will be sent to the server, if type is SDK_TI_SEARCH_COMPLEX, three requests will be sent. In complex mode, these three requests differ in the expansion of the search and the roads which will be searched for traffic. The road filtering is done by the three filter parameters. These parameters will be set internally so that in a complex search, the farer the distance is, only incidents on greater roads are searched to minimize the data volume of a search. Manually filter setting needs a knowledge of the traffic server API, so set the filters to NULL to use the internal predefined values.

There are two main scenarios:

• There is actually no route available: Traffic is searched in one or more circles around the given pos. When SDK_TI_SEARCH_NORMAL is set, only one circle search is used with the value of "radius". When SDK_TI_SEARCH_COMPLEX is used, for every given radius a search request will be started with the approriate filter.

There is a route available: When SDK_TI_SEARCH_NORMAL is set, we search in a rectangle box around the route with a diagonal size from the startpoint towards the route of "distance". This box will be extended about 5%. When SDK_TO_SEARCH_COMPLEX is set, three boxes are created, everyone like in SDK_TI_SEARCH_NORMAL, box1 with "distance", box2 with "distance2" and box3 with "distance3". The boxes will be extended with the appropriate value of the radius parameters.

The boxes and circles can be visualized by calling SDK_SetUserParam() with the first parameter set to SDK_SUP_DRAW_TRAFFIC_REQUEST_BOUNDINGS.

Traffic search request.

Field Documentation

SDK_HDRINFO size

Size of struct - for controlling

SDK_HDRINFO version

Version of struct - for controlling. Use SDK_TrafficSearchRequestVERSION

SDK_Position pos

Center position to search traffic info [merc]

SDK_Position targetPos

Optional target position for spanning a rectangle from start to target if type == SDK_TI_SEARCH_BOX

SDK_UINT4 distance

First distance [km] to search from the given point, see comment above for details

SDK_UINT4 distance2

Second distance [km] to search from the given point, see comment above for details

SDK_UINT4 distance3

Third distance [km] to search from the given point, see comment above for details

SDK_UINT4 radius

First radius [km] to search from the given point, see comment above for details

SDK_UINT4 radius2

Second radius [km] to search from the given point, see comment above for details

SDK_UINT4 radius3

Third radius [km] to search from the given point, see comment above for details

const SDK_WCHAR_T* filter

internal use only, must be set to NULL >

const SDK_WCHAR_T* filter2

internal use only, must be set to NULL >

const SDK_WCHAR_T* filter3

internal use only, must be set to NULL >

SDK_INT4 languageCode

Language code used to set the message text, see Traffic message language ISO code for details

SDK_INT4 type

Type of the search, see Traffic search modes for more details.

---

The documentation for this struct was generated from the following file:

• SDKDef.h