org.opentripplanner.routing.edgetype

Class StreetEdge

java.lang.Object

org.opentripplanner.routing.graph.Edge

org.opentripplanner.routing.edgetype.StreetEdge

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

StreetWithElevationEdge

public class StreetEdge
extends Edge
implements Cloneable

This represents a street segment.

Author:

novalis

See Also:

Serialized Form

Nested Class Summary

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

Edge.ValidVertexTypes

Field Summary

Fields

Modifier and Type	Field and Description
static int	ANY_PLATFORM_MASK
protected float	bicycleSafetyFactor bicycleSafetyWeight = length * bicycleSafetyFactor.
static int	CLASS_CROSSING
static int	CLASS_LINK
static int	CLASS_OTHER_PLATFORM
static int	CLASS_OTHERPATH
static int	CLASS_STREET
static int	CLASS_TRAIN_PLATFORM
static int	CROSSING_CLASS_MASK
static float	DEFAULT_CAR_SPEED
long	wayId The OSM way ID from whence this came - needed to reference traffic data

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

fromv, tov

Constructor Summary

Constructors

Constructor and Description
StreetEdge(StreetVertex v1, StreetVertex v2, com.vividsolutions.jts.geom.LineString geometry, I18NString name, double length, StreetTraversalPermission permission, boolean back)
StreetEdge(StreetVertex v1, StreetVertex v2, com.vividsolutions.jts.geom.LineString geometry, String name, double length, StreetTraversalPermission permission, boolean back)

Method Summary

Modifier and Type	Method and Description
protected void	calculateLengthFromGeometry() calculate the length of this street segement from its geometry
double	calculateSpeed(RoutingRequest options, TraverseMode traverseMode, long timeMillis) Calculate the speed appropriately given the RoutingRequest and traverseMode and the current wall clock time.
boolean	canTraverse(TraverseModeSet modes) Checks permissions of the street edge if specified modes are allowed to travel.
boolean	canTraverseIncludingBarrier(TraverseMode mode) This checks if start or end vertex is bollard If it is it creates intersection of street edge permissions and from/to barriers.
boolean	canTurnOnto(Edge e, State state, TraverseMode mode)
StreetEdge	clone()
float	getBicycleSafetyFactor()
float	getCarSpeed()
double	getDistance()
PackedCoordinateSequence	getElevationProfile()
long	getEndOsmNodeId() Get the ending OSM node ID of this edge.
com.vividsolutions.jts.geom.LineString	getGeometry()
int	getInAngle() Return the azimuth of the first segment in this edge in integer degrees clockwise from South.
float	getMaxSlope()
String	getName() Gets english localized name
String	getName(Locale locale) Gets wanted localization
int	getOutAngle() Return the azimuth of the last segment in this edge in integer degrees clockwise from South.
StreetTraversalPermission	getPermission()
I18NString	getRawName() Gets non-localized I18NString (Used when splitting edges)
double	getSlopeSpeedEffectiveLength()
double	getSlopeWorkCostEffectiveLength()
long	getStartOsmNodeId() Get the starting OSM node ID of this edge.
int	getStreetClass()
protected List<TurnRestriction>	getTurnRestrictions(Graph graph)
boolean	hasBogusName()
boolean	isBack() Marks that this edge is the reverse of the one defined in the source data.
boolean	isElevationFlattened()
boolean	isNoThruTraffic()
boolean	isRoundabout() Edges are not roundabouts by default.
boolean	isSlopeOverride()
boolean	isStairs() This street is a staircase
boolean	isWheelchairAccessible()
void	setBack(boolean back)
void	setBicycleSafetyFactor(float bicycleSafetyFactor)
void	setCarSpeed(float carSpeed)
void	setHasBogusName(boolean hasBogusName)
void	setName(I18NString name)
void	setNoThruTraffic(boolean noThruTraffic)
void	setPermission(StreetTraversalPermission permission)
void	setRoundabout(boolean roundabout)
void	setSlopeOverride(boolean slopeOverride)
void	setStairs(boolean stairs)
void	setStreetClass(int streetClass)
void	setWheelchairAccessible(boolean wheelchairAccessible)
void	shareData(StreetEdge reversedEdge)
P2<StreetEdge>	split(SplitterVertex v, boolean destructive) Split this street edge and return the resulting street edges
double	timeLowerBound(RoutingRequest options) Returns a lower bound on traversal time given the routing options.
String	toString()
State	traverse(State s0) 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, getFromVertex, getId, getToVertex, getTrip, getValidVertexTypes, hashCode, isEquivalentTo, isPartial, isReverseOf, optimisticTraverse, vertexTypesValid

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_STREET

