com.here.mobility.sdk.map.route

Class RouteRequest

java.lang.Object

com.here.mobility.sdk.map.route.RouteRequest

All Implemented Interfaces:

Parcelable

public abstract class RouteRequest
extends Object
implements Parcelable

Encapsulates a routing request.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RouteRequest.InstructionMeasurementSystem The measurement system for instructions.
static class	RouteRequest.Profile The routing profile.

Nested classes/interfaces inherited from interface android.os.Parcelable

Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>

Field Summary

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
RouteRequest()

Method Summary

Modifier and Type	Method and Description
static RouteRequest	create(LatLng origin, LatLng destination) Creates a new RouteRequest to request a route from the given origin, to the given destination for driving with a car.
static RouteRequest	create(List<LatLng> waypoints) Creates a new RouteRequest with the given list of waypoints points, for driving with a car.
static RouteRequest	create(RouteRequest.Profile profile, List<LatLng> waypoints, boolean queryAlternatives, RouteRequest.InstructionMeasurementSystem instructionMeasurementSystem, String instructionsLanguageCode) Creates a new RouteRequest with the given parameters.
abstract RouteRequest.InstructionMeasurementSystem	getInstructionMeasurementSystem() Returns the measurement system for text instructions.
abstract String	getInstructionsLanguageCode() Returns the BCP47 language code for the text instructions.
abstract RouteRequest.Profile	getProfile() Returns the travel profile with which to compute the route.
abstract List<LatLng>	getWaypoints() Returns the list of waypoints for the route.
abstract boolean	isQueryAlternatives() Returns whether the request is for alternative routes, as well as the main route.

Methods inherited from class java.lang.Object

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

Methods inherited from interface android.os.Parcelable

describeContents, writeToParcel

Constructor Detail

RouteRequest

public RouteRequest()

Method Detail

create

public static RouteRequest create(RouteRequest.Profile profile,
                                  List<LatLng> waypoints,
                                  boolean queryAlternatives,
                                  RouteRequest.InstructionMeasurementSystem instructionMeasurementSystem,
                                  String instructionsLanguageCode)

Creates a new RouteRequest with the given parameters.

Parameters:

profile - The travel profile with which to compute the route.

waypoints - The list of waypoints for the route. The first point is the origin; the last point is the destination. Must contain at least two points.

queryAlternatives - Whether to ask for alternative routes as well as the main one.

instructionMeasurementSystem - The measurement system to use for instructions.

instructionsLanguageCode - The BCP47 language code to use for instructions.

create

public static RouteRequest create(List<LatLng> waypoints)

Creates a new RouteRequest with the given list of waypoints points, for driving with a car. The text instructions will use the metric system and will be in US English.

Parameters:

waypoints - The list of waypoints for the route. The first point is the origin; the last point is the destination. Must contain at least two points.

create

public static RouteRequest create(LatLng origin,
                                  LatLng destination)

Creates a new RouteRequest to request a route from the given origin, to the given destination for driving with a car. The text instructions will use the metric system and will be in US English.

getProfile

public abstract RouteRequest.Profile getProfile()

Returns the travel profile with which to compute the route.

getWaypoints

public abstract List<LatLng> getWaypoints()

Returns the list of waypoints for the route.

isQueryAlternatives

public abstract boolean isQueryAlternatives()

Returns whether the request is for alternative routes, as well as the main route.

getInstructionMeasurementSystem

public abstract RouteRequest.InstructionMeasurementSystem getInstructionMeasurementSystem()

Returns the measurement system for text instructions.

getInstructionsLanguageCode

public abstract String getInstructionsLanguageCode()

Returns the BCP47 language code for the text instructions.