org.opentripplanner.routing.flex

Class GtfsFlexGraphModifier

java.lang.Object

org.opentripplanner.routing.flex.GtfsFlexGraphModifier

Direct Known Subclasses:

DeviatedRouteGraphModifier, FlagStopGraphModifier

public abstract class GtfsFlexGraphModifier
extends Object

Create temporary vertices and edges for GTFS-flex service.

Field Summary

Fields

Modifier and Type	Field and Description
protected Graph	graph

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GtfsFlexGraphModifier(Graph graph)

Method Summary

Modifier and Type	Method and Description
abstract boolean	checkHopAllowsBoardAlight(State state, FlexPatternHop hop, boolean boarding) Returns true if the given hop can be boarded/alighted.
void	createBackwardHops(RoutingRequest request) Create temporary edges and vertices from the transit network to the destination.
void	createDirectHop(RoutingRequest rr, FlexPatternHop originalPatternHop, TransitStop fromStop, TransitStop toStop, GraphPath path)
void	createForwardHops(RoutingRequest request) Create temporary edges and vertices from the origin into the transit network.
abstract StreetVertex	getLocationForTemporaryStop(State s, FlexPatternHop hop) Subclasses can specify where the new temporary stop should be created, given a nearby PatternHop.
abstract TraverseMode	getMode() Return the mode that the graph search should be in.
abstract SearchTerminationStrategy	getSearchTerminationStrategy() Return the termination strategy which should be used during the graph search.
protected TemporaryTransitStop	getTemporaryStop(StreetVertex streetVertex, State s, RoutingContext rctx, RoutingRequest options)
protected TemporaryTransitStop	getTemporaryStop(StreetVertex streetVertex, State s, RoutingContext rctx, RoutingRequest options, boolean forwards)
abstract TemporaryPartialPatternHop	makeHopNewFrom(RoutingRequest opt, State state, FlexPatternHop hop, PatternDepartVertex from, Stop fromStop) Create a new FlexPatternHop with a new "from" location (from a new destination to the route).
abstract TemporaryPartialPatternHop	makeHopNewTo(RoutingRequest opt, State state, FlexPatternHop hop, PatternArriveVertex to, Stop toStop) Create a new FlexPatternHop with a new "to" location (from the route to a new destination).
abstract TemporaryPartialPatternHop	shortenEnd(RoutingRequest opt, State state, TemporaryPartialPatternHop hop, PatternStopVertex to, Stop toStop) From an existing TemporaryPartialPatternHop which has a new "from" location, create a new TemporaryPartialPatternHop with the same "from" location and a new "to" location.
protected void	streetSearch(RoutingRequest rr)
void	vertexVisitor(State state)

Methods inherited from class java.lang.Object

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

Field Detail

graph

protected Graph graph

Constructor Detail

GtfsFlexGraphModifier

protected GtfsFlexGraphModifier(Graph graph)

Method Detail

getMode

public abstract TraverseMode getMode()

Return the mode that the graph search should be in.

getSearchTerminationStrategy

public abstract SearchTerminationStrategy getSearchTerminationStrategy()

Return the termination strategy which should be used during the graph search.

makeHopNewTo

public abstract TemporaryPartialPatternHop makeHopNewTo(RoutingRequest opt,
                                                        State state,
                                                        FlexPatternHop hop,
                                                        PatternArriveVertex to,
                                                        Stop toStop)

Create a new FlexPatternHop with a new "to" location (from the route to a new destination).

Parameters:

opt - Options for the graph search

state - State at which the original FlexPatternHop was found during the graph search

hop - Original pattern hop to modify

to - New "to" location

toStop - Stop for new "to" location

Returns:

new pattern hop

makeHopNewFrom

public abstract TemporaryPartialPatternHop makeHopNewFrom(RoutingRequest opt,
                                                          State state,
                                                          FlexPatternHop hop,
                                                          PatternDepartVertex from,
                                                          Stop fromStop)

Create a new FlexPatternHop with a new "from" location (from a new destination to the route).

Parameters:

opt - Options for the graph search

state - Options for the graph search

hop - Original pattern hop to modify

from - New "from" location

fromStop - Stop for new "from" location

Returns:

new pattern hop

shortenEnd

public abstract TemporaryPartialPatternHop shortenEnd(RoutingRequest opt,
                                                      State state,
                                                      TemporaryPartialPatternHop hop,
                                                      PatternStopVertex to,
                                                      Stop toStop)

From an existing TemporaryPartialPatternHop which has a new "from" location, create a new TemporaryPartialPatternHop with the same "from" location and a new "to" location. The existence of this method implies that searches from the origin should take place prior to searches from the destination.

Parameters:

opt - Options for the graph search

state - ptions for the graph search

hop - Temporary pattern hop to modify

to - New "to" location

toStop - Stop for new "to" location

Returns:

new pattern hop

checkHopAllowsBoardAlight

public abstract boolean checkHopAllowsBoardAlight(State state,
                                                  FlexPatternHop hop,
                                                  boolean boarding)

Returns true if the given hop can be boarded/alighted.

getLocationForTemporaryStop

public abstract StreetVertex getLocationForTemporaryStop(State s,
                                                         FlexPatternHop hop)

Subclasses can specify where the new temporary stop should be created, given a nearby PatternHop.

Parameters:

s - State at which PatternHop was found

hop - PatternHop found during graph search

Returns:

location for new stop

vertexVisitor

public void vertexVisitor(State state)

createForwardHops

public void createForwardHops(RoutingRequest request)

Create temporary edges and vertices from the origin into the transit network.

Parameters:

request - request for graph search

createBackwardHops

public void createBackwardHops(RoutingRequest request)

Create temporary edges and vertices from the transit network to the destination.

Parameters:

request - request for graph search

streetSearch

protected void streetSearch(RoutingRequest rr)

getTemporaryStop

protected TemporaryTransitStop getTemporaryStop(StreetVertex streetVertex,
                                                State s,
                                                RoutingContext rctx,
                                                RoutingRequest options)

getTemporaryStop

protected TemporaryTransitStop getTemporaryStop(StreetVertex streetVertex,
                                                State s,
                                                RoutingContext rctx,
                                                RoutingRequest options,
                                                boolean forwards)

createDirectHop

public void createDirectHop(RoutingRequest rr,
                            FlexPatternHop originalPatternHop,
                            TransitStop fromStop,
                            TransitStop toStop,
                            GraphPath path)