com.here.android.mpa.routing

Class Route

java.lang.Object

com.here.android.mpa.routing.Route

public final class Route
extends java.lang.Object

Represents a distinct path connecting two or more waypoints GeoCoordinate. A Route consists of a list of maneuvers and route links.

See Also:

RouteResult, RouteManager

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Route.TrafficPenaltyMode Enumeration for calculating route duration.

Field Summary

Fields

Modifier and Type	Field and Description
static int	WHOLE_ROUTE

Method Summary

Modifier and Type	Method and Description
GeoBoundingBox	getBoundingBox() Gets the smallest GeoBoundingBox that contains the entire route.
GeoCoordinate	getDestination() Gets the destination coordinate for the route.
Maneuver	getFirstManeuver() Returns the first Maneuver.
int	getLength() Gets the length of the route, in meters.
java.util.List<Maneuver>	getManeuvers() Gets the list of all maneuvers that travelers will encounter along the route.
RouteElements	getRouteElements()
RouteElements	getRouteElements(Maneuver maneuver) Gets the RouteElements belonging to this Maneuver.
RouteElements	getRouteElementsFromDuration(long duration) Gets the RouteElements for a given duration (in seconds) from the start of the route.
RouteElements	getRouteElementsFromDuration(long start, long duration) Gets the RouteElements for a given duration (in seconds) within the route.
RouteElements	getRouteElementsFromLength(int length) Gets the RouteElements for a given distance (in meters) within the route.
RouteElements	getRouteElementsFromLength(int start, int length) Gets the RouteElements for a given distance (in meters) within the route.
java.util.List<GeoCoordinate>	getRouteGeometry() Gets the list of all GeoCoordinate values representing, in order, the polyline of the route.
RoutePlan	getRoutePlan() Returns the route plan for defining a route with one or more route legs.
GeoCoordinate	getStart() Gets the starting coordinate for the route.
int	getSublegCount() Returns the number of sub-legs the route has.
RouteTta	getTta(Route.TrafficPenaltyMode mode, int subleg) Gets the estimated time to arrival with current traffic conditions.
java.util.List<GeoCoordinate>	getWaypoints() Gets the list of all waypoints for the route.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

WHOLE_ROUTE

public static final int WHOLE_ROUTE

See Also:

Constant Field Values

Method Detail

getBoundingBox

public GeoBoundingBox getBoundingBox()

Gets the smallest GeoBoundingBox that contains the entire route.

Returns:

The GeoBoundingBox

getLength

public int getLength()

Gets the length of the route, in meters.

Returns:

The route length in meters

getManeuvers

public java.util.List<Maneuver> getManeuvers()

Gets the list of all maneuvers that travelers will encounter along the route.

Returns:

The list of Maneuver objects

getRouteGeometry

public java.util.List<GeoCoordinate> getRouteGeometry()

Gets the list of all GeoCoordinate values representing, in order, the polyline of the route.

Returns:

A list of GeoCoordinate values

See Also:

MapPolyline

getFirstManeuver

public Maneuver getFirstManeuver()

Returns the first Maneuver.

Returns:

the first Maneuver, null if there are no maneuvers

getWaypoints

public java.util.List<GeoCoordinate> getWaypoints()

Gets the list of all waypoints for the route.

Returns:

The list of GeoCoordinate objects

getRoutePlan

public RoutePlan getRoutePlan()

Returns the route plan for defining a route with one or more route legs. Route legs are formed by a list of stop overs in the route plan. Each route leg has it's own route options.

Returns:

RoutePlan

getStart

public GeoCoordinate getStart()

Gets the starting coordinate for the route.

Returns:

The starting GeoCoordinate

getDestination

public GeoCoordinate getDestination()

Gets the destination coordinate for the route.

Returns:

The destination GeoCoordinate

getRouteElements

public RouteElements getRouteElements()

getRouteElements

public RouteElements getRouteElements(Maneuver maneuver)

Gets the RouteElements belonging to this Maneuver.

Parameters:

maneuver - The Maneuver to get the RouteElements for.

Returns:

The RouteElements belonging to this Maneuver.

getRouteElementsFromDuration

public RouteElements getRouteElementsFromDuration(long duration)

Gets the RouteElements for a given duration (in seconds) from the start of the route.

Parameters:

duration - The number of seconds from the beginning of the route.

Returns:

The RouteElements within the given duration.

getRouteElementsFromDuration

public RouteElements getRouteElementsFromDuration(long start,
                                                  long duration)

Gets the RouteElements for a given duration (in seconds) within the route.

Parameters:

start - The number of seconds into the route to start getting RouteElements.

duration - The number of seconds from the given start of the route.

Returns:

The RouteElements within the given duration.

getRouteElementsFromLength

public RouteElements getRouteElementsFromLength(int length)

Gets the RouteElements for a given distance (in meters) within the route.

Parameters:

length - The number of meters from the beginning of the route.

Returns:

The RouteElements within the given distance.

getRouteElementsFromLength

public RouteElements getRouteElementsFromLength(int start,
                                                int length)

Gets the RouteElements for a given distance (in meters) within the route.

Parameters:

start - The number of meters into the route to start getting RouteElements.

length - The number of meters from the start parameter within this route.

Returns:

The RouteElements within the given distance.

getTta

public RouteTta getTta(Route.TrafficPenaltyMode mode,
                       int subleg)

Gets the estimated time to arrival with current traffic conditions. If traffic is to be used, the caller is recommended to obtain a traffic update for the route first (and wait for it to complete) to populate the traffic database.

This method requires the Traffic Enabled Car Routing permission in order to be used when mode is Route.TrafficPenaltyMode.OPTIMAL. Please contact a HERE customer representative to acquire this permission.

Parameters:

mode - The Route.TrafficPenaltyMode to be used for this calculation. Must not be Route.TrafficPenaltyMode.AVOID_CONGESTION.

subleg - The subleg number to use or WHOLE_ROUTE for the whole route.

Returns:

The RouteTta of the subleg.

Throws:

java.lang.IllegalArgumentException - If mode is Route.TrafficPenaltyMode.AVOID_CONGESTION.

java.lang.IllegalArgumentException - If subleg is smaller than zero or greater or equal to getSublegCount().

java.security.AccessControlException - If the required permission is missing.

getSublegCount

public int getSublegCount()

Returns the number of sub-legs the route has. A sub leg is the part of a route between two stop waypoints

Returns:

number of sublegs