org.opentripplanner.routing.spt

Class GraphPath

java.lang.Object

org.opentripplanner.routing.spt.GraphPath

public class GraphPath
extends Object

A shortest path on the graph.

Field Summary

Fields

Modifier and Type	Field and Description
LinkedList<Edge>	edges
LinkedList<State>	states

Constructor Summary

Constructors

Constructor and Description
GraphPath(State s, boolean optimize) Construct a GraphPath based on the given state by following back-edge fields all the way back to the origin of the search.

Method Summary

Modifier and Type	Method and Description
void	dump() Private Methods
void	dumpPathParser()
boolean	equals(Object o) Two paths are equal if they use the same ordered list of trips
int	getCallAndRideDuration() Return the total duration, in seconds, of call-and-ride legs used in a trip plan.
List<FeedScopedId>	getCallAndRideTrips() Get all trips used in the search which were call-and-ride trips.
int	getDuration() Returns the duration of the trip in seconds.
long	getEndTime() Returns the end time of the trip in seconds since the epoch.
Vertex	getEndVertex()
org.locationtech.jts.geom.LineString	getGeometry()
RoutingContext	getRoutingContext()
long	getStartTime() Returns the start time of the trip in seconds since the epoch.
Vertex	getStartVertex()
List<FeedScopedId>	getTrips()
double	getWalkDistance()
double	getWeight()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

states

public LinkedList<State> states

edges

public LinkedList<Edge> edges

Constructor Detail

GraphPath

public GraphPath(State s,
                 boolean optimize)

Construct a GraphPath based on the given state by following back-edge fields all the way back to the origin of the search. This constructs a proper Java list of states (allowing random access etc.) from the predecessor information left in states by the search algorithm. Optionally re-traverses all edges backward in order to remove excess waiting time from the final itinerary presented to the user. When planning with departure time, the edges will then be re-traversed once more in order to move the waiting time forward in time, towards the end.

Parameters:

s - - the state for which a path is requested

optimize - - whether excess waiting time should be removed

options - - the traverse options used to reach this state

Method Detail

getStartTime

public long getStartTime()

Returns the start time of the trip in seconds since the epoch.

Returns:

getEndTime

public long getEndTime()

Returns the end time of the trip in seconds since the epoch.

Returns:

getDuration

public int getDuration()

Returns the duration of the trip in seconds.

Returns:

getWeight

public double getWeight()

getStartVertex

public Vertex getStartVertex()

getEndVertex

public Vertex getEndVertex()

getTrips

public List<FeedScopedId> getTrips()

Returns:

A list containing one trip_id for each vehicle boarded in this path, in the chronological order they are boarded.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Two paths are equal if they use the same ordered list of trips

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

dump

public void dump()

Private Methods

dumpPathParser

public void dumpPathParser()

getWalkDistance

public double getWalkDistance()

getRoutingContext

public RoutingContext getRoutingContext()

getGeometry

public org.locationtech.jts.geom.LineString getGeometry()

getCallAndRideDuration

public int getCallAndRideDuration()

Return the total duration, in seconds, of call-and-ride legs used in a trip plan. If no call-and-ride legs are used, the duration is 0.

getCallAndRideTrips

public List<FeedScopedId> getCallAndRideTrips()

Get all trips used in the search which were call-and-ride trips. Call-and-ride is part of GTFS-Flex and must be explicitly turned on in the graph.