public static final int CLASS_STREET

See Also:

Constant Field Values

CLASS_CROSSING

public static final int CLASS_CROSSING

See Also:

Constant Field Values

CLASS_OTHERPATH

public static final int CLASS_OTHERPATH

See Also:

Constant Field Values

CLASS_OTHER_PLATFORM

public static final int CLASS_OTHER_PLATFORM

See Also:

Constant Field Values

CLASS_TRAIN_PLATFORM

public static final int CLASS_TRAIN_PLATFORM

See Also:

Constant Field Values

ANY_PLATFORM_MASK

public static final int ANY_PLATFORM_MASK

See Also:

Constant Field Values

CROSSING_CLASS_MASK

public static final int CROSSING_CLASS_MASK

See Also:

Constant Field Values

CLASS_LINK

public static final int CLASS_LINK

See Also:

Constant Field Values

DEFAULT_CAR_SPEED

public static final float DEFAULT_CAR_SPEED

See Also:

Constant Field Values

bicycleSafetyFactor

protected float bicycleSafetyFactor

bicycleSafetyWeight = length * bicycleSafetyFactor. For example, a 100m street with a safety factor of 2.0 will be considered in term of safety cost as the same as a 150m street with a safety factor of 1.0.

wayId

public long wayId

The OSM way ID from whence this came - needed to reference traffic data

Constructor Detail

StreetEdge

public StreetEdge(StreetVertex v1,
                  StreetVertex v2,
                  com.vividsolutions.jts.geom.LineString geometry,
                  I18NString name,
                  double length,
                  StreetTraversalPermission permission,
                  boolean back)

StreetEdge

public StreetEdge(StreetVertex v1,
                  StreetVertex v2,
                  com.vividsolutions.jts.geom.LineString geometry,
                  String name,
                  double length,
                  StreetTraversalPermission permission,
                  boolean back)

Method Detail

canTraverse

public boolean canTraverse(TraverseModeSet modes)

Checks permissions of the street edge if specified modes are allowed to travel. Barriers aren't taken into account. So it can happen that canTraverse returns True. But doTraverse returns false. Since there are barriers on a street. This is because this function is used also on street when searching for start/stop. Those streets are then split. On splitted streets can be possible to drive with a CAR because it is only blocked from one way.

Parameters:

modes -

Returns:

canTraverseIncludingBarrier

public boolean canTraverseIncludingBarrier(TraverseMode mode)

This checks if start or end vertex is bollard If it is it creates intersection of street edge permissions and from/to barriers. Then it checks if mode is allowed to traverse the edge. By default CAR isn't allowed to traverse barrier but foot and bicycle are. This can be changed with different tags If start/end isn't bollard it just checks the street permissions. It is used in canTraverse(RoutingRequest, TraverseMode)

Parameters:

mode -

Returns:

getElevationProfile

public PackedCoordinateSequence getElevationProfile()

isElevationFlattened

public boolean isElevationFlattened()

getMaxSlope

public float getMaxSlope()

getDistance

public double getDistance()

Overrides:

getDistance in class Edge

traverse

public State traverse(State s0)

Description copied from class: Edge

Traverse this edge.

Specified by:

traverse in class Edge

Parameters:

s0 - The State coming into the edge.

