CartoTypeNavigatorParam Class Reference

#import <CartoTypeRouter.h>

Inheritance diagram for CartoTypeNavigatorParam:

Instance Methods
(void *)	- getNavigatorParam

Properties
int	minimumFixDistance
int	routeDistanceTolerance
int	routeTimeTolerance
bool	autoReRoute
bool	navigationEnabled

Detailed Description

Parameters governing navigation behavior.

Method Documentation

getNavigatorParam

- (void *) getNavigatorParam

(for internal use) Gets a pointer to the underlying C++ object.

Property Documentation

autoReRoute

- (bool) autoReRoute

readwritenonatomicassign

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.

minimumFixDistance

- (int) minimumFixDistance

readwritenonatomicassign

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

navigationEnabled

- (bool) navigationEnabled

readwritenonatomicassign

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.

routeDistanceTolerance

- (int) routeDistanceTolerance

readwritenonatomicassign

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

routeTimeTolerance

- (int) routeTimeTolerance

readwritenonatomicassign

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

---

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

• CartoTypeRouter.h