org.opentripplanner.routing.trippattern

Class FrequencyEntry

java.lang.Object

org.opentripplanner.routing.trippattern.FrequencyEntry

All Implemented Interfaces:

Serializable

public class FrequencyEntry
extends Object
implements Serializable

Uses a TripTimes to represent multiple trips following the same template at regular intervals. (see GTFS frequencies.txt)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
int	endTime
boolean	exactTimes
int	headway
int	startTime
TripTimes	tripTimes

Constructor Summary

Constructors

Constructor and Description
FrequencyEntry(org.onebusaway.gtfs.model.Frequency freq, TripTimes tripTimes)
FrequencyEntry(int startTime, int endTime, int headway, boolean exactTimes, TripTimes tripTimes)

Method Summary

Modifier and Type	Method and Description
int	getMaxArrival()
int	getMinDeparture()
TripTimes	materialize(int stop, int time, boolean depart) Returns a disposable TripTimes for this frequency entry in which the vehicle passes the given stop index (not stop sequence number) at the given time.
int	nextDepartureTime(int stop, int time)
int	numTrips()
int	prevArrivalTime(int stop, int t)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

startTime

public final int startTime

endTime

public final int endTime

headway

public final int headway

exactTimes

public final boolean exactTimes

tripTimes

public final TripTimes tripTimes

Constructor Detail

FrequencyEntry

public FrequencyEntry(org.onebusaway.gtfs.model.Frequency freq,
                      TripTimes tripTimes)

FrequencyEntry

public FrequencyEntry(int startTime,
                      int endTime,
                      int headway,
                      boolean exactTimes,
                      TripTimes tripTimes)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

nextDepartureTime

public int nextDepartureTime(int stop,
                             int time)

prevArrivalTime

public int prevArrivalTime(int stop,
                           int t)

materialize

public TripTimes materialize(int stop,
                             int time,
                             boolean depart)

Returns a disposable TripTimes for this frequency entry in which the vehicle passes the given stop index (not stop sequence number) at the given time. This allows us to separate the departure/arrival search process from actually instantiating a TripTimes, to avoid making too many short-lived clones. This delegation is a sign that maybe FrequencyEntry should subclass TripTimes.

numTrips

public int numTrips()

Returns:

the maximum number of trips this frequency entry could represent, given its headway.

getMinDeparture

public int getMinDeparture()

Returns:

the minimum time in seconds since midnight at which a trip may depart on this frequency definition.

getMaxArrival

public int getMaxArrival()

Returns:

the maximum time in seconds since midnight at which a trip may arrive on this frequency definition.