org.opentripplanner.routing.core

Class RoutingContext

java.lang.Object

org.opentripplanner.routing.core.RoutingContext

All Implemented Interfaces:

Cloneable

public class RoutingContext
extends Object
implements Cloneable

A RoutingContext holds information needed to carry out a search for a particular TraverseOptions, on a specific graph. Includes things like (temporary) endpoint vertices, transfer tables, service day caches, etc. In addition, while the RoutingRequest should only carry parameters _in_ to the routing operation, the routing context should be used to carry information back out, such as debug figures or flags that certain thresholds have been exceeded.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	aborted Indicates that the search timed out or was otherwise aborted.
CalendarService	calendarService
DebugOutput	debugOutput An object that accumulates profiling and debugging info for inclusion in the response.
Vertex	fromVertex
Graph	graph
RoutingRequest	opt
Vertex	origin
Edge	originBackEdge
RemainingWeightHeuristic	remainingWeightHeuristic
long	searchAbortTime The search will be aborted if it is still running after this time (in milliseconds since the epoch).
Map<FeedScopedId,Set<ServiceDate>>	serviceDatesByServiceId
ArrayList<ServiceDay>	serviceDays Cache lists of which transit services run on which midnight-to-midnight periods.
boolean	slopeRestrictionRemoved Indicates that a maximum slope constraint was specified but was removed during routing to produce a result.
Vertex	startingStop
Vertex	target
Collection<Vertex>	temporaryVertices Temporary vertices created during the request.
TimetableSnapshot	timetableSnapshot The timetableSnapshot is a TimetableSnapshot for looking up real-time updates.
Vertex	toVertex
TransferTable	transferTable

Constructor Summary

Constructors

Constructor and Description
RoutingContext(RoutingRequest routingRequest, Graph graph) Constructor that automatically computes origin/target from RoutingRequest.
RoutingContext(RoutingRequest routingRequest, Graph graph, Collection<Vertex> temporaryVertices) Constructor that automatically computes origin/target from RoutingRequest, and sets the context's temporary vertices.
RoutingContext(RoutingRequest routingRequest, Graph graph, Vertex from, Vertex to) Constructor that takes to/from vertices as input.

Method Summary

Modifier and Type	Method and Description
void	check()
void	destroy() Tear down this routing context, removing any temporary edges from the "permanent" graph objects.
boolean	isAccessible() check if the start and end locations are accessible
boolean	isWheelchairAccessible(Vertex v)

Methods inherited from class java.lang.Object

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

Field Detail

opt

public RoutingRequest opt

graph

public final Graph graph

fromVertex

public final Vertex fromVertex

toVertex

public final Vertex toVertex

origin

public final Vertex origin

target

public final Vertex target

originBackEdge

public Edge originBackEdge

calendarService

public final CalendarService calendarService

serviceDatesByServiceId

public final Map<FeedScopedId,Set<ServiceDate>> serviceDatesByServiceId

remainingWeightHeuristic

public RemainingWeightHeuristic remainingWeightHeuristic

transferTable

public final TransferTable transferTable

timetableSnapshot

public final TimetableSnapshot timetableSnapshot

The timetableSnapshot is a TimetableSnapshot for looking up real-time updates.

serviceDays

public ArrayList<ServiceDay> serviceDays

Cache lists of which transit services run on which midnight-to-midnight periods. This ties a TraverseOptions to a particular start time for the duration of a search so the same options cannot be used for multiple searches concurrently. To do so this cache would need to be moved into StateData, with all that entails.

searchAbortTime

public long searchAbortTime

The search will be aborted if it is still running after this time (in milliseconds since the epoch). A negative or zero value implies no limit. This provides an absolute timeout, whereas the maxComputationTime is relative to the beginning of an individual search. While the two might seem equivalent, we trigger search retries in various places where it is difficult to update relative timeout value. The earlier of the two timeouts is applied.

startingStop

public Vertex startingStop

debugOutput

public DebugOutput debugOutput

An object that accumulates profiling and debugging info for inclusion in the response.

aborted

public boolean aborted

Indicates that the search timed out or was otherwise aborted.

slopeRestrictionRemoved

public boolean slopeRestrictionRemoved

Indicates that a maximum slope constraint was specified but was removed during routing to produce a result.

temporaryVertices

public Collection<Vertex> temporaryVertices

Temporary vertices created during the request. This is needed for GTFS-Flex support. The other temporary vertices which are created have known locations (the endpoints of the search), but GTFS-Flex routing may require temporary vertices to be created at other places in the graph. Temporary vertices are request-specific need to be disposed of at the end-of-life of a request.

Constructor Detail

RoutingContext

public RoutingContext(RoutingRequest routingRequest,
                      Graph graph)

Constructor that automatically computes origin/target from RoutingRequest.

RoutingContext

public RoutingContext(RoutingRequest routingRequest,
                      Graph graph,
                      Collection<Vertex> temporaryVertices)

Constructor that automatically computes origin/target from RoutingRequest, and sets the context's temporary vertices. This is needed for intermediate places, as a consequence of the check that temporary vertices are request-specific.

RoutingContext

public RoutingContext(RoutingRequest routingRequest,
                      Graph graph,
                      Vertex from,
                      Vertex to)

Constructor that takes to/from vertices as input.

Method Detail

check

public void check()

isAccessible

public boolean isAccessible()

check if the start and end locations are accessible

isWheelchairAccessible

public boolean isWheelchairAccessible(Vertex v)

destroy

public void destroy()

Tear down this routing context, removing any temporary edges from the "permanent" graph objects. This enables all temporary objects for garbage collection.