TripTimes (OpenTripPlanner 1.4.0 API)

java.lang.Object
- org.opentripplanner.routing.trippattern.TripTimes

All Implemented Interfaces:

Serializable, Cloneable, Comparable<TripTimes>
```
public class TripTimes
extends Object
implements Serializable, Comparable<TripTimes>, Cloneable
```
A TripTimes represents the arrival and departure times for a single trip in an Timetable. It is carried along by States when routing to ensure that they have a consistent, fast view of the trip when realtime updates have been applied. All times are expressed as seconds since midnight (as in GTFS).

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`serviceCode` The code for the service on which this trip runs.
`Trip`	`trip` The trips whose arrivals and departures are represented by this TripTimes
`static int`	`UNAVAILABLE` This constant is used for indicating passed stops, fully canceled trips and trips that are otherwise unavailable during routing.

Constructor Summary

Constructors
Constructor and Description
`TripTimes(Trip trip, List<StopTime> stopTimes, Deduplicator deduplicator)` The provided stopTimes are assumed to be pre-filtered, valid, and monotonically increasing.
`TripTimes(TripTimes object)` This copy constructor does not copy the actual times, only the scheduled times.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`cancel()` Cancel this entire trip
`TripTimes`	`clone()`
`int`	`compareTo(TripTimes other)` Sort TripTimes based on first departure time.
`static String`	`formatSeconds(int s)` Used in debugging / dumping times.
`int`	`getArrivalDelay(int stop)`
`int`	`getArrivalTime(int stop)`
`int`	`getCallAndRideAlightTime(int stop, long currTime, int directTime, ServiceDay sd, boolean useClockTime, long startClockTime)`
`int`	`getCallAndRideBoardTime(int stop, long currTime, int directTime, ServiceDay sd, boolean useClockTime, long startClockTime)`
`int`	`getContinuousDropOff(int stop)` Returns whether this stop allows continuous dropoff
`int`	`getContinuousPickup(int stop)` Returns whether this stop allows continuous pickup
`int`	`getDemandResponseAvgTime(int directTime)`
`int`	`getDemandResponseMaxTime(int directTime)`
`int`	`getDepartureDelay(int stop)`
`int`	`getDepartureTime(int stop)`
`int`	`getDwellTime(int stop)`
`String`	`getHeadsign(int stop)` Trips may also have null headsigns, in which case we should fall back on a Timetable or Pattern-level headsign.
`int`	`getNumStops()`
`RealTimeState`	`getRealTimeState()`
`int`	`getRunningTime(int stop)`
`int`	`getScheduledArrivalTime(int stop)`
`int`	`getScheduledDepartureTime(int stop)`
`String`	`getServiceArea(int stop)`
`double`	`getServiceAreaRadius(int stop)` Returns associated dropoff/pickup radius for this stop
`int`	`getStopSequence(int stop)` Just to create uniform getter-syntax across the whole public interface of TripTimes.
`boolean`	`isCanceled()`
`boolean`	`isScheduled()`
`boolean`	`isTimepoint(int stopIndex)`
`com.google.common.hash.HashCode`	`semanticHash(com.google.common.hash.HashFunction hashFunction)` Hash the scheduled arrival/departure times.
`void`	`setRealTimeState(RealTimeState realTimeState)`
`TripTimes`	`timeShift(int stop, int time, boolean depart)` Returns a time-shifted copy of this TripTimes in which the vehicle passes the given stop index (not stop sequence number) at the given time.
`boolean`	`timesIncreasing()` When creating a scheduled TripTimes or wrapping it in updates, we could potentially imply negative running or dwell times.
`boolean`	`tripAcceptable(State state0, int stopIndex)` Once a trip has been found departing or arriving at an appropriate time, check whether that trip fits other restrictive search criteria such as bicycle and wheelchair accessibility and transfers with minimum time or forbidden transfers.
`void`	`updateArrivalDelay(int stop, int delay)`
`void`	`updateArrivalTime(int stop, int time)`
`void`	`updateDepartureDelay(int stop, int delay)`
`void`	`updateDepartureTime(int stop, int time)`

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - UNAVAILABLE
```
public static final int UNAVAILABLE
```
    This constant is used for indicating passed stops, fully canceled trips and trips that are otherwise unavailable during routing. It should only be used in a contiguous block at the beginning of the trip and may or may not cover the entire trip. Partially canceling a trip in this way is specifically not allowed.
    
    See Also:
    
    Constant Field Values
  - trip
