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)	- computeRouteForRequest:
	This method will compute full SYRoute. More...

(void)	- computeRoute:to:via:withOptions:
	This method will compute full SYRoute. More...

(void)	- computeGuidedRouteWithPolyline:options:
	This method will recreate route from dense set of GPS points. 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)	- computeEVRouteFrom:to:via:options:profile:preferences:
	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 directions from the position, and returns a polygon of where you can go with your battery capacity. You can get multiple polygons for different capacities in one call. More...

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

(double)	- getRemainingBatteryCapacityAtWaypoint:profile:route:

(void)	- computeAETRRoute:to:via:withOptions:withAETRProfile:
	This method will compute a SYRoute which fulfills AETR requirements for regular rest. Computed route may contain additional waypoints for rest. More...

Properties
id< SYRoutingDelegate >	delegate
	Delegate for for notification about route compute progress or state. More...

Detailed Description

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

Method Documentation

◆ computeRouteFromJson:

- (void) computeRouteFromJson: (nonnull NSString *) json

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

Parameters

json	NSString object representation.

◆ computeRouteForRequest:

- (void) computeRouteForRequest: (nonnull SYRouteRequest *) request

This method will compute full SYRoute.

Parameters

request Route request

◆ computeRoute:to:via:withOptions:

- (void) computeRoute:	(nonnull SYWaypoint *)	from
to:	(nonnull SYWaypoint *)	to
via:	(nullable NSArray< SYWaypoint * > *)	waypoints
withOptions:	("Use computeRouteForRequest instead")	__deprecated_msg

This method will compute full SYRoute.

Parameters

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

◆ computeGuidedRouteWithPolyline:options:

- (void) computeGuidedRouteWithPolyline:	(nonnull NSArray< SYGeoCoordinate * > *)	polyline
options:	("Use computeRouteForRequest instead")	__deprecated_msg

This method will recreate route from dense set of GPS points.

Parameters

polyline	Guided route GPS points
options	SYRoutingOptions if needed

◆ cancelComputing

- (void) cancelComputing

Cancel current computing request.

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

◆ computeEVRoute:to:via:withOptions:withEVProfile:

- (void) computeEVRoute:	(nonnull SYWaypoint *)	from
to:	(nonnull SYWaypoint *)	to
via:	(nullable NSArray< SYWaypoint * > *)	waypoints
withOptions:	(nullable SYRoutingOptions *)	options
withEVProfile:	("Use computeRouteForRequest instead")	__deprecated_msg

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

◆ computeEVRouteFrom:to:via:options:profile:preferences:

- (void) computeEVRouteFrom:	(nonnull SYWaypoint *)	from
to:	(nonnull SYWaypoint *)	to
via:	(nullable NSArray< SYWaypoint * > *)	waypoints
options:	(nullable SYRoutingOptions *)	options
profile:	(nonnull SYEVProfile *)	profile
preferences:	("Use computeRouteForRequest instead")	__deprecated_msg

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
preferences

◆ 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 directions from the position, and returns a polygon of 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 in kWh as start values for the 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

◆ chargingStationsFromRoute:

- (nullable NSArray<SYChargingWaypoint*>*) chargingStationsFromRoute: (nonnull SYRoute *) route

Parameters

route ev route from which to extract stations

Returns: ChargingWaypoins from ev route

◆ getRemainingBatteryCapacityAtWaypoint:profile:route:

- (double) getRemainingBatteryCapacityAtWaypoint:	(nonnull SYWaypoint *)	waypoint
profile:	(nonnull SYEVProfile *)	profile
route:	(nonnull SYRoute *)	route

Parameters

waypoint	on route
profile	starting battery profile
route	ev route

Returns: remaining battery capacity (kwh) at given waypoint at route based on starting ev profile

◆ computeAETRRoute:to:via:withOptions:withAETRProfile:

- (void) computeAETRRoute:	(nonnull SYWaypoint *)	from
to:	(nonnull SYWaypoint *)	to
via:	(nullable NSArray< SYWaypoint * > *)	waypoints
withOptions:	(nullable SYRoutingOptions *)	options
withAETRProfile:	("Use computeRouteForRequest instead")	__deprecated_msg

This method will compute a SYRoute which fulfills AETR requirements for regular rest. Computed route may contain additional waypoints for rest.

Parameters

from	Start point
to	Destination
waypoints	Waypoints between start and destination
options	SYRoutingOptions if needed
profile	AETR profile, current state and settings

Property Documentation

◆ 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

Instance Methods

Properties

Detailed Description

Method Documentation

◆ computeRouteFromJson:

◆ computeRouteForRequest:

◆ computeRoute:to:via:withOptions:

◆ computeGuidedRouteWithPolyline:options:

◆ cancelComputing

◆ computeNextTimes:in:

◆ computeEVRoute:to:via:withOptions:withEVProfile:

◆ computeEVRouteFrom:to:via:options:profile:preferences:

◆ computeEVRangeFromPosition:withCapacities:withOptions:withEVProfile:withCompletion:

◆ chargingStationsFromRoute:

◆ getRemainingBatteryCapacityAtWaypoint:profile:route:

◆ computeAETRRoute:to:via:withOptions:withAETRProfile:

Property Documentation

◆ delegate