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:

Instance Methods
(nonnull NSSet< NSNumber * > *)	- availableAvoidsInCountry:
	Returns set of road avoids available in specified country. More...
(SYEVProfile *profile)	- __deprecated_msg
	The original SYEVProfile with which was route computed. Set only for EV route. More...
(SYRoutingOptions *options)	- __deprecated_msg
	The routing options. Check the available SYRoutingOptions. More...
(void)	- getRouteElementsWithCompletion:
	The SYRouteElements on the route. More...
(nullable NSArray< SYGeoCoordinate * > *)	- getRouteGeometry
	Returns an array of coordinates representing the geometry of the route. More...
(nullable NSArray< SYGeoPolyline * > *)	- getPolylinesFromRouteSegments:
	Converts an array of SYRouteSegment to the array of SYGeoPolyline. More...

Properties
SYRouteInfo *	info
	Basic route info. More...
NSArray< SYManeuver * > *	maneuvers
	The SYManeuvers on the route. More...
NSArray< SYCountryIso * > *	transitCountries
	Returns route's transit countries iso codes. More...
SYRouteViolatedAvoidOptions *	optionsViolation
	The routing options violation for both global route options and per-country options. More...
SYRouteRequest *	request
	The original SYRouteRequest with which was route computed. More...
SYGeoBoundingBox *	box
	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.

Method Documentation

availableAvoidsInCountry:

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

(nonnull SYCountryIso *)

country

Returns set of road avoids available in specified country.

__deprecated_msg [1/2]

- (SYEVProfile* profile) __deprecated_msg

("Use request instead")

The original SYEVProfile with which was route computed. Set only for EV route.

__deprecated_msg [2/2]

- (SYRoutingOptions* options) __deprecated_msg

("Use request instead")

The routing options. Check the available SYRoutingOptions.

getRouteElementsWithCompletion:

- (void) getRouteElementsWithCompletion:

(getRouteElements(completion:))

NS_SWIFT_NAME

The SYRouteElements on the route.

getRouteGeometry

- (nullable NSArray<SYGeoCoordinate*>*) getRouteGeometry

Returns an array of coordinates representing the geometry of the route.

getPolylinesFromRouteSegments:

- (nullable NSArray<SYGeoPolyline*>*) getPolylinesFromRouteSegments:

(nonnull NSArray< SYRouteSegment * > *)

routeSegments

Converts an array of SYRouteSegment to the array of SYGeoPolyline.

Property Documentation

info

- (SYRouteInfo*) info

readnonatomicassign

Basic route info.

maneuvers

- (NSArray<SYManeuver*>*) maneuvers

readnonatomicassign

The SYManeuvers on the route.

transitCountries

- (NSArray<SYCountryIso*>*) transitCountries

readnonatomicassign

Returns route's transit countries iso codes.

optionsViolation

- (SYRouteViolatedAvoidOptions*) optionsViolation

readnonatomicassign

The routing options violation for both global route options and per-country options.

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:

• SYRouting.h