TripPattern (OpenTripPlanner 1.5.0-SNAPSHOT API)

java.lang.Object
- org.opentripplanner.routing.edgetype.TripPattern

All Implemented Interfaces:

Serializable, Cloneable
```
public class TripPattern
extends Object
implements Cloneable, Serializable
```
Represents a group of trips on a route, with the same direction id that all call at the same sequence of stops. For each stop, there is a list of departure times, running times, arrival times, dwell times, and wheelchair accessibility information (one of each of these per trip per stop). Trips are assumed to be non-overtaking, so that an earlier trip never arrives after a later trip. This is called a JOURNEY_PATTERN in the Transmodel vocabulary. However, GTFS calls a Transmodel JOURNEY a "trip", thus TripPattern.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`TransitBoardAlight[]`	`alightEdges`
`PatternArriveVertex[]`	`arriveVertices`
`TransitBoardAlight[]`	`boardEdges`
`String`	`code` The short unique identifier for this trip pattern, generally in the format Agency:RouteId:DirectionId:PatternNumber.
`PatternDepartVertex[]`	`departVertices`
`int`	`directionId` The direction id for all trips in this pattern.
`PatternDwell[]`	`dwellEdges`
`static int`	`FLAG_BIKES_ALLOWED`
`static int`	`FLAG_WHEELCHAIR_ACCESSIBLE`
`org.locationtech.jts.geom.LineString`	`geometry` Used by the MapBuilder (and should be exposed by the Index API).
`PatternHop[]`	`hopEdges`
`static int`	`MASK_DROPOFF`
`static int`	`MASK_PICKUP`
`TraverseMode`	`mode` The traverse mode for all trips in this pattern.
`String`	`name` The human-readable, unique name for this trip pattern.
`static int`	`NO_PICKUP`
`Route`	`route` The GTFS Route of all trips in this pattern.
`Timetable`	`scheduledTimetable` This is the "original" timetable holding the scheduled stop times from GTFS, with no realtime updates applied.
`static int`	`SHIFT_DROPOFF`
`static int`	`SHIFT_PICKUP`
`StopPattern`	`stopPattern` All trips in this pattern call at this sequence of stops.
`TransitStop[]`	`stopVertices`

Constructor Summary

Constructors
Constructor and Description

TripPattern(Route route, StopPattern stopPattern)

Constructors
Constructor and Description
`TripPattern(Route route, StopPattern stopPattern)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(FrequencyEntry freq)` Add the given FrequencyEntry to this pattern's scheduled timetable, recording the corresponding trip as one of the scheduled trips on this pattern.
`void`	`add(TripTimes tt)` Add the given tripTimes to this pattern's scheduled timetable, recording the corresponding trip as one of the scheduled trips on this pattern.
`boolean`	`canAlight(int stopIndex)` Returns whether passengers can alight at a given stop
`boolean`	`canBoard(int stopIndex)` Returns whether passengers can board at a given stop
`TripPattern`	`clone()`
`void`	`dumpServices()`
`void`	`dumpVertices()`
`static void`	`generateUniqueIds(Collection<TripPattern> tripPatterns)` Patterns do not have unique IDs in GTFS, so we make some by concatenating agency id, route id, the direction and an integer.
`static void`	`generateUniqueNames(Collection<TripPattern> tableTripPatterns)` Static method that creates unique human-readable names for a collection of TableTripPatterns.
`int`	`getAlightType(int stopIndex)`
`int`	`getBoardType(int stopIndex)`
`String`	`getDirection()`
`Trip`	`getExemplar()`
`String`	`getFeedId()` Get the feed id this trip pattern belongs to.
`int`	`getNumScheduledTrips()` Gets the number of scheduled trips on this pattern.
`List<PatternHop>`	`getPatternHops()`
`TripTimes`	`getResolvedTripTimes(int tripIndex, State state0)`
`TripTimes`	`getResolvedTripTimes(Trip trip, State state0)`
`BitSet`	`getServices()`
`FrequencyEntry`	`getSingleFrequencyEntry()` This method can be used in very specific circumstances, where each TripPattern has only one FrequencyEntry.
`Stop`	`getStop(int stopIndex)`
`List<Stop>`	`getStops()`
`Trip`	`getTrip(int tripIndex)`
`int`	`getTripIndex(Trip trip)`
`List<Trip>`	`getTrips()`
`Timetable`	`getUpdatedTimetable(RoutingRequest req, ServiceDay sd)` Rather than the scheduled timetable, get the one that has been updated with real-time updates.
`String`	`getZone(int stopIndex)` Returns the zone of a given stop
`boolean`	`hasFlexService()`
`void`	`makeGeometry()` Generates a geometry for the full pattern.
`void`	`makePatternVerticesAndEdges(Graph graph, Map<Stop,? extends TransitStationStop> transitStops)` Create the PatternStop vertices and PatternBoard/Hop/Dwell/Alight edges corresponding to a StopPattern/TripPattern.
`String`	`semanticHashString(Trip trip)` In most cases we want to use identity equality for Trips.
`void`	`setServiceCodes(Map<FeedScopedId,Integer> serviceCodes)` A bit of a strange place to set service codes all at once when TripTimes are already added, but we need a reference to the Graph or at least the codes map.
`void`	`setServices(BitSet services)`
`String`	`toString()`
`boolean`	`wheelchairAccessible(int stopIndex)` Returns whether a given stop is wheelchair-accessible.

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

