org.opentripplanner.profile

Class Ride

java.lang.Object

org.opentripplanner.profile.Ride

public class Ride
extends Object

A Ride is defined by its from-stop and to-stop, as well as the previous ride (from which it transfers). It serves as a container for multiple PatternRides, all of which connect that same pair of Stops. A Ride may be unfinished, which means it does not yet have a destination and contains only unfinished PatternRides. TODO this could just be a RouteRide key mapped to lists of patternRides with the same characteristics. its constructor would pull out the right fields. TODO if patternRides can be added later, and stats and transfers are computed after the fact, then maybe we no longer need a round-based approach. We need to put _groups_ of patternRides into the queue, grouped by back ride and beginning stop.

Constructor Summary

Constructors

Constructor and Description
Ride(Ride other, StopCluster to) Construct a partial copy with no PatternRides or Stats and the given arrival StopCluster.
Ride(StopCluster from, Ride previous) Construct a partial ride (resulting from a transfer, waiting to be completed).

Method Summary

Modifier and Type	Method and Description
void	calcStats(TimeWindow window, double walkSpeed) Create a compound Stats for all the constituent PatternRides of this Ride.
org.opentripplanner.profile.Stats	calcStatsForBoarding(TimeWindow window) Produce stats about boarding an initial Ride, which has no previous ride.
org.opentripplanner.profile.Stats	calcStatsForTransfer(TimeWindow window, double walkSpeed) Calculates Stats for the transfer to the given ride from the previous ride.
boolean	containsPattern(TripPattern pattern)
void	dumpRideChain() Output this entire chain of rides.
Ride	extendTo(StopCluster toStopCluster) Extend this incomplete ride to the given stop, creating a container for PatternRides.
StopCluster	getAccessStopCluster()
StopCluster	getEgressStopCluster()
com.google.common.collect.Multimap<Route,org.opentripplanner.profile.PatternRide>	getPatternRidesByRoute()
Set<Route>	getRoutes()
gnu.trove.list.TIntList	getSortedStoptimes(TimeWindow window, boolean arrivals)
boolean	pathContainsRoute(Route route)
boolean	pathContainsStop(StopCluster stopCluster)
void	recomputeBounds() Calculate length and upper and lower bounds on duration for the chain of rides ending with this one.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Ride

public Ride(StopCluster from,
            Ride previous)

Construct a partial ride (resulting from a transfer, waiting to be completed).

Ride

public Ride(Ride other,
            StopCluster to)

Construct a partial copy with no PatternRides or Stats and the given arrival StopCluster.

Method Detail

extendTo

public Ride extendTo(StopCluster toStopCluster)

Extend this incomplete ride to the given stop, creating a container for PatternRides.

toString

public String toString()

Overrides:

toString in class Object

dumpRideChain

public void dumpRideChain()

Output this entire chain of rides.

getPatternRidesByRoute

public com.google.common.collect.Multimap<Route,org.opentripplanner.profile.PatternRide> getPatternRidesByRoute()

getRoutes

public Set<Route> getRoutes()

containsPattern

public boolean containsPattern(TripPattern pattern)

pathContainsRoute

public boolean pathContainsRoute(Route route)

pathContainsStop

public boolean pathContainsStop(StopCluster stopCluster)

recomputeBounds

public void recomputeBounds()

Calculate length and upper and lower bounds on duration for the chain of rides ending with this one. This should be called whenever the ride/wait/access stats for the ride are updated. We can't call it in the constructor or update methods because access stats are set after construction, and wait stats are sometimes null.

calcStats

public void calcStats(TimeWindow window,
                      double walkSpeed)

Create a compound Stats for all the constituent PatternRides of this Ride. This should not be called until all PatternRides have been added to this Ride. There are two separate Stats objects: The rideStats includes the time spent on the patterns themselves. The waitStats capture the time spent waiting to board those patterns (transfer or initial boarding).

getSortedStoptimes

public gnu.trove.list.TIntList getSortedStoptimes(TimeWindow window,
                                                  boolean arrivals)

Parameters:

arrivals - find arrival times rather than departure times for this Ride.

Returns:

a list of sorted departure or arrival times within the window. FIXME this is a hot spot in execution, about 50 percent of runtime.

calcStatsForBoarding

public org.opentripplanner.profile.Stats calcStatsForBoarding(TimeWindow window)

Produce stats about boarding an initial Ride, which has no previous ride. This assumes arrival times are uniformly distributed during the window. The Ride must contain some trips, and the window must have a positive duration.

calcStatsForTransfer

public org.opentripplanner.profile.Stats calcStatsForTransfer(TimeWindow window,
                                                              double walkSpeed)

Calculates Stats for the transfer to the given ride from the previous ride. This should only be called after all PatternRides have been added to the ride. Distances can be stored in rides, including the first and last distance. But waits must be calculated from full sets of patterns, which are not known until a round is over.

getAccessStopCluster

public StopCluster getAccessStopCluster()

Returns:

the stop at which the rider would board the chain of Rides this Ride belongs to.

getEgressStopCluster

public StopCluster getEgressStopCluster()

Returns:

the stop from which the rider will walk to the final destination, assuming this is the final Ride in a chain.