public class LegStep
extends java.lang.Object
StepManeuver object and travel to the following LegStep.| Constructor and Description |
|---|
LegStep()
Empty constructor
|
LegStep(java.util.List<StepIntersection> intersections)
Constructor taking in a list of
StepIntersections. |
LegStep(java.lang.String name,
java.lang.String rotaryName,
StepManeuver maneuver)
|
| Modifier and Type | Method and Description |
|---|---|
java.lang.String |
getDestinations()
String with the destinations of the way along which the travel proceeds.
|
double |
getDistance()
The distance traveled from the maneuver to the next
LegStep. |
double |
getDuration()
The estimated travel time from the maneuver to the next
LegStep. |
java.lang.String |
getGeometry()
Gives the geometry of the leg step.
|
java.util.List<StepIntersection> |
getIntersections()
Provides a list of all the intersections connected to the current way the user is traveling along.
|
StepManeuver |
getManeuver()
A
StepManeuver object that typically represents the first coordinate making up the
getGeometry(). |
java.lang.String |
getMode()
indicates the mode of transportation in the step.
|
java.lang.String |
getName()
String with the name of the way along which the travel proceeds.
|
java.lang.String |
getPronunciation()
The pronunciation hint of the way name.
|
java.lang.String |
getRef()
String with reference number or code of the way along which the travel proceeds.
|
java.lang.String |
getRotaryName()
An optional string indicating the name of the rotary.
|
java.lang.String |
getRotaryPronunciation()
An optional string indicating the pronunciation of the name of the rotary.
|
double |
getWeight()
Specifies a decimal precision of edge weights, default value 1.
|
void |
setDestinations(java.lang.String destinations)
String with the destinations of the way along which the travel proceeds.
|
void |
setDistance(double distance)
The distance traveled from the maneuver to the next
LegStep. |
void |
setDuration(double duration)
The estimated travel time from the maneuver to the next
LegStep. |
void |
setGeometry(java.lang.String geometry)
Sets the geometry of the leg step.
|
void |
setIntersections(java.util.List<StepIntersection> intersections)
Provide a
List of objects representing all intersections along the step. |
void |
setManeuver(StepManeuver maneuver)
Provide a
StepManeuver object that typically represents the first coordinate making up the
getGeometry(). |
void |
setMode(java.lang.String mode)
indicates the mode of transportation in the step.
|
void |
setName(java.lang.String name)
Sets String with the name of the way along which the travel proceeds.
|
void |
setPronunciation(java.lang.String pronunciation)
The pronunciation hint of the way name.
|
void |
setRef(java.lang.String ref)
Sets String with reference number or code of the way along which the travel proceeds.
|
void |
setRotaryName(java.lang.String rotaryName)
An optional string indicating the name of the rotary.
|
void |
setRotaryPronunciation(java.lang.String rotaryPronunciation)
An optional string indicating the pronunciation of the name of the rotary.
|
void |
setWeight(double weight)
Specifies a decimal precision of edge weights, default value 1.
|
public LegStep()
public LegStep(java.util.List<StepIntersection> intersections)
StepIntersections.intersections - StepIntersectionpublic LegStep(java.lang.String name,
java.lang.String rotaryName,
StepManeuver maneuver)
name - String with the name of the way along which the travel proceeds.rotaryName - String indicating the name of the rotary.maneuver - one StepManeuver object.public double getWeight()
public void setWeight(double weight)
weight - double value representing the edge weight.public double getDistance()
LegStep.public void setDistance(double distance)
LegStep.distance - a double number with unit meters.public double getDuration()
LegStep.public void setDuration(double duration)
LegStep.duration - a double number with unit seconds.public java.lang.String getGeometry()
public void setGeometry(java.lang.String geometry)
geometry - an encoded polyline string.public java.lang.String getName()
String representing the way along which the travel proceeds.public void setName(java.lang.String name)
name - a String representing the way along which the travel proceeds.public java.lang.String getRef()
public void setRef(java.lang.String ref)
ref - a String representing the reference number or code of the way along which the travel proceeds.public java.lang.String getDestinations()
public void setDestinations(java.lang.String destinations)
destinations - a String with the destinations of the way along which the travel proceeds.
Optionally included, if data is available.public java.lang.String getMode()
public void setMode(java.lang.String mode)
mode - a String indicating the mode of transportation.public StepManeuver getManeuver()
StepManeuver object that typically represents the first coordinate making up the
getGeometry().StepManeuver object.public void setManeuver(StepManeuver maneuver)
StepManeuver object that typically represents the first coordinate making up the
getGeometry().maneuver - a StepManeuver for the given step.public java.util.List<StepIntersection> getIntersections()
StepIntersection representing all intersections along the step.public void setIntersections(java.util.List<StepIntersection> intersections)
List of objects representing all intersections along the step.intersections - List of StepIntersection representing all intersections along the step.public java.lang.String getRotaryName()
public void setRotaryName(java.lang.String rotaryName)
rotaryName - a String with the rotary name.public java.lang.String getRotaryPronunciation()
public void setRotaryPronunciation(java.lang.String rotaryPronunciation)
rotaryPronunciation - String in IPA with the rotary name's pronunciation.public java.lang.String getPronunciation()
public void setPronunciation(java.lang.String pronunciation)
pronunciation - provide a String with the pronunciation of the way name.