org.opentripplanner.routing.flex

Class FlagStopGraphModifier

java.lang.Object

org.opentripplanner.routing.flex.GtfsFlexGraphModifier

org.opentripplanner.routing.flex.FlagStopGraphModifier

public class FlagStopGraphModifier
extends GtfsFlexGraphModifier

Add temporary vertices/edges for flag stops.

Field Summary

Fields inherited from class org.opentripplanner.routing.flex.GtfsFlexGraphModifier

graph

Constructor Summary

Constructors

Constructor and Description
FlagStopGraphModifier(Graph graph)

Method Summary

Modifier and Type	Method and Description
boolean	checkHopAllowsBoardAlight(State state, FlexPatternHop hop, boolean boarding) Returns true if the given hop can be boarded/alighted.
StreetVertex	getLocationForTemporaryStop(State s, FlexPatternHop hop) Subclasses can specify where the new temporary stop should be created, given a nearby PatternHop.
TraverseMode	getMode() Return the mode that the graph search should be in.
SearchTerminationStrategy	getSearchTerminationStrategy() Return the termination strategy which should be used during the graph search.
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).
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).
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.

Methods inherited from class org.opentripplanner.routing.flex.GtfsFlexGraphModifier

createBackwardHops, createDirectHop, createForwardHops, getTemporaryStop, getTemporaryStop, streetSearch, vertexVisitor

Methods inherited from class java.lang.Object

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

Constructor Detail

FlagStopGraphModifier

public FlagStopGraphModifier(Graph graph)

Method Detail

getMode

public TraverseMode getMode()

Description copied from class: GtfsFlexGraphModifier

Return the mode that the graph search should be in.

Specified by:

getMode in class GtfsFlexGraphModifier

getSearchTerminationStrategy

public SearchTerminationStrategy getSearchTerminationStrategy()

Description copied from class: GtfsFlexGraphModifier

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

Specified by:

getSearchTerminationStrategy in class GtfsFlexGraphModifier

makeHopNewTo

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

Description copied from class: GtfsFlexGraphModifier

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

Specified by:

makeHopNewTo in class GtfsFlexGraphModifier

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 TemporaryPartialPatternHop makeHopNewFrom(RoutingRequest opt,
                                                 State state,
                                                 FlexPatternHop hop,
                                                 PatternDepartVertex from,
                                                 Stop fromStop)

Description copied from class: GtfsFlexGraphModifier

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

Specified by:

makeHopNewFrom in class GtfsFlexGraphModifier

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 TemporaryPartialPatternHop shortenEnd(RoutingRequest opt,
                                             State state,
                                             TemporaryPartialPatternHop hop,
                                             PatternStopVertex to,
                                             Stop toStop)

Description copied from class: GtfsFlexGraphModifier

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.

Specified by:

shortenEnd in class GtfsFlexGraphModifier

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

getLocationForTemporaryStop

public StreetVertex getLocationForTemporaryStop(State s,
                                                FlexPatternHop hop)

Description copied from class: GtfsFlexGraphModifier

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

Specified by:

getLocationForTemporaryStop in class GtfsFlexGraphModifier

Parameters:

s - State at which PatternHop was found

hop - PatternHop found during graph search

Returns:

location for new stop

checkHopAllowsBoardAlight

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

Description copied from class: GtfsFlexGraphModifier

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

Specified by:

checkHopAllowsBoardAlight in class GtfsFlexGraphModifier