<SYRoutingDelegate> Protocol Reference

Represents a delegate to handle SYRoute route calculation updates. More...

#import <SYRouting.h>

Inheritance diagram for <SYRoutingDelegate>:
Collaboration diagram for <SYRoutingDelegate>:

Instance Methods

(void) - routing:didUpdateComputingProgress:onRoute:
 Callback for reporting the progress of route calculation, values range from 0.0 (starting) to 1.0 (complete). More...
 
(void) - routingDidStartRouteComputing:
 Callback upon completion of route calculation. More...
 
(void) - routing:didComputePrimaryRoute:
 Callback when a primary route has been calculated. More...
 
(void) - routing:didComputeAlternativeRoute:
 Callback when a alternative route has been calculated. More...
 
(void) - routing:computingFailedWithError:
 Callback when route calculation fails. More...
 
(void) - routingDidFinishRouteCompute:
 Called when compute did finished with success after computeRoute: call. More...
 
(void) - routingDidStartRouteRecompute:
 Called when re-compute did star due to vehicle position change. More...
 
(void) - routing:didComputeDurations:for:
 Called when computeNextTimes did finished. More...
 
(void) - routing:didFinishRouteRecompute:
 Called when re-compute did finished with success. More...
 

Detailed Description

Represents a delegate to handle SYRoute route calculation updates.

Method Documentation

◆ routing:computingFailedWithError:()

- (void) routing: (nonnull SYRouting *)  routing
computingFailedWithError: (SYRoutingError)  error 
optional

Callback when route calculation fails.

Parameters
routingSYRouting object
errorSYRoutingError type

◆ routing:didComputeAlternativeRoute:()

- (void) routing: (nonnull SYRouting *)  routing
didComputeAlternativeRoute: (nullable SYRoute *)  route 
optional

Callback when a alternative route has been calculated.

Parameters
routingSYRouting object
routeSYRoute object.

◆ routing:didComputeDurations:for:()

- (void) routing: (nonnull SYRouting *)  routing
didComputeDurations: (nonnull NSArray< NSNumber * > *)  durations
for: (nonnull SYRoute *)  route 
optional

Called when computeNextTimes did finished.

Parameters
routingSYRouting object.
durationsarray of durations in NSTimeInterval.
routeSYRoute object.

◆ routing:didComputePrimaryRoute:()

- (void) routing: (nonnull SYRouting *)  routing
didComputePrimaryRoute: (nullable SYRoute *)  route 
optional

Callback when a primary route has been calculated.

Parameters
routingSYRouting object.
routeSYRoute object.

◆ routing:didFinishRouteRecompute:()

- (void) routing: (nonnull SYRouting *)  routing
didFinishRouteRecompute: (nonnull SYRoute *)  route 
optional

Called when re-compute did finished with success.

Parameters
routingSYRouting object.
routecomputed route with start point at current location.

◆ routing:didUpdateComputingProgress:onRoute:()

- (void) routing: (nonnull SYRouting *)  routing
didUpdateComputingProgress: (float)  progress
onRoute: (NSUInteger)  routeIndex 
optional

Callback for reporting the progress of route calculation, values range from 0.0 (starting) to 1.0 (complete).

Parameters
routingSYRouting object.
progressThe progress of the current routing operation.
routeIndexComputed route index.

◆ routingDidFinishRouteCompute:()

- (void) routingDidFinishRouteCompute: (nonnull SYRouting *)  routing
optional

Called when compute did finished with success after computeRoute: call.

Parameters
routingSYRouting object.

◆ routingDidStartRouteComputing:()

- (void) routingDidStartRouteComputing: (nonnull SYRouting *)  routing
optional

Callback upon completion of route calculation.

Parameters
routingSYRouting object

◆ routingDidStartRouteRecompute:()

- (void) routingDidStartRouteRecompute: (nonnull SYRouting *)  routing
optional

Called when re-compute did star due to vehicle position change.

Parameters
routingSYRouting object.

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