Class YMKDrivingRoute

Driving route.

A route consists of multiple sections. Each section has a corresponding annotation that describes the action at the beginning of the section.

Instance Methods

- addConditionsListenerWithConditionsListener:

Adds a listener for route condition changes.

- metadataAtWithPosition:

Metadata location.

- removeConditionsListenerWithConditionsListener:

Removes the listener for route condition changes.

- sectionIndexWithSegmentIndex:

Section index.

Properties

annotationLanguage

Language of string annotations (e.g.

annotationSchemes

Annotation schemes for segments in the geometry.

areConditionsOutdated

Indicates whether driving conditions (jamSegments and events) have become outdated when we are not able to fetch updates for some predefined time.

events

Events on the given route.

geometry

Route geometry.

jamSegments

Traffic conditions on the given route.

laneSigns

Lane signs.

legIndex

A leg is a section of the route between two consecutive waypoints.

metadata

The route metadata.

position

The reached position on the given route.

requestPoints

Request points that were specified in the router request that this route originated from.

restrictedEntries

Route restricted entries.

restrictedForTrucksRoads

Route roads.

restrictedTurns

Route points with time-dependent restrictions.

routeId

The ID of the route.

ruggedRoads
sections

WayPoint-to-WayPoint route sections.

speedLimits

Speed limits for segments in the geometry.

standingSegments

Segments for which we calc standing status.

tollRoads
trafficLights

Route traffic lights.

vehicleType

Vehicle type (e.g.

wayPoints

Polyline positions of waypoints including start and finish point.

Method Detail

-addConditionsListenerWithConditionsListener:

- (void)addConditionsListenerWithConditionsListener:(nonnull id< YMKDrivingConditionsListener >)conditionsListener 

Adds a listener for route condition changes.

-metadataAtWithPosition:

- (nonnull YMKDrivingRouteMetadata *)metadataAtWithPosition:(nonnull YMKPolylinePosition *)position 

Metadata location.

-removeConditionsListenerWithConditionsListener:

- (void)removeConditionsListenerWithConditionsListener:(nonnull id< YMKDrivingConditionsListener >)conditionsListener 

Removes the listener for route condition changes.

-sectionIndexWithSegmentIndex:

- (NSUInteger)sectionIndexWithSegmentIndex:(NSUInteger)segmentIndex 

Section index.

Property Detail

annotationLanguage

(assign, readonly) NSNumber * annotationLanguage

Language of string annotations (e.g.

street names) in this route object.

Optional property, can be nil.

annotationSchemes

(assign, readonly) NSArray< NSNumber * > * annotationSchemes

Annotation schemes for segments in the geometry.

areConditionsOutdated

(assign, readonly, getter=isAreConditionsOutdated) BOOL areConditionsOutdated

Indicates whether driving conditions (jamSegments and events) have become outdated when we are not able to fetch updates for some predefined time.

events

(assign, readonly) NSArray< YMKDrivingEvent * > * events

Events on the given route.

geometry

(assign, readonly) YMKPolyline * geometry

Route geometry.

jamSegments

(assign, readonly) NSArray< YMKDrivingJamSegment * > * jamSegments

Traffic conditions on the given route.

laneSigns

(assign, readonly) NSArray< YMKDrivingLaneSign * > * laneSigns

Lane signs.

legIndex

(assign, readwrite) NSUInteger legIndex

A leg is a section of the route between two consecutive waypoints.

metadata

(assign, readonly) YMKDrivingRouteMetadata * metadata

The route metadata.

position

(assign, readwrite) YMKPolylinePosition * position

The reached position on the given route.

The 'RouteMetadata::weight' field contains data for the part of the route beyond this position.

requestPoints

(assign, readonly) NSArray< YMKRequestPoint * > * requestPoints

Request points that were specified in the router request that this route originated from.

Optional property, can be nil.

restrictedEntries

(assign, readonly) NSArray< YMKDrivingRestrictedEntry * > * restrictedEntries

Route restricted entries.

restrictedForTrucksRoads

(assign, readonly) NSArray< YMKDrivingRestrictedForTrucksRoad * > * restrictedForTrucksRoads

Route roads.

restrictedTurns

(assign, readonly) NSArray< YMKDrivingRestrictedTurn * > * restrictedTurns

Route points with time-dependent restrictions.

routeId

(assign, readonly) NSString * routeId

The ID of the route.

ruggedRoads

(assign, readonly) NSArray< YMKDrivingRuggedRoad * > * ruggedRoads

sections

(assign, readonly) NSArray< YMKDrivingSection * > * sections

WayPoint-to-WayPoint route sections.

speedLimits

(assign, readonly) NSArray< NSNumber * > * speedLimits

Speed limits for segments in the geometry.

standingSegments

(assign, readonly) NSArray< YMKDrivingStandingSegment * > * standingSegments

Segments for which we calc standing status.

tollRoads

(assign, readonly) NSArray< YMKDrivingTollRoad * > * tollRoads

trafficLights

(assign, readonly) NSArray< YMKDrivingTrafficLight * > * trafficLights

Route traffic lights.

vehicleType

(assign, readonly) YMKDrivingVehicleType vehicleType

Vehicle type (e.g.

Taxi).

wayPoints

(assign, readonly) NSArray< YMKPolylinePosition * > * wayPoints

Polyline positions of waypoints including start and finish point.