CartoType C++ API 7.8.2, 2022-03-25
for Windows, Linux, Qt and other platforms supporting C++ development
Public Attributes | List of all members
CartoType::TNavigatorParam Class Reference

#include <cartotype_navigation.h>

Public Attributes

int32_t iMinimumFixDistance = 5
int32_t iRouteDistanceTolerance = 20
int32_t iRouteTimeTolerance = 30
bool iAutoReRoute = true
bool iNavigationEnabled = true

Detailed Description

Parameters governing navigation behavior.

Member Data Documentation

◆ iAutoReRoute

bool CartoType::TNavigatorParam::iAutoReRoute = true

True if route is recalculated automatically when the vehicle goes off route (the default). If not, the state TNavigationState::ReRouteNeeded is entered and the route is recalculated the next time the user provides a navigation fix. This gives the application time to issue a warning if the routing algorithm is likely to be slow.

◆ iMinimumFixDistance

int32_t CartoType::TNavigatorParam::iMinimumFixDistance = 5

Minimum distance between location fixes in metres that is taken as an actual move.

◆ iNavigationEnabled

bool CartoType::TNavigatorParam::iNavigationEnabled = true

If true, and if there is a route, the position on route is updated and turn information is created, when a position update arrives. If false, the vehicle position and speed are updated but other behaviour is the same as if there is no route.

◆ iRouteDistanceTolerance

int32_t CartoType::TNavigatorParam::iRouteDistanceTolerance = 20

Maximum distance from the route in metres before the vehicle is deemed off-route.

◆ iRouteTimeTolerance

int32_t CartoType::TNavigatorParam::iRouteTimeTolerance = 30

Maximum time off route in seconds before a new route needs to be calculated.

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