NCRouteManager Class Reference

Class is used for evaluating RoutePath from point to point. More...

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

Inherits NSObject.

Instance Methods
(nullable NCRoutePath *)	- makeRoute:to:
	Method is used to build a route between points about evaluated RoutePath from your position to target point.
(nonnull NSArray< NCRoutePath * > *)	- makeRoutes:to:
	Method is used to build a route between the starting point and several destination points.
(void)	- setTarget:
	Method is used to set target point in your location. Through RouteListener you will be notified about new paths to target point.
(void)	- addTarget:
	Method is used to add target point in your location. Through RouteListener you will be notified about new paths to target point.
(void)	- cancelTarget
	Method is used for removing current target points to where the routes were built.
(void)	- clearTargets
	Method is used for removing all target points to where the routes were built.
(void)	- setGraphTag:
	Method is used to select graph tag (Default: "default").
(nonnull NSString *)	- getGraphTag
	Method is used to get current graph tag (Default: "default").
(nonnull NSArray< NSString * > *)	- getGraphTags
	Method is used to get all graph tags,.
(void)	- addRouteListener:
	Method is used to add RouteListener class element which will notify about evaluated route path from your position to target point.
(void)	- removeRouteListener:
	Method is used for removing previously added RouteListener class element.

Detailed Description

Class is used for evaluating RoutePath from point to point.

Referenced from NavigineSdk.

Definition at line 20 of file NCRouteManager.h.

Method Documentation

addRouteListener:

- (void) addRouteListener:

(nullable id< NCRouteListener >)

listener

Method is used to add RouteListener class element which will notify about evaluated route path from your position to target point.

Note

Do not forget to remove listener if it is no longer needed!

Parameters

listener

Сorresponding RouteListener class.

addTarget:

- (void) addTarget:

(nonnull NCLocationPoint *)

target

Method is used to add target point in your location. Through RouteListener you will be notified about new paths to target point.

Parameters

target

finish LocationPoint.

cancelTarget

- (void) cancelTarget

Method is used for removing current target points to where the routes were built.

clearTargets

- (void) clearTargets

Method is used for removing all target points to where the routes were built.

getGraphTag

- (nonnull NSString *) getGraphTag

Method is used to get current graph tag (Default: "default").

getGraphTags

- (nonnull NSArray< NSString * > *) getGraphTags

Method is used to get all graph tags,.

makeRoute:to:

- (nullable NCRoutePath *) makeRoute:		(nonnull NCLocationPoint *)	from
to:		(nonnull NCLocationPoint *)	to

Method is used to build a route between points about evaluated RoutePath from your position to target point.

Parameters

from	starting LocationPoint.
to	destination LocationPoint.

Returns

RoutePath from starting to destination point.

makeRoutes:to:

- (nonnull NSArray< NCRoutePath * > *) makeRoutes:		(nonnull NCLocationPoint *)	from
to:		(nonnull NSArray< NCLocationPoint * > *)	to

Method is used to build a route between the starting point and several destination points.

Parameters

from	starting LocationPoint.
to	destination list of LocationPoints.

Returns

vector of RoutePaths from starting to destination point.

removeRouteListener:

- (void) removeRouteListener:

(nullable id< NCRouteListener >)

listener

Method is used for removing previously added RouteListener class element.

Parameters

listener

Сorresponding RouteListener class to remove.

setGraphTag:

- (void) setGraphTag:

(nonnull NSString *)

tag

Method is used to select graph tag (Default: "default").

setTarget:

- (void) setTarget:

(nonnull NCLocationPoint *)

target

Method is used to set target point in your location. Through RouteListener you will be notified about new paths to target point.

Parameters

target

finish LocationPoint.

---

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

• NCRouteManager.h