com.navigine.idl.java.RouteOptions Class Reference

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

Public Member Functions
	RouteOptions (double smoothRadius, double maxProjectionDistance, double maxAdvance)
	Default constructor for class RouteOptions.
	RouteOptions ()
	Default constructor for class RouteOptions.
double	getSmoothRadius ()
	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	getMaxProjectionDistance ()
	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	getMaxAdvance ()
	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].
String	toString ()

Detailed Description

Class is used for describing routing options of AsyncRouteManager.

Referenced from: AsyncRouteManager.

Java code snippet:

        // Empty ctor uses IDL defaults (0 / 5 / 2); full ctor for custom values.
        RouteOptions routeOptions = new RouteOptions(3.0, 7.0, 2.5);
        System.out.println("Created route options with smoothRadius: " + routeOptions.getSmoothRadius() +
                          ", maxProjectionDistance: " + routeOptions.getMaxProjectionDistance() +
                          ", maxAdvance: " + routeOptions.getMaxAdvance());

Kotlin code snippet:

        // Empty ctor uses IDL defaults (0 / 5 / 2); full ctor for custom values.
        val routeOptions = RouteOptions(3.0, 7.0, 2.5)
        println("Created route options with smoothRadius: ${routeOptions.smoothRadius}, maxProjectionDistance: ${routeOptions.maxProjectionDistance}, maxAdvance: ${routeOptions.maxAdvance}")

Definition at line 25 of file RouteOptions.java.

Constructor & Destructor Documentation

RouteOptions() [1/2]

com.navigine.idl.java.RouteOptions.RouteOptions ( double smoothRadius, double maxProjectionDistance, double maxAdvance )

inline

Default constructor for class RouteOptions.

Definition at line 37 of file RouteOptions.java.

RouteOptions() [2/2]

com.navigine.idl.java.RouteOptions.RouteOptions ( )

inline

Default constructor for class RouteOptions.

Definition at line 49 of file RouteOptions.java.

Member Function Documentation

getMaxAdvance()

double com.navigine.idl.java.RouteOptions.getMaxAdvance ( )

inline

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].

Returns

Definition at line 80 of file RouteOptions.java.

getMaxProjectionDistance()

double com.navigine.idl.java.RouteOptions.getMaxProjectionDistance ( )

inline

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].

Returns

Definition at line 70 of file RouteOptions.java.

getSmoothRadius()

double com.navigine.idl.java.RouteOptions.getSmoothRadius ( )

inline

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.

Returns

Definition at line 60 of file RouteOptions.java.

toString()

String com.navigine.idl.java.RouteOptions.toString ( )

inline

Definition at line 85 of file RouteOptions.java.

---

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

• RouteOptions.java