```
public final Trip trip
```
    The trips whose arrivals and departures are represented by this TripTimes
  - serviceCode
```
public int serviceCode
```
    The code for the service on which this trip runs. For departure search optimizations.
- Constructor Detail
  - TripTimes
```
public TripTimes(Trip trip,
                 List<StopTime> stopTimes,
                 Deduplicator deduplicator)
```
    The provided stopTimes are assumed to be pre-filtered, valid, and monotonically increasing. The non-interpolated stoptimes should already be marked at timepoints by a previous filtering step.
  - TripTimes
```
public TripTimes(TripTimes object)
```
    This copy constructor does not copy the actual times, only the scheduled times.
- Method Detail
  - getHeadsign
```
public String getHeadsign(int stop)
```
    Trips may also have null headsigns, in which case we should fall back on a Timetable or Pattern-level headsign. Such a string will be available when we give TripPatterns or StopPatterns unique human readable route variant names, but a TripTimes currently does not have a pointer to its enclosing timetable or pattern.
  - getScheduledArrivalTime
```
public int getScheduledArrivalTime(int stop)
```
    Returns:
    
    the time in seconds after midnight that the vehicle arrives at the stop.
  - getScheduledDepartureTime
```
public int getScheduledDepartureTime(int stop)
```
    Returns:
    
    the amount of time in seconds that the vehicle waits at the stop.
  - getArrivalTime
```
public int getArrivalTime(int stop)
```
    Returns:
    
    the time in seconds after midnight that the vehicle arrives at the stop.
  - getDepartureTime
```
public int getDepartureTime(int stop)
```
    Returns:
    
    the amount of time in seconds that the vehicle waits at the stop.
  - getDwellTime
```
public int getDwellTime(int stop)
```
    Returns:
    
    the amount of time in seconds that the vehicle waits at the stop.
  - getRunningTime
```
public int getRunningTime(int stop)
```
    Returns:
    
    the amount of time in seconds that the vehicle takes to reach the following stop.
  - getArrivalDelay
```
public int getArrivalDelay(int stop)
```
    Returns:
    
    the difference between the scheduled and actual arrival times at this stop.
  - getDepartureDelay
```
public int getDepartureDelay(int stop)
```
    Returns:
    
    the difference between the scheduled and actual departure times at this stop.
  - getCallAndRideBoardTime
```
public int getCallAndRideBoardTime(int stop,
                                   long currTime,
                                   int directTime,
                                   ServiceDay sd,
                                   boolean useClockTime,
                                   long startClockTime)
```
  - getCallAndRideAlightTime
```
public int getCallAndRideAlightTime(int stop,
                                    long currTime,
                                    int directTime,
                                    ServiceDay sd,
                                    boolean useClockTime,
                                    long startClockTime)
```
  - getDemandResponseMaxTime
```
public int getDemandResponseMaxTime(int directTime)
```
  - getDemandResponseAvgTime
```
public int getDemandResponseAvgTime(int directTime)
```
  - isScheduled
```
public boolean isScheduled()
```
    Returns:
    
    true if this TripTimes represents an unmodified, scheduled trip from a published timetable or false if it is a updated, cancelled, or otherwise modified one. This method differs from getRealTimeState() in that it checks whether real-time information is actually available in this TripTimes.
  - isCanceled
```
public boolean isCanceled()
```
    Returns:
    
    true if this TripTimes is canceled
  - getRealTimeState
```
public RealTimeState getRealTimeState()
```
    Returns:
    
    the real-time state of this TripTimes
  - setRealTimeState
