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...
(void)	- getRoadElementsWithCompletion:
	The SYRoadElements on the route. More...
(instancetype)	- initWithSdkRoute: [implementation]

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...
SYRoutingOptions *	options
	The routing options. Check the available SYRoutingOptions. More...
SYGeoBoundingBox *	box
	The smallest SYGeoBoundingBox that contains the entire route. More...
NSArray< SYWaypoint * > *	waypoints
	List of SYWaypoints on the route. More...
Sygic::Router::RoutePtr	sdkRoutePtr [implementation]

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.

getRoadElementsWithCompletion:()

- (void) getRoadElementsWithCompletion:

(nonnull void(^)(NSArray< SYRoadElement * > *_Nonnull))

completion

The SYRoadElements on the route.

initWithSdkRoute:()

- (instancetype) initWithSdkRoute: (Sygic::Router::RoutePtr)  ptrRoute

implementation

Property Documentation

box

- (SYGeoBoundingBox*) box

readnonatomicassign

The smallest SYGeoBoundingBox that contains the entire route.

info

- (SYRouteInfo*) info

readnonatomicassign

Basic route info.

maneuvers

- (NSArray<SYManeuver*>*) maneuvers

readnonatomicassign

The SYManeuvers on the route.

options

- (SYRoutingOptions*) options

readnonatomicassign

The routing options. Check the available SYRoutingOptions.

optionsViolation

- (SYRouteViolatedAvoidOptions*) optionsViolation

readnonatomicassign

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

sdkRoutePtr

- Router:

readwritenonatomicassignimplementation

transitCountries

- (NSArray<SYCountryIso*>*) transitCountries

readnonatomicassign

Returns route's transit countries iso codes.

waypoints

- (NSArray<SYWaypoint*>*) waypoints

readnonatomicassign

List of SYWaypoints on the route.

---

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

• SYRouting.h