org.opentripplanner.profile

Class ProfileRouter

java.lang.Object

org.opentripplanner.profile.ProfileRouter

public class ProfileRouter
extends Object

Rather than finding a single optimal route, ProfileRouter aims to find all reasonable ways to go from an origin to a destination over a given time window, and expresses those results in terms of route combinations and time ranges. For example: riding Train A followed by Bus B between 9AM and 11AM takes between 1.2 and 1.6 hours; riding Train A followed by Bus C takes between 1.4 and 1.8 hours. Create one instance of ProfileRouter per profile search. It is not intended to be threadsafe or reusable. You MUST call the cleanup method on all ProfileRouter instances that have been used for routing before they are released for garbage collection.

Field Summary

Fields

Modifier and Type	Field and Description
Graph	graph
static int	MAX_DURATION
ProfileRequest	request
static int	SLACK
TimeSurface.RangeSet	timeSurfaceRangeSet

Constructor Summary

Constructors

Constructor and Description
ProfileRouter(Graph graph, ProfileRequest request)

Method Summary

Modifier and Type	Method and Description
int	cleanup() Destroy all routing contexts created during this search.
boolean	dominated(Ride newRide, StopCluster atCluster) Check whether a new ride has too long a duration relative to existing rides at the given location, or relative to the global travel time limit.
void	finalize() This finalizer is intended as a failsafe to prevent memory leakage in case someone does not clean up routing contexts.
com.google.common.collect.Multimap<TripPattern,StopAtDistance>	findClosestPatterns(com.google.common.collect.Multimap<StopCluster,StopAtDistance> stopClusters)
void	printStopsForPatterns(String prefix, com.google.common.collect.Multimap<TripPattern,StopAtDistance> stopClustersByPattern)
ProfileResponse	route()

Methods inherited from class java.lang.Object

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

Field Detail

SLACK

public static final int SLACK

See Also:

Constant Field Values

MAX_DURATION

public static final int MAX_DURATION

See Also:

Constant Field Values

graph

public final Graph graph

request

public final ProfileRequest request

timeSurfaceRangeSet

public TimeSurface.RangeSet timeSurfaceRangeSet

Constructor Detail

ProfileRouter

public ProfileRouter(Graph graph,
                     ProfileRequest request)

Method Detail

printStopsForPatterns

public void printStopsForPatterns(String prefix,
                                  com.google.common.collect.Multimap<TripPattern,StopAtDistance> stopClustersByPattern)

route

public ProfileResponse route()

dominated

public boolean dominated(Ride newRide,
                         StopCluster atCluster)

Check whether a new ride has too long a duration relative to existing rides at the given location, or relative to the global travel time limit. TODO auto-detect unfinished rides via to==null

findClosestPatterns

public com.google.common.collect.Multimap<TripPattern,StopAtDistance> findClosestPatterns(com.google.common.collect.Multimap<StopCluster,StopAtDistance> stopClusters)

Parameters:

stopClusters - a multimap from stop clusters to one or more StopAtDistance objects at the corresponding cluster.

Returns:

for each TripPattern that passes through any of the supplied stop clusters, the stop cluster that is closest to the origin or destination point according to the distances in the StopAtDistance objects. In short, take a bunch of stop clusters near the origin or destination and return the quickest way to reach each pattern that passes through them. We want stop cluster references rather than indexes within the patterns because when a stop cluster appears more than once in a pattern, we want to consider boarding or alighting from that pattern at every index where the cluster occurs.

cleanup

public int cleanup()

Destroy all routing contexts created during this search. This method must be called manually on any ProfileRouter instance before it is released for garbage collection, because RoutingContexts remain linked into the graph by temporary edges if they are not cleaned up.

finalize

public void finalize()

This finalizer is intended as a failsafe to prevent memory leakage in case someone does not clean up routing contexts. It should be considered an error if this method does any work.

Overrides:

finalize in class Object