org.opentripplanner.routing.edgetype

Class Timetable

java.lang.Object

org.opentripplanner.routing.edgetype.Timetable

All Implemented Interfaces:

Serializable

public class Timetable
extends Object
implements Serializable

Timetables provide most of the TripPattern functionality. Each TripPattern may possess more than one Timetable when stop time updates are being applied: one for the scheduled stop times, one for each snapshot of updated stop times, another for a working buffer of updated stop times, etc.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
List<FrequencyEntry>	frequencyEntries Contains one FrequencyEntry object for each block of frequency-based trips.
TripPattern	pattern A circular reference between TripPatterns and their scheduled (non-updated) timetables.
ServiceDate	serviceDate The ServiceDate for which this (updated) timetable is valid.
List<TripTimes>	tripTimes Contains one TripTimes object for each scheduled trip (even cancelled ones) and possibly additional TripTimes objects for unscheduled trips.

Constructor Summary

Constructors

Constructor and Description
Timetable(TripPattern pattern) Construct an empty Timetable.

Method Summary

Modifier and Type	Method and Description
void	addFrequencyEntry(FrequencyEntry freq) Add a frequency entry to this Timetable.
void	addTripTimes(TripTimes tt) Add a trip to this Timetable.
TripTimes	createUpdatedTripTimes(GtfsRealtime.TripUpdate tripUpdate, TimeZone timeZone, ServiceDate updateServiceDate) Apply the TripUpdate to the appropriate TripTimes from this Timetable.
void	finish() Finish off a Timetable once all TripTimes have been added to it.
int	getBestDwellTime(int stopIndex) Returns the shortest possible dwell time at this stop
int	getBestRunningTime(int stopIndex) Returns the shortest possible running time for this stop
int	getMaxTime()
int	getMinTime()
TripTimes	getNextCallNRideTrip(State s0, ServiceDay serviceDay, int stopIndex, boolean boarding, int directTime)
TripTimes	getNextTrip(State s0, ServiceDay serviceDay, int stopIndex, boolean boarding) Get the next (previous) trip that departs (arrives) from the specified stop at or after (before) the specified time.
TripTimes	getNextTrip(State s0, ServiceDay serviceDay, int stopIndex, boolean boarding, double flexOffsetScale, int flexPreBoardDirectTime, int flexPostAlightDirectTime) Get the next (previous) trip that departs (arrives) from the specified stop at or after (before) the specified time.
int	getTripIndex(FeedScopedId tripId)
int	getTripIndex(String tripId)
TripTimes	getTripTimes(int tripIndex)
TripTimes	getTripTimes(Trip trip)
boolean	isValidFor(ServiceDate serviceDate)
void	setServiceCodes(Map<FeedScopedId,Integer> serviceCodes) Find and cache service codes.
TripTimes	setTripTimes(int tripIndex, TripTimes tt) Set new trip times for trip given a trip index
boolean	temporallyViable(ServiceDay sd, long searchTime, int bestWait, boolean boarding) Before performing the relatively expensive iteration over all the trips in this pattern, check whether it's even possible to board any of them given the time at which we are searching, and whether it's possible that any of them could improve on the best known time.

Methods inherited from class java.lang.Object

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

Field Detail

pattern

public final TripPattern pattern

A circular reference between TripPatterns and their scheduled (non-updated) timetables.

tripTimes

public final List<TripTimes> tripTimes

Contains one TripTimes object for each scheduled trip (even cancelled ones) and possibly additional TripTimes objects for unscheduled trips. Frequency entries are stored separately.

frequencyEntries

public final List<FrequencyEntry> frequencyEntries

Contains one FrequencyEntry object for each block of frequency-based trips.

serviceDate

public final ServiceDate serviceDate

The ServiceDate for which this (updated) timetable is valid. If null, then it is valid for all dates.

Constructor Detail

Timetable

public Timetable(TripPattern pattern)

Construct an empty Timetable.

Method Detail

temporallyViable

public boolean temporallyViable(ServiceDay sd,
                                long searchTime,
                                int bestWait,
                                boolean boarding)

Before performing the relatively expensive iteration over all the trips in this pattern, check whether it's even possible to board any of them given the time at which we are searching, and whether it's possible that any of them could improve on the best known time. This is only an optimization, but a significant one. When we search for departures, we look at three separate days: yesterday, today, and tomorrow. Many patterns do not have service at all hours of the day or past midnight. This optimization can cut the search time for each pattern by 66 to 100 percent.

Parameters:

bestWait - -1 means there is not yet any best known time.

getNextTrip

public TripTimes getNextTrip(State s0,
                             ServiceDay serviceDay,
                             int stopIndex,
                             boolean boarding,
                             double flexOffsetScale,
                             int flexPreBoardDirectTime,
                             int flexPostAlightDirectTime)

Get the next (previous) trip that departs (arrives) from the specified stop at or after (before) the specified time. For GTFS-Flex service, this method will take into account the fact that the passenger may be boarding or alighting midway between stops (flag stops), and that the vehicle may be deviating off-route to pick up or drop off the passenger (deviated-route service.) In both cases, unscheduled timepoints on the route in between scheduled stops are calculated via linear interpolation. The parameters `flexOffsetScale`, `preBoardDirectTime`, and `postAlightDirectTime` are specific to GTFS-Flex service. If arrivals/departures are being evaluated for default fixed-route service, these parameters will have the value 0 (see getNextTrip(State, ServiceDay, int, boolean)).

