NCRouteOptions Class Reference

Class is used for describing routing options of AsyncRouteManager. More...

#include <com/navigine/idl/objc/NCRouteOptions.h>

Inherits NSObject.

Instance Methods
(nonnull instancetype)	- initWithSmoothRadius:maxProjectionDistance:maxAdvance:
	Default constructor for class NCRouteOptions.
(nonnull instancetype)	- init
	Default constructor for class NCRouteOptions.

Class Methods
(nonnull instancetype)	+ routeOptionsWithSmoothRadius:maxProjectionDistance:maxAdvance:
	Factory method for class NCRouteOptions.
(nonnull instancetype)	+ routeOptions
	Factory method for class NCRouteOptions.

Properties
double	smoothRadius
	This parameter controls if the resulting route should be smoothed for better user experience. It can be considered as the maximum distance (in meters) by which the smoothed route can deviate from the original route. The original route follows exactly the edges of the route graph. If you don't want the route to be smoothed, use value 0.
double	maxProjectionDistance
	This parameter controls the router behaviour in case if the position essentially deviates from the proposed route. If the position deviates more than the specified distance (in meters), then the route will be rebuilt. You should not set the maxProjectionDistance value too low. The reasonable interval of values is [3, 10].
double	maxAdvance
	This parameter controls the maximum distance (in meters) that a position can advance along the route between the two consecutive navigation solutions separated in time by 1 second. If this constraint is broken, the route will be completely rebuilt. The reasonable interval of values is [1, 3].

Detailed Description

Class is used for describing routing options of AsyncRouteManager.

Referenced from: AsyncRouteManager.

Swift code snippet:

        // Empty init uses IDL defaults (0 / 5 / 2); full init for custom values.
        let routeOptions = NCRouteOptions(smoothRadius: 3.0, maxProjectionDistance: 7.0, maxAdvance: 2.5)
        print("Created route options with smoothRadius: \‍(routeOptions.smoothRadius), maxProjectionDistance: \‍(routeOptions.maxProjectionDistance), maxAdvance: \‍(routeOptions.maxAdvance)")

Objective C code snippet:

    // Empty init uses IDL defaults (0 / 5 / 2); full init for custom values.
    NCRouteOptions *routeOptions = [[NCRouteOptions alloc] initWithSmoothRadius:3.0 maxProjectionDistance:7.0 maxAdvance:2.5];
    NSLog(@"Created route options with smoothRadius: %f, maxProjectionDistance: %f, maxAdvance: %f",
          routeOptions.smoothRadius, routeOptions.maxProjectionDistance, routeOptions.maxAdvance);

Definition at line 27 of file NCRouteOptions.h.

Method Documentation

init

- (nonnull instancetype) init

Default constructor for class NCRouteOptions.

initWithSmoothRadius:maxProjectionDistance:maxAdvance:

- (nonnull instancetype) initWithSmoothRadius:		(double)	smoothRadius
maxProjectionDistance:		(double)	maxProjectionDistance
maxAdvance:		(double)	maxAdvance

Default constructor for class NCRouteOptions.

routeOptions

+ (nonnull instancetype) routeOptions

Factory method for class NCRouteOptions.

routeOptionsWithSmoothRadius:maxProjectionDistance:maxAdvance:

+ (nonnull instancetype) routeOptionsWithSmoothRadius:		(double)	smoothRadius
maxProjectionDistance:		(double)	maxProjectionDistance
maxAdvance:		(double)	maxAdvance

Factory method for class NCRouteOptions.

Property Documentation

maxAdvance

- (double) maxAdvance

readnonatomicassign

This parameter controls the maximum distance (in meters) that a position can advance along the route between the two consecutive navigation solutions separated in time by 1 second. If this constraint is broken, the route will be completely rebuilt. The reasonable interval of values is [1, 3].

Definition at line 76 of file NCRouteOptions.h.

maxProjectionDistance

- (double) maxProjectionDistance

readnonatomicassign

This parameter controls the router behaviour in case if the position essentially deviates from the proposed route. If the position deviates more than the specified distance (in meters), then the route will be rebuilt. You should not set the maxProjectionDistance value too low. The reasonable interval of values is [3, 10].

Definition at line 68 of file NCRouteOptions.h.

smoothRadius

- (double) smoothRadius

readnonatomicassign

This parameter controls if the resulting route should be smoothed for better user experience. It can be considered as the maximum distance (in meters) by which the smoothed route can deviate from the original route. The original route follows exactly the edges of the route graph. If you don't want the route to be smoothed, use value 0.

Definition at line 60 of file NCRouteOptions.h.

---

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

• NCRouteOptions.h