public interface

Route

com.steerpath.sdk.directions.Route

Class Overview

A route defines the directions from a source to a destination.

Summary

Public Methods
abstract Location getDestination()
Retrieve the destination, i.e.
abstract JSONObject getPolyline()
Used for retrieveing the GeoJSON feature describing the whole route with a single polyline geometry.
abstract List<RouteStep> getSteps()
A route consists of individual navigation steps.

Public Methods

public abstract Location getDestination ()

Retrieve the destination, i.e. the end point of this route. This is the same instance as provided to the DirectionsRequest, i.e. nay meta data stored in the location's extras, is retrievable.

Returns
  • the Location object to which this route leads.

public abstract JSONObject getPolyline ()

Used for retrieveing the GeoJSON feature describing the whole route with a single polyline geometry. Each coordinate is a triplet where the third element represents the level.

Returns
  • the GeoJSON feature with a polyline geometry.

public abstract List<RouteStep> getSteps ()

A route consists of individual navigation steps.

Returns
  • a list of steps that make up this route.