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

Class LegAnnotation

java.lang.Object

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

public class LegAnnotation
extends java.lang.Object

An annotations object that contains additional details about each line segment along the route geometry. Each entry in an annotations field corresponds to a coordinate along the route geometry.

Since:

2.1.0

Constructor Summary

Constructors

Constructor and Description
LegAnnotation()

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getCongestion() The congestion between each pair of coordinates.
double[]	getDistance() The distance, in meters, between each pair of coordinates.
double[]	getDuration() The duration, in seconds, between each pair of coordinates.
double[]	getSpeed() The speed, in meters per second, between each pair of coordinates.
void	setCongestion(java.lang.String[] congestion) Set the congestion between each pair of coordinates.
void	setDistance(double[] distance) Set the duration, in seconds, between each pair of coordinates.
void	setDuration(double[] duration) Set the duration, in seconds, between each pair of coordinates.
void	setSpeed(double[] speed) Set the speed, in meters per second, between each pair of coordinates.

Methods inherited from class java.lang.Object

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

Constructor Detail

LegAnnotation

public LegAnnotation()

Method Detail

getDistance

public double[] getDistance()

The distance, in meters, between each pair of coordinates.

Returns:

a double array with each entry being a distance value between two of the routeLeg geometry coordinates.

Since:

2.1.0

setDistance

public void setDistance(double[] distance)

Set the duration, in seconds, between each pair of coordinates.

Parameters:

distance - a double array with each entry being a duration value between two of the routeLeg geometry coordinates.

Since:

2.2.0

getDuration

public double[] getDuration()

The duration, in seconds, between each pair of coordinates.

Returns:

a double array with each entry being a duration value between two of the routeLeg geometry coordinates.

Since:

2.1.0

setDuration

public void setDuration(double[] duration)

Set the duration, in seconds, between each pair of coordinates.

Parameters:

duration - a double array with each entry being a duration value between two of the routeLeg geometry coordinates.

Since:

2.2.0

getSpeed

public double[] getSpeed()

The speed, in meters per second, between each pair of coordinates.

Returns:

a double array with each entry being a speed value between two of the routeLeg geometry coordinates.

Since:

2.1.0

setSpeed

public void setSpeed(double[] speed)

Set the speed, in meters per second, between each pair of coordinates.

Parameters:

speed - a double array with each entry being a speed value between two of the routeLeg geometry coordinates.

Since:

2.2.0

getCongestion

public java.lang.String[] getCongestion()

The congestion between each pair of coordinates.

Returns:

a String array with each entry being a congestion value between two of the routeLeg geometry coordinates.

Since:

2.2.0

setCongestion

public void setCongestion(java.lang.String[] congestion)

Set the congestion between each pair of coordinates.

Parameters:

congestion - a String array with each entry being a congestion value between two of the routeLeg geometry coordinates.

Since:

2.2.0