org.opentripplanner.routing.edgetype

Class PatternHop

java.lang.Object

org.opentripplanner.routing.graph.Edge

org.opentripplanner.routing.edgetype.TablePatternEdge

org.opentripplanner.routing.edgetype.PatternHop

All Implemented Interfaces:

Serializable, HopEdge, OnboardEdge, PatternEdge

Direct Known Subclasses:

FlexPatternHop

public class PatternHop
extends TablePatternEdge
implements OnboardEdge, HopEdge

A transit vehicle's journey between departure at one stop and arrival at the next. This version represents a set of such journeys specified by a TripPattern.

See Also:

Serialized Form

Nested Class Summary

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

Edge.ValidVertexTypes

Field Summary

Fields

Modifier and Type	Field and Description
int	stopIndex

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

fromv, tov

Constructor Summary

Constructors

Modifier	Constructor and Description
	PatternHop(PatternStopVertex from, PatternStopVertex to, Stop begin, Stop end, int stopIndex)
protected	PatternHop(PatternStopVertex from, PatternStopVertex to, Stop begin, Stop end, int stopIndex, boolean setInPattern)

Method Summary

Modifier and Type	Method and Description
Stop	getBeginStop()
double	getDistance()
Stop	getEndStop()
String	getFeedId()
org.locationtech.jts.geom.LineString	getGeometry()
TraverseMode	getMode()
String	getName() Gets english localized name
String	getName(Locale locale) Gets wanted localization
int	getRunningTime(State s0)
int	getStopIndex() The stop index (within the trip) of the stop this edge comes from.
int	getWeight(State s0, int runningTime)
boolean	hasFlexService() Return true if any GTFS-Flex service is defined for this hop.
State	optimisticTraverse(State state0)
void	setGeometry(org.locationtech.jts.geom.LineString geometry)
double	timeLowerBound(RoutingRequest options) Returns a lower bound on traversal time given the routing options.
String	toString()
State	traverse(State s0) Traverse this edge.
State	traverse(State s0, StateEditor s1)
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, getDirection, 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

Field Detail

stopIndex

public int stopIndex

Constructor Detail

PatternHop

protected PatternHop(PatternStopVertex from,
                     PatternStopVertex to,
                     Stop begin,
                     Stop end,
                     int stopIndex,
                     boolean setInPattern)

PatternHop

public PatternHop(PatternStopVertex from,
                  PatternStopVertex to,
                  Stop begin,
                  Stop end,
                  int stopIndex)

Method Detail

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

optimisticTraverse

public State optimisticTraverse(State state0)

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.

traverse

public State traverse(State s0)

Description copied from class: Edge

Traverse this edge.

Specified by:

traverse in class Edge

Parameters:

s0 - The State coming into the edge.

Returns:

The State upon exiting the edge.

traverse

public State traverse(State s0,
                      StateEditor s1)

getRunningTime

public int getRunningTime(State s0)

getWeight

public int getWeight(State s0,
                     int runningTime)

setGeometry

public void setGeometry(org.locationtech.jts.geom.LineString geometry)

Specified by:

setGeometry in interface HopEdge

getGeometry

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

Overrides:

getGeometry in class Edge

getEndStop

public Stop getEndStop()

Specified by:

getEndStop in interface HopEdge

getBeginStop

public Stop getBeginStop()

Specified by:

getBeginStop in interface HopEdge

getFeedId

public String getFeedId()

Specified by:

getFeedId in interface HopEdge

toString

public String toString()

Overrides:

toString in class Edge

hasFlexService

public boolean hasFlexService()

Return true if any GTFS-Flex service is defined for this hop.

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