PatternInterlineDwell (OpenTripPlanner 1.4.0 API)

java.lang.Object
- org.opentripplanner.routing.graph.Edge
- - org.opentripplanner.routing.edgetype.PatternInterlineDwell

All Implemented Interfaces:

Serializable, OnboardEdge
```
public class PatternInterlineDwell
extends Edge
implements OnboardEdge
```
A PatternInterlineDwell refers to "interlining", where a single physical vehicle carries out several logical trips and a passenger is optionally allowed to remain on the vehicle as it passes from one trip to the other. Interlining is inferred from block IDs in GTFS input. We do not represent cases where the user is not allowed to remain on the vehicle, as these are only interesting from an operations perspective and not for passenger information. Interline dwell info could be stored in various places, with various advantages and disadvantages: A. In the dwell edge itself (where it is now located). This will get in the way of realtime updates and the eventual elimination of transit edges. B. In TripTimes. This has the disadvantage of leaving null fields in every TripTimes where interlining does not happen, but the null field could be a pointer to a compound type so it doesn't waste too much space. C. In Timetables. Like TripTimes, this option also allows for real-time updates to interlining information. D. TripPatterns. This does not allow full real-time updates to block and interlining behavior. Another option is to store the Trip->Trip mapping at the Graph level, and use the source and target vertices of the interline dwell edges to know which pattern should be used for resolving TripTimes. However, this will get in the way of eventually eliminating transit edges. This could be a Guava BiMap. Links to previous and next trips could be stored directly as fields in TripTimes, or in a map. Previous/next TripTimes in fields will not work because real-time updates to any one TripTimes will "infect" all other TripTimes in its block. Previous/next (Pattern, Trip) tuples in fields will work because the realtime lookup can be performed on the fly. In maps, the trips do not need to be grouped by service ID because each trip exists on only a single service ID. The "previous" and "next" targets in interline dwell information could be: A. TripTimes. This requires refreshing the TripTimes pointers when committing realtime updates to ensure that they do not point to scheduled or outdated TripTimes. However, TripTimes do not currently store which TripPattern they belong to, which could interfere with realtime lookup. B. Tuples of (TripPattern, Trip). This requires resolving the actual TripTimes object at runtime in case there are real-time updates. Storing pointers directly to other TripTimes in prev/next fields in TripTimes prevents those TripTimes from being independent of one another. An update to one TripTimes will "infect" the entire block it belongs to because the prev/next links are bidirectional. Interlining info (Patterns, Trips) can either be stored locally (in the TripPatterns/Timetables) or nonlocally (at the Graph level).

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class org.opentripplanner.routing.graph.Edge
  Edge.ValidVertexTypes

Field Summary
- Fields inherited from class org.opentripplanner.routing.graph.Edge
  fromv, tov

Constructor Summary

Constructors
Constructor and Description
`PatternInterlineDwell(PatternArriveVertex fromv, PatternDepartVertex tov)`
`PatternInterlineDwell(TripPattern p0, TripPattern p1)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(Trip t1, Trip t2)` Register the fact that a passenger may pass from Trip t1 to Trip t2 by staying on the same vehicle.
`org.locationtech.jts.geom.LineString`	`getGeometry()`
`String`	`getName()` Gets english localized name
`String`	`getName(Locale locale)` Gets wanted localization
`int`	`getStopIndex()` The stop index (within the trip) of the stop this edge comes from.
`State`	`optimisticTraverse(State s0)`
`double`	`timeLowerBound(RoutingRequest options)` Returns a lower bound on traversal time given the routing options.
`String`	`toString()`
`State`	`traverse(State state0)` Traverse this edge.
`double`	`weightLowerBound(RoutingRequest options)` Returns a lower bound on edge weight given the routing options.

Methods inherited from class org.opentripplanner.routing.graph.Edge
getAzimuth, getDirection, getDisplayGeometry, getDistance, getFromVertex, getId, getToVertex, getTrip, getValidVertexTypes, hasBogusName, hashCode, isEquivalentTo, isPartial, isReverseOf, isRoundabout, vertexTypesValid

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

- Constructor Detail
  - PatternInterlineDwell
```
public PatternInterlineDwell(TripPattern p0,
                             TripPattern p1)
```
  - PatternInterlineDwell
```
public PatternInterlineDwell(PatternArriveVertex fromv,
                             PatternDepartVertex tov)
```
- Method Detail
  - add
```
public void add(Trip t1,
                Trip t2)
```
    Register the fact that a passenger may pass from Trip t1 to Trip t2 by staying on the same vehicle. Trip t1 must be on the TripPattern this edge comes from, and trip t2 must be on the TripPattern this edge leads to.
  - getName
```
public String getName()
```
    Description copied from class: Edge
    
    Gets english localized name
    
    Specified by:
    
    getName in class Edge
    
    Returns:
    
    english localized name
  - getName
```
public String getName(Locale locale)
```
    Description copied from class: Edge
    
    Gets wanted localization
    
    Specified by:
    
    getName in class Edge
    
    Parameters:
    
    locale - wanted locale
    
    Returns:
    
    Localized in specified locale name
  - optimisticTraverse
```
public State optimisticTraverse(State s0)
```
    Overrides:
    
    optimisticTraverse in class Edge
  - weightLowerBound
```
public double weightLowerBound(RoutingRequest options)
```
    Description copied from class: Edge
    
    Returns a lower bound on edge weight given the routing options.
    
    Overrides:
    
    weightLowerBound in class Edge
    
    Returns:
    
    edge weight as a double.
  - timeLowerBound
```
public double timeLowerBound(RoutingRequest options)
```
    Description copied from class: Edge
    
    Returns a lower bound on traversal time given the routing options.
    
    Overrides:
    
    timeLowerBound in class Edge
    
    Returns:
    
    edge weight as a double.
  - traverse
```
public State traverse(State state0)
```
    Description copied from class: Edge
    
    Traverse this edge.
    
    Specified by:
    
    traverse in class Edge
    
    Parameters:
    
    state0 - The State coming into the edge.
    
    Returns:
    
    The State upon exiting the edge.
  - getGeometry
```
public org.locationtech.jts.geom.LineString getGeometry()
```
    Overrides:
    
    getGeometry in class Edge
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Edge
  - getStopIndex
```
public int getStopIndex()
```
    Description copied from interface: OnboardEdge
    
    The stop index (within the trip) of the stop this edge comes from. This is equivalent to a hop index.
    
    Specified by:
    
    getStopIndex in interface OnboardEdge

Class PatternInterlineDwell

Nested Class Summary

Nested classes/interfaces inherited from class org.opentripplanner.routing.graph.Edge

Field Summary

Fields inherited from class org.opentripplanner.routing.graph.Edge

Constructor Summary

Method Summary

Methods inherited from class org.opentripplanner.routing.graph.Edge

Methods inherited from class java.lang.Object

Constructor Detail

PatternInterlineDwell

PatternInterlineDwell

Method Detail

add

getName

getName

optimisticTraverse

weightLowerBound

timeLowerBound

traverse

getGeometry

toString

getStopIndex