- Field Detail
  - FLAG_WHEELCHAIR_ACCESSIBLE
```
public static final int FLAG_WHEELCHAIR_ACCESSIBLE
```
    See Also:
    
    Constant Field Values
  - MASK_PICKUP
```
public static final int MASK_PICKUP
```
    See Also:
    
    Constant Field Values
  - SHIFT_PICKUP
```
public static final int SHIFT_PICKUP
```
    See Also:
    
    Constant Field Values
  - MASK_DROPOFF
```
public static final int MASK_DROPOFF
```
    See Also:
    
    Constant Field Values
  - SHIFT_DROPOFF
```
public static final int SHIFT_DROPOFF
```
    See Also:
    
    Constant Field Values
  - NO_PICKUP
```
public static final int NO_PICKUP
```
    See Also:
    
    Constant Field Values
  - FLAG_BIKES_ALLOWED
```
public static final int FLAG_BIKES_ALLOWED
```
    See Also:
    
    Constant Field Values
  - route
```
public final Route route
```
    The GTFS Route of all trips in this pattern.
  - directionId
```
public int directionId
```
    The direction id for all trips in this pattern. Use -1 for default direction id
  - mode
```
public final TraverseMode mode
```
    The traverse mode for all trips in this pattern.
  - stopPattern
```
public final StopPattern stopPattern
```
    All trips in this pattern call at this sequence of stops. This includes information about GTFS pick-up and drop-off types.
  - scheduledTimetable
```
public final Timetable scheduledTimetable
```
    This is the "original" timetable holding the scheduled stop times from GTFS, with no realtime updates applied. If realtime stoptime updates are applied, next/previous departure searches will be conducted using a different, updated timetable in a snapshot.
  - name
```
public String name
```
    The human-readable, unique name for this trip pattern.
  - code
```
public String code
```
    The short unique identifier for this trip pattern, generally in the format Agency:RouteId:DirectionId:PatternNumber.
  - stopVertices
```
public final TransitStop[] stopVertices
```
  - departVertices
```
public final PatternDepartVertex[] departVertices
```
  - arriveVertices
```
public final PatternArriveVertex[] arriveVertices
```
  - boardEdges
```
public final TransitBoardAlight[] boardEdges
```
  - alightEdges
```
public final TransitBoardAlight[] alightEdges
```
  - hopEdges
```
public final PatternHop[] hopEdges
```
  - dwellEdges
```
public final PatternDwell[] dwellEdges
```
  - geometry
```
public org.locationtech.jts.geom.LineString geometry
```
    Used by the MapBuilder (and should be exposed by the Index API).
- Constructor Detail
  - TripPattern
