SYRoute Class Reference

Collection of maneuvers and roadElements connecting two or more waypoints. Waypoints may be thought of as the input to a route calculation whereas maneuvers are the results of calculating a route. More...

#import <SYRouting.h>

Inheritance diagram for SYRoute:
Collaboration diagram for SYRoute:

Public Types

typedef void(^ SYRouteGeometryGetterComplectionBlock) (NSArray< SYGeoCoordinate * > *_Nullable geometry)
 Type of completion block for asynchronous getting of geometries with altitude. More...
 
typedef void(^ SYRouteGetTransitCountriesCompletion) (NSArray< SYTransitCountryInfo * > *_Nullable infos)
 Type of completion block for asynchronous getting of transit countries info. More...
 
typedef void(^ SYRouteGetWarningsCompletionBlock) (NSArray< SYRouteWarning * > *_Nullable warnings)
 

Instance Methods

(nonnull NSSet< NSNumber * > *) - availableAvoidsInCountry:
 Returns set of road avoids (SYAvoidType) available in specified country. More...
 
(void) - getRouteElementsWithCompletion:
 The SYRouteElements on the route. More...
 
(void) - getRouteGeometryWithAltitude:completion:
 Provides an array of coordinates (with or without altitude) representing the geometry of the route through completion block. More...
 
(nullable NSArray< SYGeoPolyline * > *) - getPolylinesFromRouteSegments:
 Converts an array of SYRouteSegment to the array of SYGeoPolyline. More...
 
(void) - getTransitCountriesInfoWithCompletion:
 Provides information about transit countries with country ISO code and regions, if available. More...
 
(void) - getWarningsWithCompletion:
 Get warnings occurred during computing this route. Will complete with nonnull result, if computing has finished with SYRoutingResultSuccessWithWarnings. More...
 

Properties

SYRouteInfoinfo
 Basic route info. More...
 
NSArray< SYManeuver * > * maneuvers
 The SYManeuvers on the route. More...
 
SYRouteRequestrequest
 The original SYRouteRequest with which was route computed. More...
 
SYGeoBoundingBoxbox
 The smallest SYGeoBoundingBox that contains the entire route. More...
 
NSArray< SYWaypoint * > * waypoints
 List of SYWaypoints on the route. More...
 

Detailed Description

Collection of maneuvers and roadElements connecting two or more waypoints. Waypoints may be thought of as the input to a route calculation whereas maneuvers are the results of calculating a route.

Member Typedef Documentation

◆ SYRouteGeometryGetterComplectionBlock

- (typedef void(^ SYRouteGeometryGetterComplectionBlock) (NSArray< SYGeoCoordinate * > *_Nullable geometry))

Type of completion block for asynchronous getting of geometries with altitude.

◆ SYRouteGetTransitCountriesCompletion

- (typedef void(^ SYRouteGetTransitCountriesCompletion) (NSArray< SYTransitCountryInfo * > *_Nullable infos))

Type of completion block for asynchronous getting of transit countries info.

◆ SYRouteGetWarningsCompletionBlock

- (typedef void(^ SYRouteGetWarningsCompletionBlock) (NSArray< SYRouteWarning * > *_Nullable warnings))

Method Documentation

◆ availableAvoidsInCountry:

- (nonnull NSSet<NSNumber*>*) availableAvoidsInCountry: (nonnull SYCountryIso *)  country

Returns set of road avoids (SYAvoidType) available in specified country.

◆ getRouteElementsWithCompletion:

- (void) getRouteElementsWithCompletion: (getRouteElements(completion:))  NS_SWIFT_NAME

The SYRouteElements on the route.

◆ getRouteGeometryWithAltitude:completion:

- (void) getRouteGeometryWithAltitude: (BOOL)  withAltitude
completion: (nonnull SYRouteGeometryGetterComplectionBlock completion 

Provides an array of coordinates (with or without altitude) representing the geometry of the route through completion block.

Parameters
withAltitudeindicates that altitude information is requested
completioncallback to receive geometry.

◆ getPolylinesFromRouteSegments:

- (nullable NSArray<SYGeoPolyline*>*) getPolylinesFromRouteSegments: (nonnull NSArray< SYRouteSegment * > *)  routeSegments

Converts an array of SYRouteSegment to the array of SYGeoPolyline.

◆ getTransitCountriesInfoWithCompletion:

- (void) getTransitCountriesInfoWithCompletion: (nonnull SYRouteGetTransitCountriesCompletion completion

Provides information about transit countries with country ISO code and regions, if available.

Parameters
completioncallback to receive transit countries info.

◆ getWarningsWithCompletion:

- (void) getWarningsWithCompletion: (nonnull SYRouteGetWarningsCompletionBlock completion

Get warnings occurred during computing this route. Will complete with nonnull result, if computing has finished with SYRoutingResultSuccessWithWarnings.

Property Documentation

◆ info

- (SYRouteInfo*) info
readnonatomicassign

Basic route info.

◆ maneuvers

- (NSArray<SYManeuver*>*) maneuvers
readnonatomicassign

The SYManeuvers on the route.

◆ request

- (SYRouteRequest*) request
readnonatomicassign

The original SYRouteRequest with which was route computed.

◆ box

- (SYGeoBoundingBox*) box
readnonatomicassign

The smallest SYGeoBoundingBox that contains the entire route.

◆ waypoints

- (NSArray<SYWaypoint*>*) waypoints
readnonatomicassign

List of SYWaypoints on the route.


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