Parameters:

s0 - State to evaluate the method at; the method uses the state's time.

serviceDay - Only consider trips if their service_id is active on this day

stopIndex - Index of stop in the trip to evaluate departure or arrival at

boarding - If true, find next trip which departs specified stop; if false, find previous trip which arrives at specified stop

flexOffsetScale - For GTFS-Flex routing, a control parameter to determine the amount of seconds to offset the scheduled timepoint due to a board/alight in the middle of a FlexPatternHop. Use the percentage in [0, 1] ([-1, 0]) from the beginning (end) of the hop at which the board (alight) is taking place. Note that the value is expected to be negative when evaluating alight points. Use 0 if this is not a flag stop or deviated-route board (alight) point.

flexPreBoardDirectTime - For GTFS-Flex routing, the amount of time the vehicle travels before rejoining the route, or 0 if this is not a deviated- route board (alight) point.

flexPostAlightDirectTime - For GTFS-Flex routing, the amount of time the vehicle travels after leaving the route, or 0 if this is not a deviated-route board (alight) point.

Returns:

the TripTimes object representing the (possibly updated) best trip, or null if no trip matches both the time and other criteria.

getNextTrip

public TripTimes getNextTrip(State s0,
                             ServiceDay serviceDay,
                             int stopIndex,
                             boolean boarding)

Get the next (previous) trip that departs (arrives) from the specified stop at or after (before) the specified time.

Parameters:

s0 - State to evaluate the method at; the method uses the state's time.

serviceDay - Only consider trips if their service_id is active on this day

stopIndex - index of stop in the trip to evaluate departure or arrival at

boarding - if true, find next trip which departs specified stop; if false, find previous trip which arrives at specified stop

Returns:

the TripTimes object representing the (possibly updated) best trip, or null if no trip matches both the time and other criteria.

getNextCallNRideTrip

public TripTimes getNextCallNRideTrip(State s0,
                                      ServiceDay serviceDay,
                                      int stopIndex,
                                      boolean boarding,
                                      int directTime)

finish

public void finish()

Finish off a Timetable once all TripTimes have been added to it. This involves caching lower bounds on the running times and dwell times at each stop, and may perform other actions to compact the data structure such as trimming and deduplicating arrays.

getTripIndex

public int getTripIndex(FeedScopedId tripId)

Returns:

the index of TripTimes for this trip ID in this particular Timetable

getTripIndex

public int getTripIndex(String tripId)

Returns:

the index of TripTimes for this trip ID in this particular Timetable, ignoring AgencyIds.

getTripTimes

public TripTimes getTripTimes(int tripIndex)

getTripTimes

public TripTimes getTripTimes(Trip trip)

setTripTimes

public TripTimes setTripTimes(int tripIndex,
                              TripTimes tt)

Set new trip times for trip given a trip index

Parameters:

tripIndex - trip index of trip

tt - new trip times for trip

Returns:

old trip times of trip

createUpdatedTripTimes

public TripTimes createUpdatedTripTimes(GtfsRealtime.TripUpdate tripUpdate,
                                        TimeZone timeZone,
                                        ServiceDate updateServiceDate)

Apply the TripUpdate to the appropriate TripTimes from this Timetable. The existing TripTimes must not be modified directly because they may be shared with the underlying scheduledTimetable, or other updated Timetables. The TimetableSnapshot performs the protective copying of this Timetable. It is not done in this update method to avoid repeatedly cloning the same Timetable when several updates are applied to it at once. We assume here that all trips in a timetable are from the same feed, which should always be the case.

Parameters:

tripUpdate - GTFS-RT trip update

timeZone - time zone of trip update

updateServiceDate - service date of trip update

Returns:

new copy of updated TripTimes after TripUpdate has been applied on TripTimes of trip with the id specified in the trip descriptor of the TripUpdate; null if something went wrong

addTripTimes

public void addTripTimes(TripTimes tt)

Add a trip to this Timetable. The Timetable must be analyzed, compacted, and indexed any time trips are added, but this is not done automatically because it is time consuming and should only be done once after an entire batch of trips are added. Note that the trip is not added to the enclosing pattern here, but in the pattern's wrapper function. Here we don't know if it's a scheduled trip or a realtime-added trip.

addFrequencyEntry

public void addFrequencyEntry(FrequencyEntry freq)

Add a frequency entry to this Timetable. See addTripTimes method. Maybe Frequency Entries should just be TripTimes for simplicity.

getBestRunningTime

public int getBestRunningTime(int stopIndex)

Returns the shortest possible running time for this stop

getBestDwellTime

public int getBestDwellTime(int stopIndex)

Returns the shortest possible dwell time at this stop

isValidFor

public boolean isValidFor(ServiceDate serviceDate)

setServiceCodes

public void setServiceCodes(Map<FeedScopedId,Integer> serviceCodes)

Find and cache service codes. Duplicates information in trip.getServiceId for optimization.

getMaxTime

public int getMaxTime()

getMinTime

public int getMinTime()