Returns:

The State upon exiting the edge.

calculateSpeed

public double calculateSpeed(RoutingRequest options,
                             TraverseMode traverseMode,
                             long timeMillis)

Calculate the speed appropriately given the RoutingRequest and traverseMode and the current wall clock time. Note: this is not strictly symmetrical, because in a forward search we get the speed based on the time we enter this edge, whereas in a reverse search we get the speed based on the time we exit the 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.

getSlopeSpeedEffectiveLength

public double getSlopeSpeedEffectiveLength()

getSlopeWorkCostEffectiveLength

public double getSlopeWorkCostEffectiveLength()

setBicycleSafetyFactor

public void setBicycleSafetyFactor(float bicycleSafetyFactor)

getBicycleSafetyFactor

public float getBicycleSafetyFactor()

toString

public String toString()

Overrides:

toString in class Edge

clone

public StreetEdge clone()

Overrides:

clone in class Object

canTurnOnto

public boolean canTurnOnto(Edge e,
                           State state,
                           TraverseMode mode)

getName

public String getName()

Description copied from class: Edge

Gets english localized name

Specified by:

getName in class Edge

Returns:

english localized name

getRawName

public I18NString getRawName()

Gets non-localized I18NString (Used when splitting edges)

Returns:

non-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

setName

public void setName(I18NString name)

getGeometry

public com.vividsolutions.jts.geom.LineString getGeometry()

Overrides:

getGeometry in class Edge

shareData

public void shareData(StreetEdge reversedEdge)

isWheelchairAccessible

public boolean isWheelchairAccessible()

setWheelchairAccessible

public void setWheelchairAccessible(boolean wheelchairAccessible)

getPermission

public StreetTraversalPermission getPermission()

setPermission

public void setPermission(StreetTraversalPermission permission)

getStreetClass

public int getStreetClass()

setStreetClass

public void setStreetClass(int streetClass)

isBack

public boolean isBack()

Marks that this edge is the reverse of the one defined in the source data. Does NOT mean fromv/tov are reversed.

setBack

public void setBack(boolean back)

isRoundabout

public boolean isRoundabout()

Description copied from class: Edge

Edges are not roundabouts by default.

Overrides:

isRoundabout in class Edge

setRoundabout

public void setRoundabout(boolean roundabout)

hasBogusName

public boolean hasBogusName()

Overrides:

hasBogusName in class Edge

setHasBogusName

public void setHasBogusName(boolean hasBogusName)

isNoThruTraffic

public boolean isNoThruTraffic()

setNoThruTraffic

public void setNoThruTraffic(boolean noThruTraffic)

isStairs

public boolean isStairs()

This street is a staircase

setStairs

public void setStairs(boolean stairs)

getCarSpeed

public float getCarSpeed()

setCarSpeed

public void setCarSpeed(float carSpeed)

isSlopeOverride

public boolean isSlopeOverride()

setSlopeOverride

public void setSlopeOverride(boolean slopeOverride)

getInAngle

public int getInAngle()

Return the azimuth of the first segment in this edge in integer degrees clockwise from South. TODO change everything to clockwise from North

getOutAngle

public int getOutAngle()

Return the azimuth of the last segment in this edge in integer degrees clockwise from South.

getTurnRestrictions

protected List<TurnRestriction> getTurnRestrictions(Graph graph)

calculateLengthFromGeometry

protected void calculateLengthFromGeometry()

calculate the length of this street segement from its geometry

split

public P2<StreetEdge> split(SplitterVertex v,
                            boolean destructive)

Split this street edge and return the resulting street edges

getStartOsmNodeId

public long getStartOsmNodeId()

Get the starting OSM node ID of this edge. Note that this information is preserved when an edge is split, so both edges will have the same starting and ending nodes.

getEndOsmNodeId

public long getEndOsmNodeId()

Get the ending OSM node ID of this edge. Note that this information is preserved when an edge is split, so both edges will have the same starting and ending nodes.