org.opentripplanner.api.model

Class WalkStep

java.lang.Object

org.opentripplanner.api.model.WalkStep

public class WalkStep
extends Object

Represents one instruction in walking directions. Three examples from New York City:

Turn onto Broadway from W 57th St (coming from 7th Ave):
distance = 100 (say)
walkDirection = RIGHT
streetName = Broadway
everything else null/false

Now, turn from Broadway onto Central Park S via Columbus Circle
distance = 200 (say)
walkDirection = CIRCLE_COUNTERCLOCKWISE
streetName = Central Park S
exit = 1 (first exit)
immediately everything else false

Instead, go through the circle to continue on Broadway
distance = 100 (say)
walkDirection = CIRCLE_COUNTERCLOCKWISE
streetName = Broadway
exit = 3
stayOn = true
everything else false

Field Summary

Fields

Modifier and Type	Field and Description
AbsoluteDirection	absoluteDirection The absolute direction of this step.
List<LocalizedAlert>	alerts
double	angle
Boolean	area This step is on an open area, such as a plaza or train platform, and thus the directions should say something like "cross"
BikeRentalStationInfo	bikeRentalOffStation The bike rental on/off station info.
BikeRentalStationInfo	bikeRentalOnStation The bike rental on/off station info.
Boolean	bogusName The name of this street was generated by the system, so we should only display it once, and generally just display right/left directions
double	distance The distance in meters that this step takes.
List<Edge>	edges The street edges that make up this walkStep.
List<P2<Double>>	elevation The elevation profile as a comma-separated list of x,y values.
String	exit When exiting a highway or traffic circle, the exit name/number.
double	lat The latitude of start of the step
double	lon The longitude of start of the step
String	newMode The walkStep's mode; only populated if this is the first step of that mode in the leg.
RelativeDirection	relativeDirection The relative direction of this step.
Boolean	stayOn Indicates whether or not a street changes direction at an intersection.
String	streetName The name of the street.

Constructor Summary

Constructors

Constructor and Description
WalkStep()

Method Summary

Modifier and Type	Method and Description
void	addAlerts(Collection<Alert> newAlerts, Locale locale)
List<P2<Double>>	getElevation()
static RelativeDirection	getRelativeDirection(double lastAngle, double thisAngle, boolean roundabout)
void	setAbsoluteDirection(double thisAngle)
void	setDirections(double lastAngle, double thisAngle, boolean roundabout)
String	streetNameNoParens()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

distance

public double distance

The distance in meters that this step takes.

relativeDirection

public RelativeDirection relativeDirection

The relative direction of this step.

streetName

public String streetName

The name of the street.

absoluteDirection

public AbsoluteDirection absoluteDirection

The absolute direction of this step.

exit

public String exit

When exiting a highway or traffic circle, the exit name/number.

stayOn

public Boolean stayOn

Indicates whether or not a street changes direction at an intersection.

area

public Boolean area

This step is on an open area, such as a plaza or train platform, and thus the directions should say something like "cross"

bogusName

public Boolean bogusName

The name of this street was generated by the system, so we should only display it once, and generally just display right/left directions

lon

public double lon

The longitude of start of the step

lat

public double lat

The latitude of start of the step

elevation

public List<P2<Double>> elevation

The elevation profile as a comma-separated list of x,y values. x is the distance from the start of the step, y is the elevation at this distance.

alerts

public List<LocalizedAlert> alerts

angle

public transient double angle

newMode

public transient String newMode

The walkStep's mode; only populated if this is the first step of that mode in the leg. Used only in generating the streetEdges array in StreetSegment; not serialized.

edges

public transient List<Edge> edges

The street edges that make up this walkStep. Used only in generating the streetEdges array in StreetSegment; not serialized.

bikeRentalOnStation

public transient BikeRentalStationInfo bikeRentalOnStation

The bike rental on/off station info. Used only in generating the streetEdges array in StreetSegment; not serialized.

bikeRentalOffStation

public transient BikeRentalStationInfo bikeRentalOffStation

The bike rental on/off station info. Used only in generating the streetEdges array in StreetSegment; not serialized.

Constructor Detail

WalkStep

public WalkStep()

Method Detail

setDirections

public void setDirections(double lastAngle,
                          double thisAngle,
                          boolean roundabout)

toString

public String toString()

Overrides:

toString in class Object

getRelativeDirection

public static RelativeDirection getRelativeDirection(double lastAngle,
                                                     double thisAngle,
                                                     boolean roundabout)

setAbsoluteDirection

public void setAbsoluteDirection(double thisAngle)

addAlerts

public void addAlerts(Collection<Alert> newAlerts,
                      Locale locale)

streetNameNoParens

public String streetNameNoParens()

getElevation

public List<P2<Double>> getElevation()