org.opentripplanner.routing.edgetype

Class PatternDwell

java.lang.Object

org.opentripplanner.routing.graph.Edge

org.opentripplanner.routing.edgetype.TablePatternEdge

org.opentripplanner.routing.edgetype.PatternDwell

All Implemented Interfaces:

Serializable, DwellEdge, OnboardEdge, PatternEdge

public class PatternDwell
extends TablePatternEdge
implements OnboardEdge, DwellEdge

Models waiting in a station on a vehicle. The vehicle is not permitted to change names during this time -- PatternInterlineDwell represents that case.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.opentripplanner.routing.graph.Edge

Edge.ValidVertexTypes

Field Summary

Fields inherited from class org.opentripplanner.routing.graph.Edge

fromv, tov

Constructor Summary

Constructors

Constructor and Description
PatternDwell(PatternArriveVertex from, PatternDepartVertex to, int stopIndex, TripPattern tripPattern)

Method Summary

Modifier and Type	Method and Description
String	getDirection() Get a direction on paths where it matters, or null
double	getDistance()
org.locationtech.jts.geom.LineString	getGeometry()
TraverseMode	getMode()
String	getName() Gets english localized name
String	getName(Locale locale) Gets wanted localization
int	getStopIndex() The stop index (within the trip) of the stop this edge comes from.
State	optimisticTraverse(State s0)
void	setStopIndex(int stopIndex)
double	timeLowerBound(RoutingRequest options) Returns a lower bound on traversal time given the routing options.
String	toString()
State	traverse(State state0) Traverse this edge.
double	weightLowerBound(RoutingRequest options) Returns a lower bound on edge weight given the routing options.

Methods inherited from class org.opentripplanner.routing.edgetype.TablePatternEdge

getPattern

Methods inherited from class org.opentripplanner.routing.graph.Edge

getAzimuth, getDisplayGeometry, getFromVertex, getId, getToVertex, getTrip, getValidVertexTypes, hasBogusName, hashCode, isEquivalentTo, isPartial, isReverseOf, isRoundabout, vertexTypesValid

Methods inherited from class java.lang.Object

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

Constructor Detail

PatternDwell

public PatternDwell(PatternArriveVertex from,
                    PatternDepartVertex to,
                    int stopIndex,
                    TripPattern tripPattern)

Method Detail

getDirection

public String getDirection()

Description copied from class: Edge

Get a direction on paths where it matters, or null

Overrides:

getDirection in class Edge

Returns:

getDistance

public double getDistance()

Overrides:

getDistance in class Edge

getMode

public TraverseMode getMode()

getName

public String getName()

Description copied from class: Edge

Gets english localized name

Specified by:

getName in class Edge

Returns:

english localized name

getName

public String getName(Locale locale)

Description copied from class: Edge

Gets wanted localization

Specified by:

getName in class Edge

Parameters:

locale - wanted locale

Returns:

Localized in specified locale name

traverse

public State traverse(State state0)

Description copied from class: Edge

Traverse this edge.

Specified by:

traverse in class Edge

Parameters:

state0 - The State coming into the edge.

Returns:

The State upon exiting the edge.

optimisticTraverse

public State optimisticTraverse(State s0)

Overrides:

optimisticTraverse in class Edge

timeLowerBound

public double timeLowerBound(RoutingRequest options)

Description copied from class: Edge

Returns a lower bound on traversal time given the routing options.

Overrides:

timeLowerBound in class Edge

Returns:

edge weight as a double.

weightLowerBound

public double weightLowerBound(RoutingRequest options)

Description copied from class: Edge

Returns a lower bound on edge weight given the routing options.

Overrides:

weightLowerBound in class Edge

Returns:

edge weight as a double.

getGeometry

public org.locationtech.jts.geom.LineString getGeometry()

Overrides:

getGeometry in class Edge

toString

public String toString()

Overrides:

toString in class Edge

setStopIndex

public void setStopIndex(int stopIndex)

getStopIndex

public int getStopIndex()

Description copied from interface: OnboardEdge

The stop index (within the trip) of the stop this edge comes from. This is equivalent to a hop index.

Specified by:

getStopIndex in interface OnboardEdge

Specified by:

getStopIndex in class TablePatternEdge