org.opentripplanner.routing.core

Class StateEditor

java.lang.Object

org.opentripplanner.routing.core.StateEditor

public class StateEditor
extends Object

This class is a wrapper around a new State that provides it with setter and increment methods, allowing it to be modified before being put to use. By virtue of being in the same package as States, it can modify their package private fields.

Author:

andrewbyrd

Field Summary

Fields

Modifier and Type	Field and Description
protected State	child

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StateEditor()
	StateEditor(RoutingRequest options, Vertex v)
	StateEditor(State parent, Edge e)

Method Summary

Modifier and Type	Method and Description
void	alightTransit()
void	beginVehicleRenting(TraverseMode vehicleMode)
void	blockTraversal() Tell the stateEditor to return null when makeState() is called, no matter what other editing has been done.
void	doneVehicleRenting()
int	getCallAndRideTime()
long	getElapsedTimeSeconds()
Object	getExtension(Object key)
long	getLastAlightedTimeSeconds()
int	getNumBoardings()
int	getPreTransitTime()
Trip	getPreviousTrip()
FeedScopedId	getRoute()
long	getTimeSeconds()
FeedScopedId	getTripId()
Vertex	getVertex()
double	getWalkDistance()
String	getZone()
boolean	hasEnteredNoThroughTrafficArea()
void	incrementCallAndRideTime(int seconds)
void	incrementNumBoardings()
void	incrementPreTransitTime(int seconds)
void	incrementTimeInMilliseconds(long milliseconds)
void	incrementTimeInSeconds(int seconds) Advance or rewind the time of the new state by the given non-negative amount.
void	incrementWalkDistance(double length)
void	incrementWeight(double weight)
boolean	isEverBoarded()
boolean	isMaxPreTransitTimeExceeded(RoutingRequest options)
boolean	isRentingBike()
State	makeState() Why can a state editor only be used once? If you modify some component of state with and editor, use the editor to create a new state, and then make more modifications, these modifications will be applied to the previously created state.
void	setBackMode(TraverseMode mode)
void	setBackWalkingBike(boolean walkingBike)
void	setBikeParked(boolean bikeParked)
void	setBikeRentalNetwork(Set<String> networks)
void	setCarParked(boolean carParked) This has two effects: marks the car as parked, and switches the current mode.
void	setEnteredNoThroughTrafficArea()
void	setEverBoarded(boolean everBoarded)
void	setExtension(Object key, Object value) Put a new value into the State extensions map.
void	setFromState(State state) Set non-incremental state values (ex.
void	setInitialWaitTimeSeconds(long initialWaitTimeSeconds) Initial wait time is recorded so it can be subtracted out of paths in lieu of "reverse optimization".
void	setIsLastBoardAlightDeviated(boolean isLastBoardAlightDeviated)
void	setLastAlightedTimeSeconds(long lastAlightedTimeSeconds)
void	setLastNextArrivalDelta(int lastNextArrivalDelta) The lastNextArrivalDelta is the amount of time between the arrival of the last trip the planner used and the arrival of the trip after that.
void	setLastPattern(TripPattern pattern)
void	setNonTransitOptionsFromState(State state)
void	setNumBoardings(int numBoardings)
void	setOptions(RoutingRequest options)
void	setPreTransitTime(int preTransitTime)
void	setPreviousStop(Stop previousStop)
void	setPreviousTrip(Trip previousTrip)
void	setRoute(FeedScopedId routeId)
void	setServiceDay(ServiceDay day)
void	setStartTimeSeconds(long seconds)
void	setTimeSeconds(long seconds)
void	setTripId(FeedScopedId tripId)
void	setTripTimes(TripTimes tripTimes)
void	setWalkDistance(double walkDistance)
void	setZone(String zone)
String	toString()
boolean	weHaveWalkedTooFar(RoutingRequest options)

Methods inherited from class java.lang.Object

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

Field Detail

child

protected State child

Constructor Detail

StateEditor

protected StateEditor()

StateEditor

public StateEditor(RoutingRequest options,
                   Vertex v)

StateEditor

public StateEditor(State parent,
                   Edge e)

Method Detail

makeState

public State makeState()

Why can a state editor only be used once? If you modify some component of state with and editor, use the editor to create a new state, and then make more modifications, these modifications will be applied to the previously created state. Reusing the state editor to make several states would modify an existing state somewhere earlier in the search, messing up the shortest path tree.

weHaveWalkedTooFar

public boolean weHaveWalkedTooFar(RoutingRequest options)

isMaxPreTransitTimeExceeded

public boolean isMaxPreTransitTimeExceeded(RoutingRequest options)

toString

public String toString()

Overrides:

toString in class Object

setExtension

public void setExtension(Object key,
                         Object value)

Put a new value into the State extensions map. This will always clone the extensions map before it is modified the first time, making sure that other references to the map in earlier States are unaffected.

blockTraversal

public void blockTraversal()

Tell the stateEditor to return null when makeState() is called, no matter what other editing has been done. This allows graph patches to block traversals.

incrementWeight

public void incrementWeight(double weight)

incrementTimeInSeconds

public void incrementTimeInSeconds(int seconds)

Advance or rewind the time of the new state by the given non-negative amount. Direction of time is inferred from the direction of traversal. This is the only element of state that runs backward when traversing backward.

incrementTimeInMilliseconds

public void incrementTimeInMilliseconds(long milliseconds)

incrementWalkDistance

public void incrementWalkDistance(double length)

incrementPreTransitTime

public void incrementPreTransitTime(int seconds)

incrementCallAndRideTime

public void incrementCallAndRideTime(int seconds)

incrementNumBoardings

public void incrementNumBoardings()

setTripTimes

public void setTripTimes(TripTimes tripTimes)

setTripId

public void setTripId(FeedScopedId tripId)

setPreviousTrip

public void setPreviousTrip(Trip previousTrip)

setEnteredNoThroughTrafficArea

public void setEnteredNoThroughTrafficArea()

setInitialWaitTimeSeconds

public void setInitialWaitTimeSeconds(long initialWaitTimeSeconds)

Initial wait time is recorded so it can be subtracted out of paths in lieu of "reverse optimization". This happens in Analyst.

setBackMode

public void setBackMode(TraverseMode mode)

setBackWalkingBike

public void setBackWalkingBike(boolean walkingBike)

setLastNextArrivalDelta

public void setLastNextArrivalDelta(int lastNextArrivalDelta)

The lastNextArrivalDelta is the amount of time between the arrival of the last trip the planner used and the arrival of the trip after that.

setWalkDistance

public void setWalkDistance(double walkDistance)

setPreTransitTime

public void setPreTransitTime(int preTransitTime)

setZone

public void setZone(String zone)

setRoute

public void setRoute(FeedScopedId routeId)

setNumBoardings

public void setNumBoardings(int numBoardings)

setEverBoarded

public void setEverBoarded(boolean everBoarded)

beginVehicleRenting

public void beginVehicleRenting(TraverseMode vehicleMode)

doneVehicleRenting

public void doneVehicleRenting()

setCarParked

public void setCarParked(boolean carParked)

This has two effects: marks the car as parked, and switches the current mode. Marking the car parked is important for allowing co-dominance of walking and driving states.

setBikeParked

public void setBikeParked(boolean bikeParked)

setPreviousStop

public void setPreviousStop(Stop previousStop)

setLastAlightedTimeSeconds

public void setLastAlightedTimeSeconds(long lastAlightedTimeSeconds)

setTimeSeconds

public void setTimeSeconds(long seconds)

setStartTimeSeconds

public void setStartTimeSeconds(long seconds)

setFromState

public void setFromState(State state)

Set non-incremental state values (ex. State.getRoute()) from an existing state. Incremental values (ex. State.getNumBoardings()) are not currently set.

Parameters:

state -

setNonTransitOptionsFromState

public void setNonTransitOptionsFromState(State state)

getExtension

public Object getExtension(Object key)

getTimeSeconds

public long getTimeSeconds()

getElapsedTimeSeconds

public long getElapsedTimeSeconds()

getTripId

public FeedScopedId getTripId()

getPreviousTrip

public Trip getPreviousTrip()

getZone

public String getZone()

getRoute

public FeedScopedId getRoute()

getNumBoardings

public int getNumBoardings()

isEverBoarded

public boolean isEverBoarded()

isRentingBike

public boolean isRentingBike()

getLastAlightedTimeSeconds

public long getLastAlightedTimeSeconds()

getWalkDistance

public double getWalkDistance()

getPreTransitTime

public int getPreTransitTime()

getCallAndRideTime

public int getCallAndRideTime()

getVertex

public Vertex getVertex()

alightTransit

public void alightTransit()

setLastPattern

public void setLastPattern(TripPattern pattern)

setIsLastBoardAlightDeviated

public void setIsLastBoardAlightDeviated(boolean isLastBoardAlightDeviated)

setOptions

public void setOptions(RoutingRequest options)

setServiceDay

public void setServiceDay(ServiceDay day)

setBikeRentalNetwork

public void setBikeRentalNetwork(Set<String> networks)

hasEnteredNoThroughTrafficArea

public boolean hasEnteredNoThroughTrafficArea()