Interface DrivingRoute

com.yandex.mapkit.directions.driving

public interface DrivingRoute

Driving route.

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

Methods

void addConditionsListener(@NonNull ConditionsListener conditionsListener)

Adds a listener for route condition changes.

AnnotationLanguage getAnnotationLanguage()

Language of string annotations (e.g.

List< AnnotationSchemeID > getAnnotationSchemes()

Annotation schemes for segments in the geometry.

List< Event > getEvents()

Events on the given route.

Polyline getGeometry()

Route geometry.

List< JamSegment > getJamSegments()

Traffic conditions on the given route.

List< LaneSign > getLaneSigns()

Lane signs.

int getLegIndex()

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

DrivingRouteMetadata getMetadata()

The route metadata.

PolylinePosition getPosition()

The reached position on the given route.

List< RequestPoint > getRequestPoints()

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

List< RestrictedEntry > getRestrictedEntries()

Route restricted entries.

List< RestrictedForTrucksRoad > getRestrictedForTrucksRoads()

Route roads.

List< RestrictedTurn > getRestrictedTurns()

Route points with time-dependent restrictions.

String getRouteId()

The ID of the route.

List< RuggedRoad > getRuggedRoads()
List< DrivingSection > getSections()

WayPoint-to-WayPoint route sections.

List< Float > getSpeedLimits()

Speed limits for segments in the geometry.

List< StandingSegment > getStandingSegments()

Segments for which we calc standing status.

List< TollRoad > getTollRoads()
List< TrafficLight > getTrafficLights()

Route traffic lights.

VehicleType getVehicleType()

Vehicle type (e.g.

List< PolylinePosition > getWayPoints()

Polyline positions of waypoints including start and finish point.

boolean isAreConditionsOutdated()

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

DrivingRouteMetadata metadataAt(@NonNull PolylinePosition position)

Metadata location.

void removeConditionsListener(@NonNull ConditionsListener conditionsListener)

Removes the listener for route condition changes.

int sectionIndex(int segmentIndex)

Section index.

void setLegIndex(int legIndex)
void setPosition(@NonNull PolylinePosition position)

Method Detail

addConditionsListener

public void addConditionsListener (@NonNull ConditionsListener conditionsListener)

Adds a listener for route condition changes.

getAnnotationLanguage

public AnnotationLanguage getAnnotationLanguage ()

Language of string annotations (e.g.

street names) in this route object.Optional property, can be null.

getAnnotationSchemes

public List< AnnotationSchemeID > getAnnotationSchemes ()

Annotation schemes for segments in the geometry.

getEvents

public List< Event > getEvents ()

Events on the given route.

getGeometry

public Polyline getGeometry ()

Route geometry.

getJamSegments

public List< JamSegment > getJamSegments ()

Traffic conditions on the given route.

getLaneSigns

public List< LaneSign > getLaneSigns ()

Lane signs.

getLegIndex

public int getLegIndex ()

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

getMetadata

public DrivingRouteMetadata getMetadata ()

The route metadata.

getPosition

public PolylinePosition getPosition ()

The reached position on the given route.

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

getRequestPoints

public List< RequestPoint > getRequestPoints ()

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

Optional property, can be null.

getRestrictedEntries

public List< RestrictedEntry > getRestrictedEntries ()

Route restricted entries.

getRestrictedForTrucksRoads

public List< RestrictedForTrucksRoad > getRestrictedForTrucksRoads ()

Route roads.

getRestrictedTurns

public List< RestrictedTurn > getRestrictedTurns ()

Route points with time-dependent restrictions.

getRouteId

public String getRouteId ()

The ID of the route.

getRuggedRoads

public List< RuggedRoad > getRuggedRoads ()

getSections

public List< DrivingSection > getSections ()

WayPoint-to-WayPoint route sections.

getSpeedLimits

public List< Float > getSpeedLimits ()

Speed limits for segments in the geometry.

getStandingSegments

public List< StandingSegment > getStandingSegments ()

Segments for which we calc standing status.

getTollRoads

public List< TollRoad > getTollRoads ()

getTrafficLights

public List< TrafficLight > getTrafficLights ()

Route traffic lights.

getVehicleType

public VehicleType getVehicleType ()

Vehicle type (e.g.

Taxi).

getWayPoints

public List< PolylinePosition > getWayPoints ()

Polyline positions of waypoints including start and finish point.

isAreConditionsOutdated

public boolean isAreConditionsOutdated ()

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

metadataAt

public DrivingRouteMetadata metadataAt (@NonNull PolylinePosition position)

Metadata location.

removeConditionsListener

public void removeConditionsListener (@NonNull ConditionsListener conditionsListener)

Removes the listener for route condition changes.

sectionIndex

public int sectionIndex (int segmentIndex)

Section index.

setLegIndex

public void setLegIndex (int legIndex)

setPosition

public void setPosition (@NonNull PolylinePosition position)