```
public TripPattern(Route route,
                   StopPattern stopPattern)
```
- Method Detail
  - getStop
```
public Stop getStop(int stopIndex)
```
  - getStops
```
public List<Stop> getStops()
```
  - getPatternHops
```
public List<PatternHop> getPatternHops()
```
  - getTrip
```
public Trip getTrip(int tripIndex)
```
  - getTrips
```
public List<Trip> getTrips()
```
  - getTripIndex
```
public int getTripIndex(Trip trip)
```
  - canAlight
```
public boolean canAlight(int stopIndex)
```
    Returns whether passengers can alight at a given stop
  - canBoard
```
public boolean canBoard(int stopIndex)
```
    Returns whether passengers can board at a given stop
  - wheelchairAccessible
```
public boolean wheelchairAccessible(int stopIndex)
```
    Returns whether a given stop is wheelchair-accessible.
  - getZone
```
public String getZone(int stopIndex)
```
    Returns the zone of a given stop
  - getAlightType
```
public int getAlightType(int stopIndex)
```
  - getBoardType
```
public int getBoardType(int stopIndex)
```
  - getNumScheduledTrips
```
public int getNumScheduledTrips()
```
    Gets the number of scheduled trips on this pattern. Note that when stop time updates are being applied, there may be other Timetables for this pattern which contain a larger number of trips. However, all trips with indexes from 0 through getNumTrips()-1 will always correspond to the scheduled trips.
  - getResolvedTripTimes
```
public TripTimes getResolvedTripTimes(Trip trip,
                                      State state0)
```
  - getResolvedTripTimes
```
public TripTimes getResolvedTripTimes(int tripIndex,
                                      State state0)
```
  - add
```
public void add(TripTimes tt)
```
    Add the given tripTimes to this pattern's scheduled timetable, recording the corresponding trip as one of the scheduled trips on this pattern.
  - add
```
public void add(FrequencyEntry freq)
```
    Add the given FrequencyEntry to this pattern's scheduled timetable, recording the corresponding trip as one of the scheduled trips on this pattern. TODO possible improvements: combine freq entries and TripTimes. Do not keep trips list in TripPattern since it is redundant.
  - getUpdatedTimetable
```
public Timetable getUpdatedTimetable(RoutingRequest req,
                                     ServiceDay sd)
```
    Rather than the scheduled timetable, get the one that has been updated with real-time updates. The view is consistent across a single request, and depends on the routing context in the request.
  - generateUniqueNames
