org.opentripplanner.routing.edgetype

Class OnBoardDepartPatternHop

java.lang.Object

org.opentripplanner.routing.graph.Edge

org.opentripplanner.routing.edgetype.OnBoardDepartPatternHop

All Implemented Interfaces:

Serializable, OnboardEdge, TemporaryEdge

public class OnBoardDepartPatternHop
extends Edge
implements OnboardEdge, TemporaryEdge

A transit vehicle's journey (temporary vertex) between departure while onboard a trip and arrival at the next. This version represents a set of such journeys specified by a TripPattern.

Author:

laurent

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
OnBoardDepartPatternHop(OnboardDepartVertex from, PatternStopVertex to, TripTimes tripTimes, ServiceDay serviceDay, int stopIndex, double positionInHop)

Method Summary

Modifier and Type	Method and Description
void	dispose()
String	getDirection() Get a direction on paths where it matters, or null
double	getDistance()
com.vividsolutions.jts.geom.LineString	getGeometry()
TraverseMode	getMode()
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.
org.onebusaway.gtfs.model.Trip	getTrip() This should only be called inside State; other methods should call org.opentripplanner.routing.core.State.getBackTrip()
State	optimisticTraverse(State state0)
void	setGeometry(com.vividsolutions.jts.geom.LineString geometry)
String	toString()
State	traverse(State state0) Traverse this edge.

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

getAzimuth, getFromVertex, getId, getToVertex, getValidVertexTypes, hasBogusName, hashCode, isEquivalentTo, isPartial, isReverseOf, isRoundabout, timeLowerBound, vertexTypesValid, weightLowerBound

Methods inherited from class java.lang.Object

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

Constructor Detail

OnBoardDepartPatternHop

public OnBoardDepartPatternHop(OnboardDepartVertex from,
                               PatternStopVertex to,
                               TripTimes tripTimes,
                               ServiceDay serviceDay,
                               int stopIndex,
                               double positionInHop)

Parameters:

from - Originating vertex.

to - Destination vertex: a PatternStopVertex for the next stop of the current hop.

tripTimes - Resolved trip times for the trip with updated real-time info if available.

serviceDay - Service day on which trip is running.

stopIndex - Index of the current stop.

positionInHop - Between 0 to 1, an estimation of the covered distance in this hop so far.

Method Detail

getDistance

public double getDistance()

Overrides:

getDistance in class Edge

getMode

public TraverseMode getMode()

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 state0)

Overrides:

optimisticTraverse in class Edge

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.

setGeometry

public void setGeometry(com.vividsolutions.jts.geom.LineString geometry)

getGeometry

public com.vividsolutions.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

getTrip

public org.onebusaway.gtfs.model.Trip getTrip()

Description copied from class: Edge

This should only be called inside State; other methods should call org.opentripplanner.routing.core.State.getBackTrip()

Overrides:

getTrip in class Edge

getDirection

public String getDirection()

Description copied from class: Edge

Get a direction on paths where it matters, or null

Overrides:

getDirection in class Edge

Returns:

dispose

public void dispose()

Specified by:

dispose in interface TemporaryEdge