org.onebusaway.transit_data_federation.services
Interface StopTimeService

public interface StopTimeService

Service methods for determining the set of active stop times at a particular stop and time.

Author:

bdferris

See Also:

StopTimeInstance

Nested Class Summary

static class

StopTimeService.EFrequencyStopTimeBehavior When calculating frequency-based stop times, we have a couple different options when return results

Method Summary

org.onebusaway.collections.Range	getDepartureForStopAndServiceDate(org.onebusaway.gtfs.model.AgencyAndId stopId, org.onebusaway.gtfs.model.calendar.ServiceDate serviceDate)
List<StopTimeInstance>	getNextBlockSequenceDeparturesForStop(StopEntry stop, long time, boolean includePrivateSerivce) Given the set of BlockSequence sequences incident on a particular stop, compute the next departure for each sequence at or after the specified time.
List<org.onebusaway.collections.tuple.Pair<StopTimeInstance>>	getNextDeparturesBetweenStopPair(StopEntry fromStop, StopEntry toStop, Date fromTime, int runningEarlySlack, int runningLateSlack, int resultCount, boolean includePrivateService)
List<org.onebusaway.collections.tuple.Pair<StopTimeInstance>>	getPreviousArrivalsBetweenStopPair(StopEntry fromStop, StopEntry toStop, Date toTime, int runningEarlySlack, int runningLateSlack, int resultCount, boolean includePrivateService)
List<StopTimeInstance>	getStopTimeInstancesInTimeRange(org.onebusaway.gtfs.model.AgencyAndId stopId, Date from, Date to) Determines the set of active stop time instances at a given stop, taking into account information like active service dates, etc
List<StopTimeInstance>	getStopTimeInstancesInTimeRange(StopEntry stopEntry, Date from, Date to, StopTimeService.EFrequencyStopTimeBehavior frequencyBehavior) Determines the set of active stop time instances at a given stop, taking into account information like active service dates, etc

Method Detail

getStopTimeInstancesInTimeRange

List<StopTimeInstance> getStopTimeInstancesInTimeRange(org.onebusaway.gtfs.model.AgencyAndId stopId,
                                                       Date from,
                                                       Date to)

Determines the set of active stop time instances at a given stop, taking into account information like active service dates, etc

Parameters:

stopId - the starget stop id

from -

to -

Returns:

the set of active stop time instances in the specified time range

getStopTimeInstancesInTimeRange

List<StopTimeInstance> getStopTimeInstancesInTimeRange(StopEntry stopEntry,
                                                       Date from,
                                                       Date to,
                                                       StopTimeService.EFrequencyStopTimeBehavior frequencyBehavior)

Determines the set of active stop time instances at a given stop, taking into account information like active service dates, etc

Parameters:

stopEntry -

from -

to -

frequencyBehavior - how to handle frequency-based stop times

Returns:

the set of active stop time instances in the specified time range

getDepartureForStopAndServiceDate

org.onebusaway.collections.Range getDepartureForStopAndServiceDate(org.onebusaway.gtfs.model.AgencyAndId stopId,
                                                                   org.onebusaway.gtfs.model.calendar.ServiceDate serviceDate)

getNextBlockSequenceDeparturesForStop

List<StopTimeInstance> getNextBlockSequenceDeparturesForStop(StopEntry stop,
                                                             long time,
                                                             boolean includePrivateSerivce)

Given the set of BlockSequence sequences incident on a particular stop, compute the next departure for each sequence at or after the specified time.

Parameters:

stop -

time -

includePrivateSerivce - TODO

Returns:

getNextDeparturesBetweenStopPair

List<org.onebusaway.collections.tuple.Pair<StopTimeInstance>> getNextDeparturesBetweenStopPair(StopEntry fromStop,
                                                                                               StopEntry toStop,
                                                                                               Date fromTime,
                                                                                               int runningEarlySlack,
                                                                                               int runningLateSlack,
                                                                                               int resultCount,
                                                                                               boolean includePrivateService)

getPreviousArrivalsBetweenStopPair

List<org.onebusaway.collections.tuple.Pair<StopTimeInstance>> getPreviousArrivalsBetweenStopPair(StopEntry fromStop,
                                                                                                 StopEntry toStop,
                                                                                                 Date toTime,
                                                                                                 int runningEarlySlack,
                                                                                                 int runningLateSlack,
                                                                                                 int resultCount,
                                                                                                 boolean includePrivateService)