```
public static void generateUniqueNames(Collection<TripPattern> tableTripPatterns)
```
    Static method that creates unique human-readable names for a collection of TableTripPatterns. Perhaps this should be in TripPattern, and apply to Frequency patterns as well. TODO: resolve this question: can a frequency and table pattern have the same stoppattern? If so should they have the same "unique" name? The names should be dataset unique, not just route-unique? A TripPattern groups all trips visiting a particular pattern of stops on a particular route. GFTS Route names are intended for very general customer information, but sometimes there is a need to know where a particular trip actually goes. For example, the New York City N train has at least four different variants: express (over the Manhattan bridge) and local (via lower Manhattan and the tunnel), in two directions (to Astoria or to Coney Island). During construction, a fifth variant sometimes appears: trains use the D line to Coney Island after 59th St (or from Coney Island to 59th in the opposite direction). TripPattern names are machine-generated on a best-effort basis. They are guaranteed to be unique (among TripPatterns for a single Route) but not stable across graph builds, especially when different versions of GTFS inputs are used. For instance, if a variant is the only variant of the N that ends at Coney Island, the name will be "N to Coney Island". But if multiple variants end at Coney Island (but have different stops elsewhere), that name would not be chosen. OTP also tries start and intermediate stations ("from Coney Island", or "via Whitehall", or even combinations ("from Coney Island via Whitehall"). But if there is no way to create a unique name from start/end/intermediate stops, then the best we can do is to create a "like [trip id]" name, which at least tells you where in the GTFS you can find a related trip.
  - makePatternVerticesAndEdges
```
public void makePatternVerticesAndEdges(Graph graph,
                                        Map<Stop,? extends TransitStationStop> transitStops)
```
    Create the PatternStop vertices and PatternBoard/Hop/Dwell/Alight edges corresponding to a StopPattern/TripPattern. StopTimes are passed in instead of Stops only because they are needed for shape distances (actually, stop sequence numbers?).
    
    Parameters:
    
    graph - graph to create vertices and edges in
    
    transitStops - map of transit stops given the stop; it is assumed all stops of this trip pattern are included in this map and refer to TransitStops
  - dumpServices
```
public void dumpServices()
```
  - dumpVertices
```
public void dumpVertices()
```
  - setServiceCodes
```
public void setServiceCodes(Map<FeedScopedId,Integer> serviceCodes)
```
    A bit of a strange place to set service codes all at once when TripTimes are already added, but we need a reference to the Graph or at least the codes map. This could also be placed in the hop factory itself.
  - getServices
```
public BitSet getServices()
```
    Returns:
    
    bitset of service codes
  - setServices
```
public void setServices(BitSet services)
```
    Parameters:
    
    services - bitset of service codes
  - getDirection
```
public String getDirection()
```
  - generateUniqueIds
```
public static void generateUniqueIds(Collection<TripPattern> tripPatterns)
```
    Patterns do not have unique IDs in GTFS, so we make some by concatenating agency id, route id, the direction and an integer. This only works if the Collection of TripPattern includes every TripPattern for the agency.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - makeGeometry
```
public void makeGeometry()
```
    Generates a geometry for the full pattern. This is done by concatenating the shapes of all the constituent hops. It could probably just come from the full shapes.txt entry for the trips in the route, but given all the details in how the individual hop geometries are constructed we just recombine them here.
  - getExemplar
```
public Trip getExemplar()
```
  - semanticHashString
```
public String semanticHashString(Trip trip)
```
    In most cases we want to use identity equality for Trips. 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. Hash collisions are theoretically possible, so these identifiers should only be used to detect when two trips are the same with a high degree of probability. An example application is avoiding double-booking of a particular bus trip for school field trips. Using Murmur hash function. see http://programmers.stackexchange.com/a/145633 for comparison.
    
    Parameters:
    
    trip - a trip object within this pattern, or null to hash the pattern itself independent any specific trip.
    
    Returns:
    
    the semantic hash of a Trip in this pattern as a printable String. TODO deal with frequency-based trips
  - getSingleFrequencyEntry
```
public FrequencyEntry getSingleFrequencyEntry()
```
    This method can be used in very specific circumstances, where each TripPattern has only one FrequencyEntry.
  - clone
```
public TripPattern clone()
```
    Overrides:
    
    clone in class Object
  - getFeedId
```
public String getFeedId()
```
    Get the feed id this trip pattern belongs to.
    
    Returns:
    
    feed id for this trip pattern
  - hasFlexService
```
public boolean hasFlexService()
```

Class TripPattern

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FLAG_WHEELCHAIR_ACCESSIBLE

MASK_PICKUP

SHIFT_PICKUP

MASK_DROPOFF

SHIFT_DROPOFF

NO_PICKUP

FLAG_BIKES_ALLOWED

route

directionId

mode

stopPattern

scheduledTimetable

name

code

stopVertices

departVertices

arriveVertices

boardEdges

alightEdges

hopEdges

dwellEdges

geometry

Constructor Detail

TripPattern

Method Detail

getStop

getStops

getPatternHops

getTrip

getTrips

getTripIndex

canAlight

canBoard

wheelchairAccessible

getZone

getAlightType

getBoardType

getNumScheduledTrips

getResolvedTripTimes

getResolvedTripTimes

add

add

getUpdatedTimetable

generateUniqueNames

makePatternVerticesAndEdges

dumpServices

dumpVertices

setServiceCodes

getServices

setServices

getDirection

generateUniqueIds

toString

makeGeometry

getExemplar

semanticHashString

getSingleFrequencyEntry

clone

getFeedId

hasFlexService