org.opentripplanner.routing.edgetype

Class SemiPermanentPartialStreetEdge

java.lang.Object

org.opentripplanner.routing.graph.Edge

org.opentripplanner.routing.edgetype.StreetEdge

org.opentripplanner.routing.edgetype.StreetWithElevationEdge

org.opentripplanner.routing.edgetype.PartialStreetEdge

org.opentripplanner.routing.edgetype.SemiPermanentPartialStreetEdge

All Implemented Interfaces:

Serializable, Cloneable

public class SemiPermanentPartialStreetEdge
extends PartialStreetEdge

This class is used to model a SemiPermanent StreetEdge that was non-destructively split from another StreetEdge. These StreetEdges are typically used to model access to things such as bike rental stations that are dynamically created from bike rental updaters and could be subsequently removed from the feed. These edges aid in providing access only when needed to the desired bike rental stations and also allow for the isolated removal of these edges when they are no longer needed. See https://github.com/opentripplanner/OpenTripPlanner/issues/2787 and associated comments for more details on what inspired the creation of this class.

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.edgetype.PartialStreetEdge

parentEdge

Fields inherited from class org.opentripplanner.routing.edgetype.StreetEdge

ANY_PLATFORM_MASK, bicycleSafetyFactor, CLASS_CROSSING, CLASS_LINK, CLASS_OTHER_PLATFORM, CLASS_OTHERPATH, CLASS_STREET, CLASS_TRAIN_PLATFORM, CROSSING_CLASS_MASK, DEFAULT_CAR_SPEED, walkComfortScore, wayId

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

fromv, tov

Constructor Summary

Constructors

Constructor and Description
SemiPermanentPartialStreetEdge(StreetEdge streetEdge, StreetVertex v1, StreetVertex v2, org.locationtech.jts.geom.LineString geometry, I18NString name)

Method Summary

Modifier and Type	Method and Description
void	setBikeRentalOptionRequired() Marks the edge as only traversable if a request is made that allows bike rentals
void	setCarRentalOptionRequired() Marks the edge as only traversable if a request is made that allows car rentals
void	setVehicleRentalOptionRequired() Marks the edge as only traversable if a request is made that allows vehicle rentals
P2<StreetEdge>	split(SplitterVertex splitterVertex, boolean destructive, boolean createSemiPermanentEdges) Make sure that the only way to split a SemiPermanentPartialStreetEdge is with a TemporarySplitterVertex.
String	toString()
State	traverse(State s0) There can often times be requests that do not need to traverse this edge, such as requests that don't want to use a bike rental.

Methods inherited from class org.opentripplanner.routing.edgetype.PartialStreetEdge

getId, getInAngle, getOutAngle, getParentEdge, getTurnRestrictions, isEquivalentTo, isPartial, isReverseOf, isRoundabout, isTrivial

Methods inherited from class org.opentripplanner.routing.edgetype.StreetWithElevationEdge

calculateSpeed, clone, getElevationProfile, getMaxSlope, getSlopeSpeedEffectiveLength, getSlopeWalkSpeedEffectiveLength, getSlopeWorkCostEffectiveLength, hasPackedElevationProfile, isElevationFlattened, setElevationProfile

Methods inherited from class org.opentripplanner.routing.edgetype.StreetEdge

addCarNetwork, addVehicleNetwork, calculateLengthFromGeometry, calculateMicromobilitySpeed, canTraverse, canTraverseIncludingBarrier, canTurnOnto, containsCarNetwork, containsVehicleNetwork, getBicycleSafetyFactor, getCarNetworks, getCarSpeed, getDistance, getEndOsmNodeId, getFloatingCarDropoffSuitability, getFloatingVehicleDropoffSuitability, getGeometry, getName, getName, getOsmTags, getPermission, getRawName, getRollingResistanceCoefficient, getStartOsmNodeId, getStreetClass, getTNCStopSuitability, getVehicleNetworks, getWalkComfortScore, hasBogusName, isBack, isNoThruTraffic, isSlopeOverride, isStairs, isWheelchairAccessible, setBack, setBicycleSafetyFactor, setCarNetworks, setCarSpeed, setFloatingCarDropoffSuitability, setFloatingVehicleDropoffSuitability, setHasBogusName, setName, setNoThruTraffic, setOsmTags, setPermission, setRoundabout, setSlopeOverride, setStairs, setStreetClass, setTNCStopSuitability, setVehicleNetworks, setWalkComfortScore, setWheelchairAccessible, shareData, timeLowerBound, weightLowerBound

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

getAzimuth, getDirection, getDisplayGeometry, getFromVertex, getToVertex, getTrip, getValidVertexTypes, hashCode, optimisticTraverse, vertexTypesValid

Methods inherited from class java.lang.Object

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

Constructor Detail

SemiPermanentPartialStreetEdge

public SemiPermanentPartialStreetEdge(StreetEdge streetEdge,
                                      StreetVertex v1,
                                      StreetVertex v2,
                                      org.locationtech.jts.geom.LineString geometry,
                                      I18NString name)

Method Detail

traverse

public State traverse(State s0)

There can often times be requests that do not need to traverse this edge, such as requests that don't want to use a bike rental. In those cases, return null to avoid exploring this edge and any connected vertices further.

Overrides:

traverse in class StreetEdge

Parameters:

s0 - The State coming into the edge.

Returns:

The State upon exiting the edge.

toString

public String toString()

Overrides:

toString in class PartialStreetEdge

setBikeRentalOptionRequired

public void setBikeRentalOptionRequired()

Marks the edge as only traversable if a request is made that allows bike rentals

setCarRentalOptionRequired

public void setCarRentalOptionRequired()

Marks the edge as only traversable if a request is made that allows car rentals

setVehicleRentalOptionRequired

public void setVehicleRentalOptionRequired()

Marks the edge as only traversable if a request is made that allows vehicle rentals

split

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

Make sure that the only way to split a SemiPermanentPartialStreetEdge is with a TemporarySplitterVertex. The whole point of SemiPermanentPartialStreetEdges is that they are only split once from a regular StreetEdge in order to isolate access to a particular vertex that can be accessed from a StreetEdge such as a bike rental.

Overrides:

split in class StreetEdge

Parameters:

splitterVertex - The new vertex that the newly split edge(s) will become connected to.

destructive - Whether or not the split should be permanent and result in the old edge no longer existing within the graph.

createSemiPermanentEdges - Whether or not the split should result in the creation of semi-permanent edges or temporary edges.