C++ SDK
ApplicationApi.h
1 /*
2 ApplicationApi.h
3 */
4 #pragma once
5 #ifndef __API_H__
6 #define __API_H__
7 
8 
9 #ifdef _WINDOWS
10 #if defined(_LIBDLL)
11 #include <Library.h>
12 #define SDK_API _declspec(dllexport)
13 #else
14 #define SDK_API _declspec(dllimport)
15 #endif
16 #else
17 #if defined(_NOEXPORT)
18 #include <Library.h>
19 #endif
20 #define SDK_API
21 #endif
22 
23 #ifdef _WIN32_WCE
24 typedef void (_cdecl *APPLICATION_HANDLEPROC)(int nEvent, void* pData);
25 #elif defined _WIN32
26 typedef void (_stdcall *APPLICATION_HANDLEPROC)(int nEvent, void* pData);
27 #else
28 typedef void (*APPLICATION_HANDLEPROC)(int nEvent, void* pData);
29 
30 typedef int BOOL;
31 typedef int INT;
32 typedef unsigned long DWORD;
33 typedef long LONG;
34 typedef unsigned char BYTE;
35 typedef char CHAR;
36 typedef unsigned short WORD;
37 typedef short SHORT;
38 typedef double DOUBLE;
39 typedef unsigned int UINT;
40 typedef unsigned short USHORT;
41 typedef void* LPVOID;
42 typedef wchar_t WCHAR;
43 typedef WCHAR TCHAR;
44 typedef WCHAR TCHAR;
45 typedef TCHAR* LPTSTR;
46 typedef const TCHAR* LPCTSTR;
47 typedef void* HWND;
48 
49 #ifndef MAXLONG
50 #define MAXLONG ((LONG)0x7fffffff)
51 #endif
52 #ifndef NULL
53 #define NULL 0
54 #endif
55 #ifndef TRUE
56 #define TRUE 1
57 #endif
58 #ifndef FALSE
59 #define FALSE 0
60 #endif
61 
62 #endif
63 
64 
65 #define TRUCK_VERSION
66 
67 #define DEFAULT_MAX_TIME 0
68 
74 #define EVENT_APP_STARTED 1010
75 
76 #define EVENT_EXIT 1100
77 
78 #define EVENT_APP_CLOSED 1100
79 
80 #define EVENT_ROUTE_USERCANCEL 1101
81 
84 #define EVENT_WAIPOINT_VISITED 1102
85 
88 #define EVENT_WAYPOINT_VISITED 1102
89 
90 #define EVENT_ROUTE_FINISH 1103
91 
92 #define EVENT_ROUTE_COMPUTED 1105
93 
96 #define EVENT_OPTIMIZATION_FINISHED 1107
97 
98 #define EVENT_ROUTE_RECOMPUTE 1106
99 
100 #define EVENT_ITINERARY_CHANGED 1108
101 
102 #define EVENT_ITINERARY_WARNING 1109
103 
105 #define EVENT_NEXT_INSTRUCTION 1110
106 
110 #define EVENT_INVISIBLE_WAYPOINT_VISITED 1111
111 
113 #define EVENT_MAIN_MENU 1150
114 
115 #define EVENT_CONTEXT_MENU 1151
116 
117 #define EVENT_EXIT_MENU 1152
118 
121 #define EVENT_CUSTOM_MENU 1153
122 
125 #define EVENT_CHANGE_LANGUAGE 1160
126 
129 #define EVENT_CHANGEORIENTATION 1161
130 
134 #define EVENT_RADAR_WARNING 1170
135 
141 #define EVENT_POI_WARNING 1171
142 
146 #define EVENT_GEOFENCE 1172
147 
148 #define EVENT_RESTRICTED_ROAD 1173
149 
150 #define EVENT_BORDER_CROSSING 1180
151 
152 #define EVENT_SPEED_EXCEEDING 1181
153 
154 #define BITMAP_CLICK 1190
155 
156 #define EVENT_BITMAP_CLICK 1190
157 
158 #define EVENT_POI_CLICK 1191
159 
160 #define EVENT_BROWSE_MAP_EXIT 1192
161 
162 #define EVENT_APP_ERROR 1200
163 
164 #define EVENT_APP_EXIT 1200
165 
168 // Trip book
171 
173 typedef enum{
175  tbdmNoData = 1000,
177  tbdmFullData = 1001,
179  tbdmFullNMEA = 1002
180 
181 } TripBookRecordDataMode;
182 
184 // NavigationParams
188 {
189  private: void _doxygen_() { }
191  public:
193  {
194  //NpEnable = 0x00000001,
198  NpAskDeleteRoute = 0x00000002,
214  NpMessageRouteUnable = 0x00000020,
219  };
220 };
221 
222 
224 // poi
228 {
229 private: void _doxygen_() { }
231 public:
233  {
235  Rent_a_Car_Facility = 1,
237  Tourist_Information_Office = 2,
239  Museum = 3,
241  Theatre = 4,
243  Cultural_Centre = 5,
245  Sports_Centre = 6,
247  Hospital_Polyclinic = 7,
249  Police_Station = 8,
251  City_Hall = 9,
253  Post_Office = 10,
255  First_Aid_Post = 11,
257  Pharmacy = 12,
259  Departement_Store = 13,
261  Bank = 14,
263  Travel_Agency = 15,
265  Public_Phone = 16,
267  Warehouse = 17,
269  Ski_Lift_Station = 18,
271  Zoo = 19,
273  Scenic_Panoramic_View = 20,
275  Transport_Company = 21,
277  Casino = 22,
279  Cinema = 23,
281  Winery = 24,
283  Cargo_Centre = 25,
285  Car_Shipping_Terminal = 26,
287  Camping_Ground = 28,
289  Caravan_Site = 29,
291  Coach_and_Lorry_Parking = 30,
293  Community_Centre = 31,
295  Embassy = 33,
297  Frontier_Crossing = 34,
299  Motoring_Organization_Office = 35,
301  Recreation_Facility = 36,
303  Road_Side_Diner = 37,
305  School = 38,
307  Shopping_Centre = 39,
309  Stadium = 40,
311  Toll = 41,
313  College_University = 42,
315  Business_Facility = 43,
317  Airport = 44,
319  Bus_Station = 45,
321  Exhibition_Centre = 46,
323  Kindergarten = 47,
325  Emergency_Call_Station = 48,
327  Emergency_Medical_Service = 49,
329  Fire_Brigade = 50,
331  Freeport = 51,
333  Company = 52,
335  ATM = 53,
337  Hippodrome = 54,
339  Beach = 55,
341  Restaurant_Area = 56,
343  Ice_Skating_Rink = 57,
345  Courthouse = 58,
347  Mountain_Peak = 59,
349  Opera = 60,
351  Concert_Hall = 61,
353  Bovag_Garage = 62,
355  Tennis_Court = 63,
357  Skating_Rink = 64,
359  Water_Sport = 65,
361  Music_Centre = 66,
363  Doctor = 67,
365  Dentist = 68,
367  Veterinarian = 69,
369  Cafe_Pub = 70,
371  Convention_Centre = 71,
373  Leisure_Centre = 72,
375  Nightlife = 73,
377  Yacht_Basin = 74,
379  Condominium = 75,
381  Commercial_Building = 76,
383  Industrial_Building = 77,
385  Natives_Reservation = 78,
387  Cemetery = 79,
389  Breakdown_Service = 81,
391  Vehicle_Equipment_Provider = 82,
393  Entertainment = 83,
395  Abbey = 84,
397  Amusement_Park = 85,
399  Arts_Centre = 86,
401  Building_Footprint = 87,
403  Castle = 88,
405  Church = 89,
407  Factory_Ground_Philips = 90,
409  Fortress = 91,
411  Golf_Course = 92,
413  Holiday_Area = 93,
415  Library = 94,
417  Lighthouse = 95,
419  Military_Cemetery = 96,
421  Monastery = 97,
423  Monument = 98,
425  Natural_Reserve = 99,
427  Prison = 100,
429  Rocks = 101,
431  Sports_Hall = 102,
433  State_Police_Office = 103,
435  Walking_Area = 104,
437  Water_Mill = 105,
439  Windmill = 106,
441  Rent_a_Car_Parking = 107,
443  Car_Racetrack = 108,
445  Mountain_Pass = 109,
447  Swimming_Pool = 110,
449  Government_Office = 111,
451  Parking_Garage = 150,
453  Place_of_Worship = 151,
455  Ferry_Terminal = 152,
457  Airline_Access = 153,
459  Open_Parking_Area = 154,
461  Important_Tourist_Attraction = 155,
463  Railway_Station = 156,
465  Rest_Area = 157,
467  Shop = 158,
469  Park_and_Recreation_Area = 159,
471  Forest_Area = 160,
473  Military_Installation = 161,
475  Public_Transport_Stop = 162,
477  Car_Repair_Facility = 200,
479  Petrol_Station = 201,
481  Hotel_or_Motel = 202,
483  Restaurant = 203,
485  Cash_Dispenser = 204,
487  Car_Dealer = 205,
489  USERDEFINE = 255
490  };
491 };
492 
494 // speed camera
498 {
499 private: void _doxygen_() { }
501 public:
503  {
505  FixedSpeedCamera = 1,
507  RedLightCamera = 2,
509  SemiMobileSpeedCamera = 3,
511  FixedAverageSpeedCamera = 4,
513  MobileSpeedCamera = 5,
515  FixedRedLightAndSpeedCamera = 6,
517  MobileAverageSpeedCamera = 7,
519  MobileRedLightCamera = 8
520  };
521 };
522 
523 
525 // menu
528 // {ID= 0, SubID= 0} = main menu
531 {
532 private: void _doxygen_() { }
533 public:
534  class ID
535  {
536  private: void _doxygen_() { }
541  public:
542  enum {
563  IdBrowseMap = 58,
568  IdMenuPoiAdd = 60,
581  IdMenuSettingsHomeLocation = 308,
586  };
587  };
588 
590  {
591  private: void _doxygen_() { }
596  public:
597  enum {
601  OnMainNavigateTo = 101,
605  OnMainBrowseMap = 102,
607  OnMainTraffic = 103,
611  OnMainSettings = 104,
615  OnMainManagePoi = 105,
619  OnMainAlternative = 106,
623  OnMainItinerary = 107,
627  OnViewRoute = 109,
631  OnSettingGps = 110,
635  OnMainExit = 111,
639  OnMainExtras = 112,
643  OnMainMemorize = 116
644  };
645  };
646 
648  {
649  private: void _doxygen_() { }
654  public:
655  enum {
659  OnPoiAdd = 60,
663  OnPoiDelete = 62,
667  OnPoiCategoryDelete = 63,
671  OnPoiEnable = 64,
675  OnPoiWarnWhenNear = 65,
679  OnPoiEdit = 66
680  };
681  };
682 
684  {
685  private: void _doxygen_() { }
690  public:
691  enum {
695  OnViewRouteInstructions = 350,
699  OnViewRouteImages = 351,
703  OnViewRouteShowOnMap = 352,
707  OnViewRouteDemonstration = 353,
711  OnViewRouteSummary = 354,
715  OnViewRouteCancel = 355
716  };
717  };
718 
720  {
721  private: void _doxygen_() { }
726  public:
727  enum {
731  OnDemonstrateSpeed = 400,
735  OnDemonstrateRepeatOn = 401,
739  OnDemonstrateRepeatOff = 402,
743  OnDemonstrateStop = 403,
747  OnDemonstratePause = 404,
751  OnDemonstrateResume = 405,
755  OnDemonstrateStart = 406
756  };
757  };
758 
760  {
761  private: void _doxygen_() { }
766  public:
767  enum {
771  OnSettingsBacklight = 301,
775  OnSettingsDaylight = 303,
779  OnSettingsNight = 304,
783  OnSettingsDisableSounds = 305,
787  OnSettingsEnableSounds = 306,
791  OnSettingsAutoskin = 307,
795  OnSettingsHomeLocation = 308,
799  OnSettingsLanguage = 309,
803  OnSettingsLeft = 310,
807  OnSettingsRight = 311,
811  OnSettingsLoadMap = 312,
815  OnSettingsRegional = 315,
819  OnSettingsVersion = 316,
823  OnSettingsTollCharge = 317,
828  OnSettingsVolume = 319,
832  OnSettings3D = 320,
836  OnSettings2D = 321,
840  OnSettingsKeyboard = 322,
844  OnMainPlanning = 323,
848  OnSettingsVehicle = 324,
852  OnSettingsRotateScreen = 325,
856  OnSettingsGps = 328,
860  OnSettingsGPSLogs = 329,
864  OnSettingsQuickGuide = 330,
868  OnSettingsFeatures = 331,
872  OnSettingsVoice = 332,
876  OnSettingsSigns = 341,
880  OnSettings2DnorthUp = 343
881  };
882  };
883 
885  {
886  private: void _doxygen_() { }
888  public:
889  enum {
891  OnTrafficShowAll = 370,
893  OnTrafficShowRoute = 371,
895  OnTrafficDisable = 372,
897  OnTrafficEnable = 373,
899  OnTrafficOptimize = 374,
901  OnTrafficUpdate = 375,
903  OnTrafficOptions = 376
904  };
905  };
906 
907  //CApplicationMenu.ID.IdMenuNavigateTo:
908  //CApplicationMenu.ID.OnPoiAdd:
909  //CApplicationMenu.ID.OnSettingsHomeLocation:
911  {
912  private: void _doxygen_() { }
917  public:
918  enum {
922  OnAddress = 201,
926  OnFavorite = 202,
930  OnHistory = 203,
934  OnPoi = 204,
938  OnZipCode = 205,
942  OnHome = 206,
946  OnPointOnMap = 207,
950  OnCityCentre = 208,
954  OnCurrentGps = 209,
958  OnLastValidPosition = 210,
962  OnEnterPosition = 212
963  };
964  };
965 
967  {
968  private: void _doxygen_() { }
973  public:
974  enum {
978  OnShowMenu = 1,
982  OnMenuFind = 50,
986  OnMenuShowCurrentPosition = 51,
990  OnMenuShowRoute = 52,
994  OnMenuDisplayPois = 53,
998  OnMenuShowCity = 54
999  };
1000  };
1001 
1003  {
1004  private: void _doxygen_() { }
1009  public:
1010  enum {
1011  /* \brief OnShowMenu subID displays dialog enabling user to set GPS settings.\n
1012  * OnShowMenu subID calls the same function like clicking GPS hardware button in Settings menu.
1013  */
1014  OnShowMenu = 1,
1018  OnComPort = 222,
1022  OnBaudRate = 223
1023  };
1024  };
1025 
1027  {
1028  private: void _doxygen_() { }
1033  public:
1034  enum {
1039  OnAlternative = 360,
1043  OnAvoidNext = 361,
1047  OnTravelVia = 363,
1049  OnTraffic = 364,
1054  OnOriginal = 365,
1058  OnAvoidNext_500m = 390,
1062  OnAvoidNext_1km = 391,
1066  OnAvoidNext_5km = 392,
1070  OnAvoidNext_10km = 393,
1074  OnAvoidNext_15km = 394,
1078  OnAvoidNext_20km = 395
1079  };
1080  };
1081 
1083  {
1084  private: void _doxygen_() { }
1086  public:
1087  enum {
1091  OnContextImportantPlaces = 410,
1095  OnContextAvoidNext = 411,
1099  OnContexAddToFavourites = 412
1100  };
1101  };
1102 
1104  {
1105  private: void _doxygen_() { }
1107  public:
1108  enum {
1109  /* \brief OnExtraWorldClock subID displays a dialog enabling user to see multiple time zones clock.\n
1110  * OnExtraWorldClock subID calls the same function like clicking World Clock button in Extras menu.
1111  */
1112  OnExtraWorldClock = 117,
1116  OnExtraCountryInfo = 121,
1120  OnExtraCalc = 123,
1124  OnExtraConvMain = 124
1125  };
1126  };
1127 };
1128 
1130 // LONGPOSITION
1132 
1135 struct SDK_API LONGPOSITION
1136 {
1138  LONG lX;
1140  LONG lY;
1141 
1144  {
1145  lX = 0;
1146  lY = 0;
1147  }
1148 
1153  LONGPOSITION(LONG x, LONG y)
1154  : lX(x)
1155  , lY(y)
1156  {
1157  }
1158 
1159  BOOL operator == ( LONGPOSITION position ) const
1160  {
1161  return ( position.lX == lX && position.lY == lY );
1162  }
1163 
1164  BOOL operator != ( LONGPOSITION position ) const
1165  {
1166  return position.lX != lX || position.lY != lY;
1167  }
1168 };
1169 typedef LONGPOSITION *LPLONGPOSITION;
1170 
1172 // LONGRECT
1174 
1177 struct SDK_API LONGRECT
1178 {
1179  /* \brief Constructor of LONGRECT.*/
1181  {
1182  lLeft = MAXLONG;
1183  lTop = 0;
1184  lRight = 0;
1185  lBottom = MAXLONG;
1186  }
1188  LONG lLeft;
1190  LONG lTop;
1192  LONG lRight;
1194  LONG lBottom;
1195 
1197  {
1198  return (l.lLeft == lLeft && l.lTop == lTop && l.lRight == lRight && l.lBottom == lBottom );
1199  }
1200 };
1201 typedef LONGRECT *LPLONGRECT;
1202 
1204 // SChangeOption
1206 
1207 struct SDK_API SChangeOption
1208 {
1212  Explosives = 0x00000001,
1214  FlammableGases = 0x00000002,
1216  FlammableLiquids = 0x00000004,
1218  FlammableSolids = 0x00000008,
1220  Oxidizers = 0x00000010,
1222  Poisonous = 0x00000020,
1224  Radioactive = 0x00000040,
1226  Corrosive = 0x00000080,
1228  Hazardous = 0x00000100,
1230  InhalationHazards = 0x00000200,
1232  General = 0x00000400,
1234  Explosive = 0x00000800,
1236  HarmfulToWater = 0x00001000,
1238  Agriculture = 0x00010000,
1240  Coal = 0x00020000,
1242  Building = 0x00040000,
1244  SanitaryVaste = 0x00080000,
1246  SandAndGravel = 0x00100000,
1248  Commodity = 0x00200000,
1250  NaturalResources = 0x00400000
1251  };
1252 
1267 
1268  // 0 .. 10
1281 
1282  //MILES(YARDS) = 0, KILOMETERS = 1, MILES(FEETS) = 2
1291 
1292  //EUROPE = 0, US = 1, UK = 2
1301 
1302  //DEGREES = 0, MINUTES = 1, SECONDS = 2
1311 
1312  //ABCD = 1, QWERTY = 2, AZERTY = 3, DVORAK = 4
1322 
1323  // ASK = 1, ALWAYS = 2, NEVER = 3
1332 
1341 
1342  // ASK=1, FASTEST=2, SHORTEST=3, AVOIDING_MOTORWAYS=4, WALKS=5, BIKES=6, LIMITED=7
1352 
1355 
1364 
1379 
1384 
1417 
1425  int nSkin; // DAY = 0, NIGHT = 1, AUTO = 2
1426 
1429 
1438 
1450  int nView;
1487 
1488 #ifdef TRUCK_VERSION
1489  // truck attributes
1493  BOOL bTruckInMap; //readonly
1497  int nTruckMaxSpeed; //kmh
1498 
1512  int nTruckLenght; //mm
1516  int nTrailerLength; //mm
1518  int nTractorLength; //mm
1528  int nTruckWidth; //mm
1530  int nTruckHeight; //mm
1531 
1533  int nLoadRestrictions; //LOAD_RESTRICTIONS enum
1534 #endif // TRUCK_VERSION
1535 
1541  TCHAR strHomeLocation[60];
1543  TCHAR strLangFile[60];
1545  TCHAR strVoiceFolder[60];
1547  TCHAR strVoicePerson[60];
1549  TCHAR strMaxSpeedSound[60];
1552 
1554  SChangeOption();
1555 
1556 };
1557 
1559 // SStopOffPoint
1561 
1562 struct SDK_API SStopOffPoint
1563 {
1578  BOOL bVisited;
1579 
1580  //ViaPoint = 1, Finish = 2, Start = 3, Invisible = 4
1591 
1595  LONG lOffset;
1597  DWORD dwID;
1598  TCHAR strIso[4];
1599 
1600  TCHAR strCaption[120];
1601  TCHAR strAddress[120];
1602 
1604  SStopOffPoint();
1614  SStopOffPoint( LONG lX, LONG lY, LPCTSTR lpszCaption, BOOL bSearchAddress = FALSE );
1615 
1616 };
1617 
1619 // SPoi
1621 
1622 struct SDK_API SPoi
1623 {
1631 
1634 
1636  TCHAR szCategory[60];
1638  TCHAR szName[120];
1640  TCHAR szAddress[120];
1641 
1643  SPoi();
1644 
1645 };
1646 
1648 // SPoi
1650 
1651 struct SDK_API SPoiOnRoute
1652 {
1655 
1658 
1660  TCHAR szCategory[60];
1662  TCHAR szName[120];
1664  TCHAR szAddress[120];
1665 
1667  SPoiOnRoute();
1668 
1669 };
1670 
1672 // SPoiCategory
1674 
1678 struct SDK_API SPoiCategory
1679 {
1689 
1691  TCHAR strName[60];
1693  TCHAR strSound[60];
1694 
1696  SPoiCategory ( void );
1697 };
1698 
1699 typedef SPoi SFavorite;
1700 
1702 // SHistoryRecord
1704 
1709 struct SDK_API SHistoryRecord
1710 {
1711  //0 = none, 1 = name hierarchy address, 2 = name hierarchy lpPoi
1712  //3 = name hierarchy postal, 4 = click point, 5 = favourite, 6 = GPS position
1713  //7 = homebase, 8 = name hierarchy lpPoi custom
1728 
1731 
1736  TCHAR szHistoryCaption[120];
1737 
1739  TCHAR szAddress[120];
1740 
1742  SHistoryRecord();
1743 
1744 };
1745 
1747 // SSatelliteInfo
1749 
1750 struct SDK_API SSatelliteInfo
1751 {
1755  int Azimuth;
1757  int Quality;
1762 
1764  SSatelliteInfo();
1765 };
1766 
1768 // SGpsPosition
1770 
1771 struct SDK_API SGpsPosition
1772 {
1775 
1786 
1792  DOUBLE dCourse;
1796  DOUBLE dRealCourse;
1801  DOUBLE dSpeed;
1802 
1807  DOUBLE dHDoP;
1809  DOUBLE dTime;
1811  DWORD dwDate;
1812 
1820  TCHAR szMapIso[4];
1821 
1823  SSatelliteInfo satellitesInfo[12];
1824 
1826  SGpsPosition();
1827 
1829  void GetTime( BYTE &nHour, BYTE &nMinute, BYTE &nSeconds, WORD &nMiliseconds );
1831  void GetDate( BYTE &nDay, BYTE &nMonth, WORD &nYear );
1832 };
1833 
1835 // SWayPoint
1837 
1841 struct SDK_API SWayPoint
1842 {
1845 
1847  TCHAR szAddress[120];
1848 
1850  LPCTSTR GetAddress();
1851 
1853  SWayPoint();
1854 
1855 };
1856 
1857 typedef SWayPoint SLocation;
1858 
1860 // SRouteInfo
1862 
1863 struct SDK_API SRouteInfo
1864 {
1883  DWORD dwStatus;
1888  LONG lEstimatedTimeArival; // use function CApplicationAPI::TimeGetTime() for conversion
1893  LONG lRemaningTime; // (s)
1898  LONG lTotalTime; // (s)
1905 
1912 
1914  SRouteInfo();
1915 };
1916 
1918 struct SDK_API SRoadInfo
1919 {
1946  TCHAR szIsoCode[4];
1947 
1949 
1951 
1953  SRoadInfo();
1954 };
1955 
1957 struct SDK_API SRouteInstruction
1958 {
1961  {
1962  DirectionKeepRight = 0,
1963  DirectionKeepLeft = 2,
1964  DirectionEasyRight = 4,
1965  DirectionEasyLeft = 6,
1966  DirectionRight = 8,
1967  DirectionLeft = 10,
1968  DirectionSharpRight = 12,
1969  DirectionSharpLeft = 14,
1970  DirectionStraight = 16,
1971 
1972  DirectionUTurnRight = 17,
1973  DirectionUTurnLeft = 18,
1974  DirectionEnd = 19,
1975  DirectionStart = 20,
1976  DirectionOutOfRoute = 21,
1977 
1979  DirectionRoundaboutSE = 23,
1981  DirectionRoundaboutE = 24,
1983  DirectionRoundaboutNE = 25,
1985  DirectionRoundaboutN = 26,
1987  DirectionRoundaboutNW = 27,
1989  DirectionRoundaboutW = 28,
1991  DirectionRoundaboutSW = 29,
1993  DirectionRoundaboutS = 30,
1994 
1995 
1997  DirectionRoundaboutSW_LS = 32,
1999  DirectionRoundaboutW_LS = 33,
2001  DirectionRoundaboutNW_LS = 34,
2003  DirectionRoundaboutN_LS = 35,
2005  DirectionRoundaboutNE_LS = 36,
2007  DirectionRoundaboutE_LS = 37,
2009  DirectionRoundaboutSE_LS = 38,
2011  DirectionRoundaboutS_LS = 39,
2012 
2013  DirectionFerry = 40,
2014  DirectionStateBoundary = 41,
2015  DirectionExitRight = 43,
2016  DirectionExitLeft = 44,
2017  DirectionMotorway = 45
2018  };
2019 
2024 
2027 
2033  TCHAR lpszExitIndex[120];
2034 
2036  SRouteInstruction ( void );
2037 
2038 };
2039 
2041 struct SDK_API STmcEvent
2042 {
2045  {
2047  TMCTrafficProblem = 0,
2049  TMCQueuingProblem = 1,
2051  TMCSlowTraffic = 2,
2053  TMCHeavyTraffic = 3,
2055  TMCStationaryTraffic = 4,
2057  TMCCongestion = 5,
2059  TMCNormalTraffic = 6,
2061  TMCNoProblems = 7,
2063  TMCAccidentCleared = 8,
2065  TMCAccidentIncident = 9,
2067  TMCClosure = 10,
2069  TMCBridgeTunelBlocked = 11,
2071  TMCSeviceClosed = 12,
2073  TMCServiceReopened = 13,
2075  TMCLaneClosure = 14,
2077  TMCRoadWorks = 15,
2079  TMCObstacle = 16,
2081  TMCRoadConditions = 17,
2083  TMCWeather = 18,
2085  TMCWind = 19,
2087  TMCVisibility = 20,
2089  TMCTemperature = 21,
2091  TMCActivity = 22,
2093  TMCDelay = 23,
2095  TMCDangerousVehicle = 24,
2097  TMCExceptionalLoadsVehicles = 25,
2099  TMCTrafficEquipment = 26,
2101  TMCSizeAndWeightLimits = 27,
2103  TMCParkingRestrictions = 28,
2105  TMCReferenceToAudioBroadcast = 29,
2107  TMCAdditionalInfo = 30
2108  };
2109 
2111  WORD wID;
2112 
2114  LONG lX;
2116  LONG lY;
2117 
2127 
2138 
2140  STmcEvent();
2141 
2142 };
2143 
2146 {
2157 
2158  // traffic settings
2165 
2168 };
2169 
2171 //SError
2173 
2211 struct SDK_API SError
2212 {
2214  int nCode;
2215 
2217  TCHAR szDescription[120];
2218 
2220  SError();
2221 
2223  int GetCode();
2225  LPCTSTR GetDescription();
2227  void Clear();
2228 
2229 };
2230 
2231 typedef SError *LpError;
2232 
2234 {
2236 
2238 };
2239 
2240 void SDK_API FreeMemory( LPVOID ptr );
2241 
2243 class SDK_API CApplicationAPI
2244 {
2245 public:
2260  static int InitApi( LPCTSTR lpszPath, APPLICATION_HANDLEPROC pfnApplicationEventHandler, int nLeft, int nTop, int nWidth, int nHeight,
2261  BOOL bRunInForeground = TRUE, BOOL bNoCaption = FALSE, HWND hParentWnd = NULL );
2262 
2273  static int CloseApi();
2274 
2276  // application
2278 
2283  static int IsApplicationRunning( LpError lpError, DWORD dwMaxTime = DEFAULT_MAX_TIME );
2284 
2296  static int EndApplication( LpError lpError, DWORD dwMaxTime = DEFAULT_MAX_TIME );
2297 
2309  static int BringApplicationToForeground( LpError lpError, DWORD dwMaxTime = DEFAULT_MAX_TIME );
2310 
2322  static int BringApplicationToBackground( LpError lpError, DWORD dwMaxTime = DEFAULT_MAX_TIME );
2323 
2336  static int GetUniqueDeviceId( LpError lpError, LPTSTR lpszDeviceID, DWORD dwMaxTime = DEFAULT_MAX_TIME );
2337 
2350  static int IsApplicationInForeground( LpError lpError, BOOL &bApplicationInForeground, DWORD dwMaxTime = DEFAULT_MAX_TIME );
2351 
2366  static int GetMapVersion( LpError lpError, LPCTSTR lpszIso, LPTSTR lpszMapVersion, DWORD dwMaxTime = DEFAULT_MAX_TIME );
2367 
2381  static int GetApplicationVersion( LpError lpError, LPTSTR lpszDriveVersion, LPTSTR lpszBuiltNumber, DWORD dwMaxTime = DEFAULT_MAX_TIME );
2382 
2397  static int GetSdkVersion( LpError lpError, LPTSTR lpszSdkVersion, LPTSTR lpszBuiltNumber, DWORD dwMaxTime = DEFAULT_MAX_TIME );
2398 
2399 
2400 
2401 
2403  // options
2405 
2428  static int ChangeApplicationOptions( LpError lpError, SChangeOption* lpChangeOption, DWORD dwMaxTime = DEFAULT_MAX_TIME );
2429 
2441  static int SetDefaultValues( LpError lpError, DWORD dwMaxTime = DEFAULT_MAX_TIME );
2442 
2452  static int ChangeAppRectangle( LpError lpError, int nLeft, int nTop, int nWidth, int nHeight, DWORD dwMaxTime = DEFAULT_MAX_TIME );
2453 
2455  // navigation
2457 
2473  static int GetActualGpsPosition( LpError lpError, SGpsPosition* lpGpsPosition, BOOL bSatellitesInfo, DWORD dwMaxTime = DEFAULT_MAX_TIME );
2474 
2498  static int GetRouteInfo( LpError lpError, SRouteInfo* lpRouteInfo, BOOL bExtended = FALSE, DWORD dwMaxTime = DEFAULT_MAX_TIME );
2499 
2512  static int GetRouteStatus( LpError lpError, LPTSTR &lpRouteStatus, DWORD dwMaxTime = DEFAULT_MAX_TIME );
2513 
2546  static int StartNavigation( LpError lpError, SLocation* lpLocation, DWORD dwFlags, BOOL bShowApplication, BOOL bSearchAddress, DWORD dwMaxTime = DEFAULT_MAX_TIME );
2547 
2581  static int StartNavigation( LpError lpError, SLocation* lpLocation, DWORD dwFlags, BOOL bCloseDelivery, BOOL bShowApplication, BOOL bSearchAddress, DWORD dwMaxTime = DEFAULT_MAX_TIME );
2582 
2617  static int StartNavigation( LpError lpError, SLocation* lpLocation, DWORD dwFlags, BOOL bCloseDelivery, BOOL bShowApplication, BOOL bSearchAddress, SRouteComputeSettings* lpCompSettings, DWORD dwMaxTime = DEFAULT_MAX_TIME );
2618 
2630  static int StopNavigation( LpError lpError, DWORD dwMaxTime = DEFAULT_MAX_TIME );
2631 
2663  static int NavigateToAddress( LpError lpError, LPCTSTR lpszAddress, BOOL bPostal, DWORD dwFlags, BOOL bShowApplication, DWORD dwMaxTime = DEFAULT_MAX_TIME );
2664 
2700  static int NavigateToAddress( LpError lpError, LPCTSTR lpszAddress, BOOL bPostal, DWORD dwFlags, BOOL bCloseDelivery, BOOL bShowApplication, DWORD dwMaxTime = DEFAULT_MAX_TIME );
2701 
2714  static int LoadComputedRoute( LpError lpError, LPCTSTR lpszRoutePath, DWORD dwMaxTime = DEFAULT_MAX_TIME );
2715 
2730  static int LoadComputedRoute( LpError lpError, LPCTSTR lpszRoutePath, DWORD dwStartWaypointID, LPTSTR lpszApproximationInfo, DWORD dwMaxTime = DEFAULT_MAX_TIME );
2731 
2744  static int SaveComputedRoute( LpError lpError, LPCTSTR lpszRoutePath, DWORD dwMaxTime = DEFAULT_MAX_TIME );
2745 
2746  static int GetRoute(LpError lpError, int nFormat, int nDetail, LPTSTR &lpszRoute, DWORD dwMaxTime = DEFAULT_MAX_TIME);
2747 
2749  // favorites
2751 
2765  static int GetFavoritesList( LpError lpError, SFavorite* & lstFavoriteArr, int & nSize,
2766  BOOL bSearchAddress, DWORD dwMaxTime = DEFAULT_MAX_TIME );
2767 
2783  static int AddStopOffPointsToFavorites( LpError lpError, SPoi* lpStopOffPoint, DWORD dwMaxTime = DEFAULT_MAX_TIME );
2784 
2800  static int RemoveFavoriteFromList( LpError lpError, SFavorite* lpFavorite, DWORD dwMaxTime = DEFAULT_MAX_TIME );
2801 
2803  // history
2805 
2819  static int AddStopOffPointToHistory( LpError lpError, SHistoryRecord* lpStopOffPoint, DWORD dwMaxTime = DEFAULT_MAX_TIME );
2820 
2835  static int GetHistoryList( LpError lpError, SHistoryRecord* & lstHistoryArr, int & nSize,
2836  BOOL bSearchAddress, DWORD dwMaxTime = DEFAULT_MAX_TIME );
2837 
2839  // poi
2841 
2856  static int AddPoi( LpError lpError, SPoi* lpPoi, DWORD dwMaxTime = DEFAULT_MAX_TIME );
2857 
2877  static int AddPoiCategory( LpError lpError, LPCTSTR lpszCategory,LPCTSTR lpszBitmapPath, LPCTSTR lpszIsoCode,
2878  DWORD dwMaxTime = DEFAULT_MAX_TIME );
2879 
2896  static int DeletePoiCategory( LpError lpError, LPCTSTR lpszCategory, LPCTSTR lpszIso, DWORD dwMaxTime = DEFAULT_MAX_TIME );
2897 
2913  static int DeletePoi( LpError lpError, SPoi* lpPoi, DWORD dwMaxTime = DEFAULT_MAX_TIME );
2914 
2931  static int MakeUserPoiVisible( LpError lpError, DWORD dwCategory, LPCTSTR lpszCategory, BOOL bShow, DWORD dwMaxTime = DEFAULT_MAX_TIME );
2932 
2948  static int GetPoiList( LpError lpError, SPoi* &lstPoiArr, int & nSize, LPCTSTR lpszCategory, BOOL bSearchAddress, DWORD dwMaxTime = DEFAULT_MAX_TIME );
2949 
2950  static int GetPoiOnRoute( LpError lpError, int nGroup, int nCategory, int minDriveTime, int maxDriveTime, SPoiOnRoute* &lstPoiArr, int & nSize, DWORD dwMaxTime = DEFAULT_MAX_TIME );
2951 
2952 
2973  static int FindNearbyPoi( LpError lpError, SPoi* & lpPoi, DWORD dwCategoryNumber, LPCTSTR lpszCategoryName,
2974  long lX, long lY, DWORD dwMaxTime = DEFAULT_MAX_TIME );
2975 
2997  static int FindNearbyPoi( LpError lpError, SPoi *&lpPoiList, int &nListSize, DWORD dwCategoryNumber, LPCTSTR lpszCategoryName,
2998  LONG lX, LONG lY, DWORD dwMaxTime = DEFAULT_MAX_TIME );
2999 
3013  static int GetPoiCategoryList( LpError lpError, SPoiCategory *&lpPoiCategories, int &nSize, DWORD dwMaxTime = DEFAULT_MAX_TIME );
3014 
3027  static int SetPoiWarning( LpError lpError, SPoiCategory *lpPoiCategory, DWORD dwMaxTime = DEFAULT_MAX_TIME );
3028 
3044  static int HighlightPoi( LpError lpError, LPCTSTR lpszPoiCategory, LPCTSTR lpszPoiName, LPCTSTR lpszSound, LONGPOSITION cpPoiLocation, DWORD dwMaxTime = DEFAULT_MAX_TIME );
3045 
3047  // location
3049 
3067  static int GetLocationInfo( LpError lpError, LONGPOSITION cpLocation, LPTSTR lpszAddress, DWORD dwMaxTime = DEFAULT_MAX_TIME );
3068 
3086  static int GetLocationInfo( LpError lpError, LONGPOSITION cpLocation, LPTSTR lpszAddress, SRoadInfo *lpRoadInfo, DWORD dwMaxTime = DEFAULT_MAX_TIME );
3087 
3112  static int LocationFromAddress( LpError lpError, LONGPOSITION & cpLocation, LPCTSTR lpszAddress, BOOL bPostal, BOOL bValueMatch, DWORD dwMaxTime = DEFAULT_MAX_TIME );
3113 
3144  static int LocationFromAddressEx( LpError lpError, LPCTSTR lpszAddress, BOOL bPostal, SWayPoint * &lpPositions,
3145  int &nCount, DWORD dwMaxTime = DEFAULT_MAX_TIME );
3146 
3178  static int LocationFromAddressEx( LpError lpError, LPCTSTR lpszAddress, BOOL bPostal, BOOL bFuzzySearch, SWayPoint * &lpPositions,
3179  int &nCount, DWORD dwMaxTime = DEFAULT_MAX_TIME );
3180 
3199  static int ShowHierarchyDialog( LpError lpError, LPCTSTR lpszIso, LPCTSTR lpszCity, LPCTSTR lpszStreet, BOOL bPostal,
3200  SWayPoint * &lpPosition, DWORD dwMaxTime = DEFAULT_MAX_TIME );
3201 
3220  static int GetAddressList( LpError lpError, LPCTSTR lpszAddress, BOOL bPostal, int nMaxCount, SWayPoint * &lpList, int &nCount, DWORD dwMaxTime = DEFAULT_MAX_TIME );
3221 
3236  static int GetCoordinatesFromOffset( LpError lpError, LPCTSTR lpszIso, LONG lRoadOffset, LONGPOSITION &cpPosition, DWORD dwMaxTime = DEFAULT_MAX_TIME );
3237 
3239  // maps
3241 
3254  static int SwitchMap( LpError lpError, LPCTSTR lpszLoadPath, DWORD dwMaxTime = DEFAULT_MAX_TIME );
3255 
3275  static int ShowCoordinatesOnMap( LpError lpError, LONGPOSITION cpLocation,
3276  LONG lZoom, BOOL bShowApplication, DWORD dwMaxTime = DEFAULT_MAX_TIME );
3277 
3296  static int ShowRectangleOnMap( LpError lpError, LONGRECT rcRect, BOOL bShowApplication, DWORD dwMaxTime = DEFAULT_MAX_TIME );
3297 
3317  static int AddBitmapToMap( LpError lpError, LPCTSTR lpszBitmapPath, long lX, long lY,
3318  UINT &nBitmapID, DWORD dwMaxTime = DEFAULT_MAX_TIME );
3319 
3334  static int RemoveBitmap( LpError lpError, UINT nBitmapID, DWORD dwMaxTime = DEFAULT_MAX_TIME );
3335 
3349  static int RemoveAllBitmaps( LpError lpError, DWORD dwMaxTime = DEFAULT_MAX_TIME );
3350 
3367  static int ShowBitmap( LpError lpError, UINT nBitmapID, BOOL bShow, DWORD dwMaxTime = DEFAULT_MAX_TIME );
3368 
3386  static int MoveBitmap( LpError lpError, UINT nBitmapID, long lX, long lY, DWORD dwMaxTime = DEFAULT_MAX_TIME );
3387 
3389  // dialogs
3391 
3417  static int ShowMessage( LpError lpError, LPCTSTR lpszMessage, int nButtons,
3418  BOOL bWaitForFeedback, BOOL bShowApplication, int & nUserFeedback, DWORD dwMaxTime = DEFAULT_MAX_TIME );
3419 
3441  static int OnMenuCommand( LpError lpError, int nID, int nSubID, BOOL bShowApplication, DWORD dwMaxTime = DEFAULT_MAX_TIME );
3442 
3459  static int FlashMessage( LpError lpError, LPCTSTR lpszMessage, BOOL bShowApplication, DWORD dwMaxTime = DEFAULT_MAX_TIME );
3460 
3472  static int CloseDialogs( LpError lpError, DWORD dwMaxTime = DEFAULT_MAX_TIME );
3473 
3474  static int ErrorReport ( LpError lpError, DWORD &dwID, DWORD dwMaxTime = DEFAULT_MAX_TIME );
3475 
3477  // itinerary
3479 
3495  static int AddItinerary( LpError lpError, SStopOffPoint* lstPointArr, int nSize, LPCTSTR lpszItineraryName,
3496  DWORD dwMaxTime = DEFAULT_MAX_TIME );
3497 
3512  static int AddItinerary( LpError lpError, LPCTSTR lpszItineraryJson, LPCTSTR lpszItineraryName,
3513  DWORD dwMaxTime = DEFAULT_MAX_TIME );
3514 
3548  static int SetRoute( LpError lpError, LPCTSTR lpszItineraryName, DWORD dwFlags, BOOL bShowApplication, DWORD dwMaxTime = DEFAULT_MAX_TIME );
3549 
3586  static int SetRoute( LpError lpError, LPCTSTR lpszItineraryName, DWORD dwFlags, BOOL bCloseDelivery, BOOL bShowApplication, DWORD dwMaxTime = DEFAULT_MAX_TIME );
3587 
3624  static int SetRoute( LpError lpError, LPCTSTR lpszItineraryName, DWORD dwFlags, BOOL bCloseDelivery, BOOL bShowApplication, int &nWrongWaypointsCount, int *&lpWrongWaypoints, DWORD dwMaxTime = DEFAULT_MAX_TIME );
3625 
3626 
3644  static int AddEntryToItinerary( LpError lpError, LPCTSTR lpszItineraryName, SStopOffPoint* lpStopOffPoint, UINT nIndex,
3645  DWORD dwMaxTime = DEFAULT_MAX_TIME );
3646 
3660  static int DeleteEntryInItinerary( LpError lpError, LPCTSTR lpszItineraryName, UINT nIndex, DWORD dwMaxTime = DEFAULT_MAX_TIME );
3661 
3674  static int DeleteItinerary( LpError lpError, LPCTSTR lpszItineraryName, DWORD dwMaxTime = DEFAULT_MAX_TIME );
3675 
3689  static int GetItineraryList( LpError lpError, LPCTSTR lpszItineraryName, SStopOffPoint * &PointsArr, int &nWayPointsCount, DWORD dwMaxTime = DEFAULT_MAX_TIME );
3690 
3703  static int OptimizeItinerary( LpError lpError, LPCTSTR lpszItineraryName, DWORD dwMaxTime = DEFAULT_MAX_TIME );
3704 
3716  static int OptimizeRoute( LpError lpError, DWORD dwMaxTime = DEFAULT_MAX_TIME );
3717 
3729  static int SkipNextWaypoint( LpError lpError, DWORD dwMaxTime = DEFAULT_MAX_TIME );
3730 
3731 
3733  // gps input
3735 
3746  static int EnableExternalGpsInput( LpError lpError, DWORD dwMaxTime = DEFAULT_MAX_TIME );
3747 
3759  static int DisableExternalGpsInput( LpError lpError, DWORD dwMaxTime = DEFAULT_MAX_TIME );
3760 
3773  static BOOL SendGpsData( LPCTSTR lpszData, int nSize );
3774 
3791  static int GpsSwitchOn( LpError lpError, LPCTSTR lpszPort, DWORD dwBaudRate, BOOL bSwitchOn, DWORD dwMaxTime = DEFAULT_MAX_TIME );
3792 
3794  // info
3796 
3808  static int GetCurrentSpeedLimit ( LpError lpError, int &nSpeedLimit, DWORD dwMaxTime = DEFAULT_MAX_TIME );
3809 
3822  static int GetNextInstruction ( LpError lpError, SRouteInstruction *lpInstruction, DWORD dwMaxTime = DEFAULT_MAX_TIME );
3823 
3825  // online
3827 
3841  static int GoOnline( LpError lpError, BOOL bOnline, DWORD dwMaxTime = DEFAULT_MAX_TIME );
3842 
3856  static int OnlineServicesLogin( LpError lpError, LPCTSTR lpszUserName, LPCTSTR lpszPassword, DWORD dwMaxTime = DEFAULT_MAX_TIME );
3857 
3870  static int AddTMCEvent( LpError lpError, STmcEvent *lpTmcEvent, DWORD dwMaxTime = DEFAULT_MAX_TIME );
3871 
3885  static int RemoveTMCEvent( LpError lpError, WORD wTmcEventId, DWORD dwMaxTime = DEFAULT_MAX_TIME );
3886 
3898  static int ClearTMCTable( LpError lpError, DWORD dwMaxTime = DEFAULT_MAX_TIME );
3899 
3912  static int OnlineServicesSettings( LpError lpError, SOnlineServicesSettings *lpSettings, DWORD dwMaxTime = DEFAULT_MAX_TIME );
3913 
3915  // TTS
3917 
3929  static int PlaySoundTTS( LpError lpError, LPCTSTR lpszText, DWORD dwMaxTime = DEFAULT_MAX_TIME );
3930 
3932  // additional
3934 
3946  static int LoadGFFile( LpError lpError, LPCTSTR lpszPath, DWORD dwMaxTime = DEFAULT_MAX_TIME );
3947 
3960  static int UnloadGFFile( LpError lpError, LPCTSTR lpszPath, DWORD dwMaxTime = DEFAULT_MAX_TIME );
3961 
3977  static int LoadExternalFile( LpError lpError, LPCTSTR lpszPath, int nFileType, DWORD dwMaxTime = DEFAULT_MAX_TIME );
3978 
3994  static int UnloadExternalFile( LpError lpError, LPCTSTR lpszPath, int nFileType, DWORD dwMaxTime = DEFAULT_MAX_TIME );
3995 
4007  static int ReloadExternalFiles( LpError lpError, DWORD dwMaxTime = DEFAULT_MAX_TIME );
4008 
4010  // trip book
4012 
4025  static int TripStart( LpError lpError, LPCTSTR lpszTripname, int nDataMode, DWORD dwMaxTime = DEFAULT_MAX_TIME );
4026 
4036  static int TripAddUserEvent( LpError lpError, LPCTSTR lpszEventName, UINT nCustomID, DWORD dwMaxTime = DEFAULT_MAX_TIME );
4037 
4049  static int TripEnd( LpError lpError, DWORD dwMaxTime = DEFAULT_MAX_TIME );
4050 
4064  static int LoadOFGRoute( LpError lpError, LPCTSTR lpszFileName, int nStartFromIndex, int nFlags, DWORD dwMaxTime /*= DEFAULT_MAX_TIME*/ );
4065 
4066  static int GetOFGRouteStatus( LpError lpError, LPTSTR lpszStatus, DWORD dwMaxTime /*= DEFAULT_MAX_TIME*/ );
4067 
4068  static int SaveOFGRoute( LpError lpError, LPCTSTR lpszFileName, int nFromIndex, LONGPOSITION cpFrom, int nToIndex, LONGPOSITION cpTo, DWORD dwMaxTime /*= DEFAULT_MAX_TIME*/ );
4069 
4070 
4071  static int GetMobileData(LpError lpError, LPTSTR &lpMobileData, DWORD dwMaxTime = DEFAULT_MAX_TIME);
4072 
4073  static int SetMobileData(LpError lpError, LPCTSTR lpMobileData, DWORD dwMaxTime = DEFAULT_MAX_TIME);
4074 
4075  static int ResetMobileData(LpError lpError, DWORD dwMaxTime = DEFAULT_MAX_TIME);
4076 
4077 
4078  static int GetMapCorrectionEvents(LpError lpError, LPTSTR &lpszTable, DWORD dwMaxTime = DEFAULT_MAX_TIME);
4079 
4080  static int AddMapCorrectionEvents(LpError lpError, LPCTSTR lpszTable, DWORD dwMaxTime = DEFAULT_MAX_TIME);
4081 
4082  static int ClearMapCorrectionEvents(LpError lpError, DWORD dwMaxTime = DEFAULT_MAX_TIME);
4083 
4084 
4085 public:
4096  static BOOL TimeGetTime ( LONG lTime, USHORT *nYear, BYTE *nMonth,
4097  BYTE *nDay, BYTE *nHour, BYTE *nMinute, BYTE *nSecond );
4098 };
4099 
4100 #endif // !defined __API_H__
int nDistanceUnit
Flag determining distance units.
Definition: ApplicationApi.h:1290
NpMessageRouteUnable commands Drive to notice user that route can not be computed. For example this could happen if start or destination point of route are out of loaded maps.
Definition: ApplicationApi.h:214
int nTruckLenght
Total vehicle length [mm].
Definition: ApplicationApi.h:1512
LONGRECT rcBoundaryRectangle
LONGRECT structure defining rectangle on BrowseMap in which route is situated.
Definition: ApplicationApi.h:1873
Definition: ApplicationApi.h:1026
int nSpeedExceed
Speed warning is triggered when the maximum allowed speed outside city is exceeded by this value...
Definition: ApplicationApi.h:1442
int bSnapToEveryRoad
Allows position snapping to forbidden roads.
Definition: ApplicationApi.h:1470
Definition: ApplicationApi.h:910
DWORD dwOffroadDistance
Definition: ApplicationApi.h:1950
LONG lRoadOffset
Road element offset of the road, to which is the current position snapped.
Definition: ApplicationApi.h:1814
BOOL bAvoidUTurns
Flag determining whether Drive avoids U-turns when computing route.
Definition: ApplicationApi.h:1340
int nTruckOtherWeight
Other weight [kg].
Definition: ApplicationApi.h:1508
Definition: ApplicationApi.h:1082
LONGPOSITION(LONG x, LONG y)
Constructor of LONGPOSITION.
Definition: ApplicationApi.h:1153
int Quality
Signal quality from satellite.
Definition: ApplicationApi.h:1757
SPoi structure is used to add POIs to Favourites and custom POI category. It is also used during retr...
Definition: ApplicationApi.h:1651
SHistoryRecord class is used to manipulate with items in history list.
Definition: ApplicationApi.h:1709
int nVisiblePointReachDistance
Visible waypoints reach distance in meters.
Definition: ApplicationApi.h:1482
int nSkin
Skin mode.
Definition: ApplicationApi.h:1425
SRoadInfo structure is providing information about road type. This is retrieved from the GetLocationI...
Definition: ApplicationApi.h:1918
SRouteInfo structure is used during retrieving inforamations about computed route by GetRouteInfo fun...
Definition: ApplicationApi.h:1863
BOOL bNotifyOnlyWhenOnRoad
Flag determining when the POI is notified.
Definition: ApplicationApi.h:1688
int Azimuth
Satellite azimuth in degrees.
Definition: ApplicationApi.h:1755
BOOL bTrapsEnabled
Flag determining if the Police traps service is enabled.
Definition: ApplicationApi.h:2154
LONG lOffset
Road offset from our map, where the waypoint is located. Use conversion table to obtain the offset fr...
Definition: ApplicationApi.h:1595
SError class is used to obtain additional error informations after calling ApplicationAPI function...
Definition: ApplicationApi.h:2211
BOOL bTruckInMap
Flag determining whether a truck attributes are contained in map. This flag is readonly.
Definition: ApplicationApi.h:1493
Definition: ApplicationApi.h:759
INT nTimeRemaining
Definition: ApplicationApi.h:1656
Definition: ApplicationApi.h:534
BOOL bUseTruckAtt
Use truck attributes.
Definition: ApplicationApi.h:1495
BOOL bVisited
Flag determining whether waypoint was already visited.
Definition: ApplicationApi.h:1578
DWORD dwStatus
Status of the route.
Definition: ApplicationApi.h:1883
SGpsPosition structure is used to obtain information about GPS position, data and quality of GPS sign...
Definition: ApplicationApi.h:1771
LONG lEstimatedTimeArival
Estimated time of arrival.
Definition: ApplicationApi.h:1888
LONG lY
LONGPOSITION::lY Field determines Y coordinate (geographical latitude) of location in world degrees m...
Definition: ApplicationApi.h:1140
LONG lY
Determines geographical latitude (Y coordinate) of the event in world degrees multiplied by 100 000...
Definition: ApplicationApi.h:2116
BOOL bDisableMainMenu
Flag enabling/disabling main menu.
Definition: ApplicationApi.h:1371
Definition: ApplicationApi.h:647
int nETAPercentageChange
Estimate time arrival percentage change.
Definition: ApplicationApi.h:1383
LONG lX
LONGPOSITION::lX Field determines X coordinate (geographical longitude) of location in world degrees ...
Definition: ApplicationApi.h:1138
BOOL bAllowClosedRoads
Allow closed roads in route computing.
Definition: ApplicationApi.h:1486
LONG lFerriesLength
Ferries length in meters.
Definition: ApplicationApi.h:1904
BOOL bRadarsVisible
Enable speed camera visibility.
Definition: ApplicationApi.h:1400
int nInstruction
Next turn instruction. See Instruction enum.
Definition: ApplicationApi.h:2029
LONG lToPointOffset
Offset of end graph point of the current road segment.
Definition: ApplicationApi.h:1818
LONGPOSITION cpLocation
LONGPOSITION structure defining position of waypoint on map.
Definition: ApplicationApi.h:1593
int nDestinationAngle
Definition: ApplicationApi.h:2235
int nTruckWeightTotal
Gross vehicle weight [kg].
Definition: ApplicationApi.h:1500
int nLoadRestrictions
HAZMAT / Load restrictions. See LOAD_RESTRICTIONS.
Definition: ApplicationApi.h:1533
DWORD dwRoadFlags
Road Flag is an identificator of the road type in map.
Definition: ApplicationApi.h:1944
BOOL bSearchAddress
Flag determining whether function searches for address when adding POI.
Definition: ApplicationApi.h:1630
LONG lMotorwaysLength
Motorways length in meters.
Definition: ApplicationApi.h:1900
int nTractorLength
Tractor Length [mm].
Definition: ApplicationApi.h:1518
BOOL bTrafficShowOnMap
Flag determining if the Traffic info service is enabled.
Definition: ApplicationApi.h:2164
Instruction
Instruction type.
Definition: ApplicationApi.h:1960
LONGPOSITION cpLocation
LONGPOSITION struct defining position of waypoint on map.
Definition: ApplicationApi.h:1844
LOAD_RESTRICTIONS
HAZMAT / Load restrictions.
Definition: ApplicationApi.h:1210
int nKingpinLastTandem
Kingpin to middle of last tandem [mm].
Definition: ApplicationApi.h:1522
Definition: ApplicationApi.h:719
NpMessageAvoidTollRoadsUnable commands Drive to notice user that not all toll roads can be avoided...
Definition: ApplicationApi.h:206
DOUBLE dSpeed
Speed represents velocity in kilometers per hour (km/h).
Definition: ApplicationApi.h:1801
int nTruckTandemWeight
Tandem axle weight [kg].
Definition: ApplicationApi.h:1504
DWORD dwDate
Actual GPS date.
Definition: ApplicationApi.h:1811
int nAvoidTollRoads
Flag determining whether Drive avoids toll roads when computing route.
Definition: ApplicationApi.h:1331
_NavigationParams
NavigationParams enum enumerates possibilities of Drive behavior during route computing.
Definition: ApplicationApi.h:192
int nSpeedExceedInCity
Speed warning is triggered when the maximum allowed speed in city is exceeded by this value...
Definition: ApplicationApi.h:1440
BOOL bWeatherEnabled
Flag determining if the Weather service is enabled.
Definition: ApplicationApi.h:2148
UINT nValidityYear
Year. Validity time, till which the event remains active. After this time is the event deleted...
Definition: ApplicationApi.h:2129
SOnlineServicesSettings structure.
Definition: ApplicationApi.h:2145
DOUBLE dCourse
Course represents speed direction in degrees(from gps signal) multiplied by 100000.
Definition: ApplicationApi.h:1792
DOUBLE dHDoP
Horizontal dilution of precision.
Definition: ApplicationApi.h:1807
BOOL bTrafficEnabled
Flag determining if the Traffic service is enabled.
Definition: ApplicationApi.h:2152
int nView
View mode.
Definition: ApplicationApi.h:1450
Basic class providing set of functions to command Drive.
Definition: ApplicationApi.h:2243
LONG lTop
lTop determines top border of rectangle (geographical latitude).
Definition: ApplicationApi.h:1190
WORD wID
Returns the ID number that was assigned to this event by application. The ID can be later used to del...
Definition: ApplicationApi.h:2111
int nRoundaboutExitIndex
Roundabout exit index.
Definition: ApplicationApi.h:2031
NpMessageAvoidFerriesUnable commands Drive to notice user that not all ferries can be avoided...
Definition: ApplicationApi.h:210
DOUBLE dRealCourse
Real course(in degrees) - orientation that the car has in Sygic software. RealCourse=0 represents Eas...
Definition: ApplicationApi.h:1796
int nVolumeMax
Represents the volume in high vehicle speed. (0-10)
Definition: ApplicationApi.h:1280
NpAskDeleteRoute commands Drive to ask user to delete computed route. Drive asks user to delete com...
Definition: ApplicationApi.h:198
LONGPOSITION cpLocation
LONGPOSITION struct determining location of history item on map.
Definition: ApplicationApi.h:1730
int nInvisiblePointReachDistance
Invisible waypoints reach distance in meters.
Definition: ApplicationApi.h:1484
_SpeedCameraType
Enumeration of Speed camera types.
Definition: ApplicationApi.h:502
SPoi structure is used to add POIs to Favourites and custom POI category. It is also used during retr...
Definition: ApplicationApi.h:1622
SHORT nSatellites
Number of visible satellites.
Definition: ApplicationApi.h:1774
SStopOffPoint structure is used during manipulation with itinerary.
Definition: ApplicationApi.h:1562
INT nDistanceRemaining
Definition: ApplicationApi.h:1657
int nPointType
Flag determining type of waypoint.
Definition: ApplicationApi.h:1590
SWayPoint structure specifies location of one point on map.
Definition: ApplicationApi.h:1841
int * pTimeToWP
Array of estimated time arrivals to remaining waypoints from actual position.
Definition: ApplicationApi.h:1907
BOOL bDisableRecompute
Flag enabling/disabling recomputing route when deviating from the route.
Definition: ApplicationApi.h:1378
int nTruckOtherLength
Other length [mm].
Definition: ApplicationApi.h:1526
LONG lDistanceToNextTurn
Distance to next turn [m].
Definition: ApplicationApi.h:2026
int nVolumeMin
Represents the volume in low vehicle speed. (0-10)
Definition: ApplicationApi.h:1274
int nHistoryType
Flag determining type of history item.
Definition: ApplicationApi.h:1727
int nPlanningSettingsLimitedSpeed
Parameter determinig vehicle speed limit. Used only if route is computed for vehicles with limited sp...
Definition: ApplicationApi.h:1354
LONG lAltitude
Altitude in meters.
Definition: ApplicationApi.h:1785
int nETAMaximumSpeed
Flag determining the Estimated Time of Arrival calculated in maximum speed.
Definition: ApplicationApi.h:1381
LONGPOSITION cpLocation
LONGPOSITION struct determining POI location on map.
Definition: ApplicationApi.h:1633
int nTruckAxleLength
Extreme axle length [mm].
Definition: ApplicationApi.h:1514
_PoiService
PoiService enum enumerates predefined POI categories.
Definition: ApplicationApi.h:232
BOOL bSoundEnabled
Flag enabling/disabling sounds.
Definition: ApplicationApi.h:1259
BOOL operator==(LONGRECT &l)
Definition: ApplicationApi.h:1196
LONG lLongitude
Longitude represents X coordinate (geographical longitude) of location in degrees multiplied by 10000...
Definition: ApplicationApi.h:1783
int SateliteId
The satellite ID.
Definition: ApplicationApi.h:1759
SChangeOption structure is used to manipulate with basic Drive settings in ChangeApplicationOptions f...
Definition: ApplicationApi.h:1207
int nWPArraySize
Size of TimeToWP and DistToWP arrays.
Definition: ApplicationApi.h:1911
LONG lNotificationDistance
Notification distance for POI warning.
Definition: ApplicationApi.h:1681
int nTruckUnladenWeight
Unladen vehicle weight [kg].
Definition: ApplicationApi.h:1510
LONGPOSITION cpHomePosition
LONGPOSITION struct determining location of home position. See Coordinates conversion section in TROU...
Definition: ApplicationApi.h:1539
int nGPSUnits
Flag determining GPSUnits format.
Definition: ApplicationApi.h:1310
LONG lBottom
lBottom determines top border of rectangle (geographical latitude).
Definition: ApplicationApi.h:1194
int nPlanningSettings
Flag determining what kind of route Drive computes.
Definition: ApplicationApi.h:1351
Definition: ApplicationApi.h:497
LONGPOSITION cpOnroadPosition
Definition: ApplicationApi.h:1948
int nClockFormat
Flag determining clock format.
Definition: ApplicationApi.h:1300
DOUBLE dTime
Actual GPS time.
Definition: ApplicationApi.h:1809
EventCode
List of the possible Event codes.
Definition: ApplicationApi.h:2044
NpMessageWaypointsDistant commands Drive to notice user that route can not be computed because of too...
Definition: ApplicationApi.h:218
BOOL bTrafficAutoRecompute
Flag determining if the Automatic route recalculation service is enabled.
Definition: ApplicationApi.h:2160
LONG lTollRoadsLength
Tollroads length in meters.
Definition: ApplicationApi.h:1902
BOOL bRadarsWarnOn
Enable speed camera warning.
Definition: ApplicationApi.h:1392
BYTE nValidityMonth
Month. Validity time, till which the event remains active. After this time is the event deleted...
Definition: ApplicationApi.h:2131
Definition: ApplicationApi.h:1103
int nTimeZone
Time zone in minutes. Offset from GMT.
Definition: ApplicationApi.h:1428
LONG lLatitude
Latitude represents Y coordinate (geographical latitude) of location in degrees multiplied by 100000...
Definition: ApplicationApi.h:1779
BOOL bAvoidFerries
Flag determining whether Drive avoids ferries when computing route.
Definition: ApplicationApi.h:1363
LONG lNextTurnX
Next turn longitude.
Definition: ApplicationApi.h:2021
LONG lNextTurnY
Next turn latitude.
Definition: ApplicationApi.h:2023
int nSignpostDirection
Displayed signposts.
Definition: ApplicationApi.h:1459
int nTruckHeight
Posted height [mm].
Definition: ApplicationApi.h:1530
int nTruckWeightAxle
Weight per axle [kg].
Definition: ApplicationApi.h:1502
int nKingpinLastAxle
Kingpin to last axle [mm].
Definition: ApplicationApi.h:1520
BOOL bTrafficShowNotification
Flag determining if the Traffic notification service is enabled.
Definition: ApplicationApi.h:2162
BOOL bHideMapCursor
Visibility of Browse map cursor.
Definition: ApplicationApi.h:1437
LONG lLeft
lLeft determines left border of rectangle (geographical longitude).
Definition: ApplicationApi.h:1188
int bMaxSpeedWarn
Enable acoustic speed exceeding warning.
Definition: ApplicationApi.h:1478
BYTE nValidityMinute
Minute. Validity time, till which the event remains active. After this time is the event deleted...
Definition: ApplicationApi.h:2137
LONGRECT struct bounds rectangle area on map. See Coordinates conversion section in TROUBLESHOOTING p...
Definition: ApplicationApi.h:1177
int nTruckWidth
Vehicle width [mm].
Definition: ApplicationApi.h:1528
BYTE nValidityDay
Day. Validity time, till which the event remains active. After this time is the event deleted...
Definition: ApplicationApi.h:2133
BOOL bPhotosEnabled
Flag determining if the Photos service is enabled.
Definition: ApplicationApi.h:2150
Summary description for DirectionInfo.
Definition: ApplicationApi.h:1957
LONG lRight
lRight determines right border of rectangle (geographical longitude).
Definition: ApplicationApi.h:1192
BOOL bOperateRightHanded
Flag effecting Drive appearance.
Definition: ApplicationApi.h:1266
int * pDistToWP
Array of estimated distances to remaining waypoints from actual position.
Definition: ApplicationApi.h:1909
int UsedForFix
Used for fix.
Definition: ApplicationApi.h:1761
Definition: ApplicationApi.h:683
LONG lTotalDistance
Total distance of route in meters.
Definition: ApplicationApi.h:1866
Definition: ApplicationApi.h:1002
int nSignpostSize
Displayed signposts size.
Definition: ApplicationApi.h:1468
int nTruckTridemWeight
Tridem axle weight [kg].
Definition: ApplicationApi.h:1506
BOOL bTTSEnabled
Selected sound is TTS.
Definition: ApplicationApi.h:1480
int nKingpinEndTrailer
Kingpin to end of trailer (last trailer if applicable) [mm].
Definition: ApplicationApi.h:1524
NpMessageAvoidMotorwaysUnable commands Drive to notice user that not all motorways can be avoided...
Definition: ApplicationApi.h:202
LONG lRemaningTime
Remaining time to arrival.
Definition: ApplicationApi.h:1893
BYTE nValidityHour
Hour. Validity time, till which the event remains active. After this time is the event deleted...
Definition: ApplicationApi.h:2135
DWORD dwID
Unique ID of a waypoint.
Definition: ApplicationApi.h:1597
BOOL bFriendsEnabled
Flag determining if the Friends service is enabled.
Definition: ApplicationApi.h:2156
BOOL bSearchAddress
[in] Flag determining whether function processing instance of this class searches for address (for ex...
Definition: ApplicationApi.h:1571
LONGRECT()
Definition: ApplicationApi.h:1180
The STmcEvent structure defines a single TMC event on a location.
Definition: ApplicationApi.h:2041
Definition: ApplicationApi.h:187
int nCode
Error code.
Definition: ApplicationApi.h:2214
LONG lFromPointOffset
Offset of start graph point of the current road segment.
Definition: ApplicationApi.h:1816
LONG lTotalTime
Total time of the route.
Definition: ApplicationApi.h:1898
Definition: ApplicationApi.h:227
SSatelliteInfo structure is used to obtain information about satellites.
Definition: ApplicationApi.h:1750
LONG lRemainingDistance
Distance from actual position to finish of the route in meters.
Definition: ApplicationApi.h:1868
int nRadarDistanceInCity
The distance from speed camera, in which the warning is enabled (range 1..10) in city.
Definition: ApplicationApi.h:1416
LONG lRoadOffset
Road offset is an unique identificator of the road in map. This identificator is used for special rou...
Definition: ApplicationApi.h:1921
BOOL bUserAvoid
Defines if the route computing should always avoid this event.
Definition: ApplicationApi.h:2126
LONGPOSITION()
Constructor of LONGPOSITION.
Definition: ApplicationApi.h:1143
int nTruckMaxSpeed
Truck max speed [km/h].
Definition: ApplicationApi.h:1497
LONG lX
Determines geographical longitude (X coordinate) of the event in world degrees multiplied by 100 000...
Definition: ApplicationApi.h:2114
int nEventCode
Code of the TMC event from the EventCode enumeration.
Definition: ApplicationApi.h:2119
LONGPOSITION structure determines location on map. See Coordinates conversion section in TROUBLESHOOT...
Definition: ApplicationApi.h:1135
int Elevation
Satellite elevation in degrees.
Definition: ApplicationApi.h:1753
BOOL bAllowItineraryEdit
Flag determining whether the user will be allowed to edit itinerary manually.
Definition: ApplicationApi.h:1551
Definition: ApplicationApi.h:884
Definition: ApplicationApi.h:2233
int nKeyboardType
Flag determining keyboard type.
Definition: ApplicationApi.h:1321
int nRadarDistance
The distance from speed camera, in which the warning is enabled (range 1..10)
Definition: ApplicationApi.h:1408
Definition: ApplicationApi.h:966
SPoiCategory structure specifies a POI category.
Definition: ApplicationApi.h:1678
CApplicationMenu class defines menu items which can be accessed by OnMenuCommand function.
Definition: ApplicationApi.h:530
int nTrailerLength
Trailer Length [mm].
Definition: ApplicationApi.h:1516
LONGPOSITION cpLocation
LONGPOSITION struct determining POI location on map.
Definition: ApplicationApi.h:1654
Definition: ApplicationApi.h:589