com.mapbox.services.api.directions.v5.models

Class DirectionsRoute

java.lang.Object

com.mapbox.services.api.directions.v5.models.DirectionsRoute

Direct Known Subclasses:

MapMatchingMatching

public class DirectionsRoute
extends java.lang.Object

Detailed information about an individual route such as the duration, distance and geometry.

Since:

1.0.0

Constructor Summary

Constructors

Constructor and Description
DirectionsRoute()

Method Summary

Modifier and Type	Method and Description
double	getDistance() The distance traveled from origin to destination.
double	getDuration() The estimated travel time from origin to destination.
java.lang.String	getGeometry() Gives the geometry of the route.
java.util.List<RouteLeg>	getLegs() A Leg is a route between only two waypoints
double	getWeight() The calculated weight of the route.
java.lang.String	getWeightName() The name of the weight profile used while calculating during extraction phase.
void	setDistance(double distance) The distance traveled from origin to destination.
void	setDuration(double duration) The estimated travel time from origin to destination.
void	setGeometry(java.lang.String geometry) Sets the geometry of the route.
void	setLegs(java.util.List<RouteLeg> legs) A Leg is a route between only two waypoints
void	setWeight(double weight) The calculated weight of the route.
void	setWeightName(java.lang.String weightName) The name of the weight profile used while calculating during extraction phase.

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectionsRoute

public DirectionsRoute()

Method Detail

getDistance

public double getDistance()

The distance traveled from origin to destination.

Returns:

a double number with unit meters.

Since:

1.0.0

setDistance

public void setDistance(double distance)

The distance traveled from origin to destination.

Parameters:

distance - a double number with unit meters.

Since:

2.1.0

getWeightName

public java.lang.String getWeightName()

The name of the weight profile used while calculating during extraction phase. In many cases, this will return DirectionsCriteria.WEIGHT_NAME_ROUTABILITY, DirectionsCriteria.WEIGHT_NAME_DURATION, or DirectionsCriteria.WEIGHT_NAME_DISTANCE.

Returns:

a String representing the weight profile used while calculating the route.

Since:

2.1.0

setWeightName

public void setWeightName(java.lang.String weightName)

The name of the weight profile used while calculating during extraction phase. In many cases, this would be DirectionsCriteria.WEIGHT_NAME_ROUTABILITY, DirectionsCriteria.WEIGHT_NAME_DURATION, or DirectionsCriteria.WEIGHT_NAME_DISTANCE.

Parameters:

weightName - a String representing the weight profile used while calculating the route.

Since:

2.1.0

getWeight

public double getWeight()

The calculated weight of the route.

Returns:

the weight value provided from the API as a double value.

Since:

2.1.0

setWeight

public void setWeight(double weight)

The calculated weight of the route.

Parameters:

weight - the weight value as a double value.

Since:

2.1.0

getDuration

public double getDuration()

The estimated travel time from origin to destination.

Returns:

a double number with unit seconds.

Since:

1.0.0

setDuration

public void setDuration(double duration)

The estimated travel time from origin to destination.

Parameters:

duration - a double number with unit seconds.

Since:

2.1.0

getGeometry

public java.lang.String getGeometry()

Gives the geometry of the route. Commonly used to draw the route on the map view.

Returns:

An encoded polyline string.

Since:

1.0.0

setGeometry

public void setGeometry(java.lang.String geometry)

Sets the geometry of the route. Commonly used to draw the route on the map view.

Parameters:

geometry - an encoded polyline string.

Since:

2.1.0

getLegs

public java.util.List<RouteLeg> getLegs()

A Leg is a route between only two waypoints

Returns:

List of RouteLeg objects.

Since:

1.0.0

setLegs

public void setLegs(java.util.List<RouteLeg> legs)

A Leg is a route between only two waypoints

Parameters:

legs - list of RouteLeg objects.

Since:

2.1.0