org.opentripplanner.routing.edgetype

Class TransitBoardAlight

java.lang.Object

org.opentripplanner.routing.graph.Edge

org.opentripplanner.routing.edgetype.TablePatternEdge

org.opentripplanner.routing.edgetype.TransitBoardAlight

All Implemented Interfaces:

Serializable, OnboardEdge, PatternEdge

Direct Known Subclasses:

FlexTransitBoardAlight

public class TransitBoardAlight
extends TablePatternEdge
implements OnboardEdge

Models boarding or alighting a vehicle - that is to say, traveling from a state off vehicle to a state on vehicle. When traversed forward on a boarding or backwards on an alighting, the the resultant state has the time of the next departure, in addition the pattern that was boarded. When traversed backward on a boarding or forward on an alighting, the result state is unchanged. A boarding penalty can also be applied to discourage transfers. In an on the fly reverse-optimization search, the overloaded traverse method can be used to give an initial wait time. Also, in reverse-opimization, board costs are correctly applied. This is the result of combining the classes formerly known as PatternBoard and PatternAlight.

Author:

mattwigway

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
boolean	boarding True if this edge represents boarding a vehicle, false if it represents alighting.

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

fromv, tov

Constructor Summary

Constructors

Constructor and Description
TransitBoardAlight(PatternStopVertex fromPatternStop, TransitStopArrive toStationVertex, int stopIndex, TraverseMode mode) Alighting constructor (PatternStopVertex --> TransitStopArrive)
TransitBoardAlight(TransitStopDepart fromStopVertex, PatternStopVertex toPatternVertex, int stopIndex, TraverseMode mode) Boarding constructor (TransitStopDepart --> PatternStopVertex)

Method Summary

Modifier and Type	Method and Description
int	calculateWait(State s0, ServiceDay sd, TripTimes tripTimes)
String	getDirection() Get a direction on paths where it matters, or null
double	getDistance()
long	getExtraWeight(RoutingRequest options)
org.locationtech.jts.geom.LineString	getGeometry()
TraverseMode	getMode()
String	getName() Gets english localized name
String	getName(Locale locale) Gets wanted localization
TripTimes	getNextTrip(State s0, ServiceDay sd, Timetable timetable)
TripPattern	getPattern() Find the TripPattern this edge is boarding or alighting from.
int	getStopIndex() The stop index (within the trip) of the stop this edge comes from.
boolean	isDeviated()
State	optimisticTraverse(State state0)
double	timeLowerBound(RoutingRequest options) Returns a lower bound on traversal time given the routing options.
String	toString()
State	traverse(State state0) Traverse this edge.
State	traverse(State s0, long arrivalTimeAtStop) NOTE: We do not need to check the pickup/drop off type.
double	weightLowerBound(RoutingRequest options) Returns a lower bound on edge weight given the routing options.

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

Field Detail

boarding

public boolean boarding

True if this edge represents boarding a vehicle, false if it represents alighting.

Constructor Detail

TransitBoardAlight

public TransitBoardAlight(TransitStopDepart fromStopVertex,
                          PatternStopVertex toPatternVertex,
                          int stopIndex,
                          TraverseMode mode)

Boarding constructor (TransitStopDepart --> PatternStopVertex)

TransitBoardAlight

public TransitBoardAlight(PatternStopVertex fromPatternStop,
                          TransitStopArrive toStationVertex,
                          int stopIndex,
                          TraverseMode mode)

Alighting constructor (PatternStopVertex --> TransitStopArrive)

Method Detail

getPattern

public TripPattern getPattern()

Find the TripPattern this edge is boarding or alighting from. Overrides the general method which always looks at the from-vertex.

Specified by:

getPattern in interface PatternEdge

Overrides:

getPattern in class TablePatternEdge

Returns:

the pattern of the to-vertex when boarding, and that of the from-vertex when alighting.

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

getGeometry

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

Overrides:

getGeometry 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.

traverse

public State traverse(State s0,
                      long arrivalTimeAtStop)

NOTE: We do not need to check the pickup/drop off type. TransitBoardAlight edges are simply not created for pick/drop type 1 (no pick/drop).

Parameters:

arrivalTimeAtStop - TODO: clarify what this is.

getExtraWeight

public long getExtraWeight(RoutingRequest options)

getNextTrip

public TripTimes getNextTrip(State s0,
                             ServiceDay sd,
                             Timetable timetable)

calculateWait

public int calculateWait(State s0,
                         ServiceDay sd,
                         TripTimes tripTimes)

isDeviated

public boolean isDeviated()

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.

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

toString

public String toString()

Overrides:

toString in class Edge