org.opentripplanner.model

Class StopPattern

java.lang.Object

org.opentripplanner.model.StopPattern

All Implemented Interfaces:

Serializable

public class StopPattern
extends Object
implements Serializable

This class represents what is called a JourneyPattern in Transmodel: the sequence of stops at which a trip (GTFS) or vehicle journey (Transmodel) calls, irrespective of the day on which service runs. An important detail: Routes in GTFS are not a structurally important element, they just serve as user-facing information. It is possible for the same journey pattern to appear in more than one route. OTP already has several classes that represent this same thing: A TripPattern in the context of routing. It represents all trips with the same stop pattern A ScheduledStopPattern in the GTFS loading process. A RouteVariant in the TransitIndex, which has a unique human-readable name and belongs to a particular route. We would like to combine all these different classes into one. Any two trips with the same stops in the same order, and that operate on the same days, can be combined using a TripPattern to simplify the graph. This saves memory and reduces search complexity since we only consider the trip that departs soonest for each pattern. AgencyAndId calendarId has been removed. See issue #1320. A StopPattern is very closely related to a TripPattern -- it essentially serves as the unique key for a TripPattern. Should the route be included in the StopPattern?

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
int[]	dropoffs
static int	PICKDROP_CALL_AGENCY
static int	PICKDROP_COORDINATE_WITH_DRIVER
static int	PICKDROP_NONE
static int	PICKDROP_SCHEDULED
int[]	pickups
int	size
org.onebusaway.gtfs.model.Stop[]	stops

Constructor Summary

Constructors

Constructor and Description
StopPattern(List<org.onebusaway.gtfs.model.StopTime> stopTimes) Assumes that stopTimes are already sorted by time.

Method Summary

Modifier and Type	Method and Description
boolean	containsStop(String stopId)
boolean	equals(Object other)
int	hashCode()
com.google.common.hash.HashCode	semanticHash(com.google.common.hash.HashFunction hashFunction) In most cases we want to use identity equality for StopPatterns.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

PICKDROP_SCHEDULED

public static final int PICKDROP_SCHEDULED

See Also:

Constant Field Values

PICKDROP_NONE

public static final int PICKDROP_NONE

See Also:

Constant Field Values

PICKDROP_CALL_AGENCY

public static final int PICKDROP_CALL_AGENCY

See Also:

Constant Field Values

PICKDROP_COORDINATE_WITH_DRIVER

public static final int PICKDROP_COORDINATE_WITH_DRIVER

See Also:

Constant Field Values

size

public final int size

stops

public final org.onebusaway.gtfs.model.Stop[] stops

pickups

public final int[] pickups

dropoffs

public final int[] dropoffs

Constructor Detail

StopPattern

public StopPattern(List<org.onebusaway.gtfs.model.StopTime> stopTimes)

Assumes that stopTimes are already sorted by time.

Method Detail

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

containsStop

public boolean containsStop(String stopId)

Parameters:

stopId - in agency_id format

semanticHash

public com.google.common.hash.HashCode semanticHash(com.google.common.hash.HashFunction hashFunction)

In most cases we want to use identity equality for StopPatterns. There is a single StopPattern instance for each semantic StopPattern, and we don't want to calculate complicated hashes or equality values during normal execution. However, in some cases we want a way to consistently identify trips across versions of a GTFS feed, when the feed publisher cannot ensure stable trip IDs. Therefore we define some additional hash functions.