SYRouting Class Reference

Contains classes, protocols, and enumerations for describing and calculating routes. More...

#import <SYRouting.h>

Inheritance diagram for SYRouting:

Collaboration diagram for SYRouting:

Instance Methods
(void)	- computeRouteFromJson:
	Method will compute route from json string obtained from [SYRouteQuickInfo serialize]. More...
(void)	- computeRoute:to:via:withOptions:
	This method will compute full SYRoute. More...
(void)	- recomputeRoute:
	Recompute route, for example when dynamicPenalty has been changed. More...
(void)	- cancelComputing
	Cancel current computing request. More...
(void)	- computeNextTimes:in:
	Method will compute route durations in specified day time based on speed profiles and current traffic. More...
(void)	- computeEVRoute:to:via:withOptions:withEVProfile:
	This method will compute full EV SYRoute. Computed route could contain additional SYChargingWaypoint-s. More...
(void)	- computeEVRangeFromPosition:withCapacities:withOptions:withEVProfile:withCompletion:
	This method will compute routes in all direction f rom position, and returs polygon area where you can go with your battery capacity. You can get multiple polygons for different capacities in one call. More...
(nullable NSArray< SYChargingWaypoint * > *)	- chargingStationsFromRoute:

Properties
id< SYRoutingDelegate >	delegate
	Delegate for for notification about route compute progress or state. More...
Sygic::Router::RouteID::Handle	computeJobId [implementation]

Detailed Description

Contains classes, protocols, and enumerations for describing and calculating routes.

Method Documentation

cancelComputing()

- (void) cancelComputing

Cancel current computing request.

chargingStationsFromRoute:()

- (nullable NSArray<SYChargingWaypoint*>*) chargingStationsFromRoute:

(nonnull SYRoute *)

route

Parameters

route

ev route from which to extract stations

Returns

ChargingWaypoins from ev route

computeEVRangeFromPosition:withCapacities:withOptions:withEVProfile:withCompletion:()

- (void) computeEVRangeFromPosition:		(nonnull SYGeoCoordinate *)	position
withCapacities:		(nonnull NSArray< NSNumber * > *)	capacities
withOptions:		(nullable SYRoutingOptions *)	options
withEVProfile:		(nonnull SYEVProfile *)	profile
withCompletion:		(nonnull void(^)(NSArray< NSArray< SYGeoCoordinate * > * > *_Nullable polygons, NSNumber *_Nullable error))	completion

This method will compute routes in all direction f rom position, and returs polygon area where you can go with your battery capacity. You can get multiple polygons for different capacities in one call.

Parameters

position	Geographical position from which calculation starts
capacities	List of battery capacities as a start values for computation
options	SYRoutingOptions if needed
profile	electric car profile
completion	callback to recieve polygons, NSNumber is error value SYRoutingError in case of error, otherwise nil

computeEVRoute:to:via:withOptions:withEVProfile:()

- (void) computeEVRoute:		(nonnull SYWaypoint *)	from
to:		(nonnull SYWaypoint *)	to
via:		(nullable NSArray< SYWaypoint * > *)	waypoints
withOptions:		(nullable SYRoutingOptions *)	options
withEVProfile:		(nonnull SYEVProfile *)	profile

This method will compute full EV SYRoute. Computed route could contain additional SYChargingWaypoint-s.

Parameters

from	Start point
to	Destination
waypoints	Waypoints between start and destination
options	SYRoutingOptions if needed
profile	electric car profile

computeNextTimes:in:()

- (void) computeNextTimes:		(nonnull SYRoute *)	route
in:		(nonnull NSArray< NSDate * > *)	times

Method will compute route durations in specified day time based on speed profiles and current traffic.

Parameters

route	Route to compute durations on.
times	Array of times.

computeRoute:to:via:withOptions:()

- (void) computeRoute:		(nonnull SYWaypoint *)	from
to:		(nonnull SYWaypoint *)	to
via:		(nullable NSArray< SYWaypoint * > *)	waypoints
withOptions:		(nullable SYRoutingOptions *)	options

This method will compute full SYRoute.

Parameters

from	Start point
to	Destination
waypoints	Waypoints between start and destination
options	SYRoutingOptions if needed

computeRouteFromJson:()

- (void) computeRouteFromJson:

(nonnull NSString *)

json

Method will compute route from json string obtained from [SYRouteQuickInfo serialize].

Parameters

json	NSString object representation.

recomputeRoute:()

- (void) recomputeRoute:

(nonnull SYRoute *)

route

Recompute route, for example when dynamicPenalty has been changed.

Parameters

route

SYRoute object.

Property Documentation

computeJobId

- Router:

readwritenonatomicassignimplementation

delegate

- (id<SYRoutingDelegate>) delegate

readwritenonatomicweak

Delegate for for notification about route compute progress or state.

---

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

• SYRouting.h