```
public void setRealTimeState(RealTimeState realTimeState)
```
  - getContinuousPickup
```
public int getContinuousPickup(int stop)
```
    Returns whether this stop allows continuous pickup
  - getContinuousDropOff
```
public int getContinuousDropOff(int stop)
```
    Returns whether this stop allows continuous dropoff
  - getServiceAreaRadius
```
public double getServiceAreaRadius(int stop)
```
    Returns associated dropoff/pickup radius for this stop
  - getServiceArea
```
public String getServiceArea(int stop)
```
  - formatSeconds
```
public static String formatSeconds(int s)
```
    Used in debugging / dumping times.
  - timesIncreasing
```
public boolean timesIncreasing()
```
    When creating a scheduled TripTimes or wrapping it in updates, we could potentially imply negative running or dwell times. We really don't want those being used in routing. This method check that all times are increasing, and logs errors if this is not the case.
    
    Returns:
    
    whether the times were found to be increasing.
  - tripAcceptable
```
public boolean tripAcceptable(State state0,
                              int stopIndex)
```
    Once a trip has been found departing or arriving at an appropriate time, check whether that trip fits other restrictive search criteria such as bicycle and wheelchair accessibility and transfers with minimum time or forbidden transfers.
  - cancel
```
public void cancel()
```
    Cancel this entire trip
  - updateDepartureTime
```
public void updateDepartureTime(int stop,
                                int time)
```
  - updateDepartureDelay
```
public void updateDepartureDelay(int stop,
                                 int delay)
```
  - updateArrivalTime
```
public void updateArrivalTime(int stop,
                              int time)
```
  - updateArrivalDelay
```
public void updateArrivalDelay(int stop,
                               int delay)
```
  - getNumStops
```
public int getNumStops()
```
  - compareTo
```
public int compareTo(TripTimes other)
```
    Sort TripTimes based on first departure time.
    
    Specified by:
    
    compareTo in interface Comparable<TripTimes>
  - clone
```
public TripTimes clone()
```
    Overrides:
    
    clone in class Object
  - timeShift
```
public TripTimes timeShift(int stop,
                           int time,
                           boolean depart)
```
    Returns a time-shifted copy of this TripTimes in which the vehicle passes the given stop index (not stop sequence number) at the given time. We only have a mechanism to shift the scheduled stoptimes, not the real-time stoptimes. Therefore, this only works on trips without updates for now (frequency trips don't have updates).
  - getStopSequence
```
public int getStopSequence(int stop)
```
    Just to create uniform getter-syntax across the whole public interface of TripTimes.
  - isTimepoint
```
public boolean isTimepoint(int stopIndex)
```
    Returns:
    
    whether or not stopIndex is considered a timepoint in this TripTimes.
  - semanticHash
```
public com.google.common.hash.HashCode semanticHash(com.google.common.hash.HashFunction hashFunction)
```
    Hash the scheduled arrival/departure times. Used in creating stable IDs for trips across GTFS feed versions. Use hops rather than stops because: a) arrival at stop zero and departure from last stop are irrelevant b) this hash function needs to stay stable when users switch from 0.10.x to 1.0

Class TripTimes

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UNAVAILABLE

trip

serviceCode

Constructor Detail

TripTimes

TripTimes

Method Detail

getHeadsign

getScheduledArrivalTime

getScheduledDepartureTime

getArrivalTime

getDepartureTime

getDwellTime

getRunningTime

getArrivalDelay

getDepartureDelay

getCallAndRideBoardTime

getCallAndRideAlightTime

getDemandResponseMaxTime

getDemandResponseAvgTime

isScheduled

isCanceled

getRealTimeState

setRealTimeState

getContinuousPickup

getContinuousDropOff

getServiceAreaRadius

getServiceArea

formatSeconds

timesIncreasing

tripAcceptable

cancel

updateDepartureTime

updateDepartureDelay

updateArrivalTime

updateArrivalDelay

getNumStops

compareTo

clone

timeShift

getStopSequence

isTimepoint

semanticHash