Edge (OpenTripPlanner 1.3.0 API)

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

BikeParkEdge, ElevatorAlightEdge, ElevatorBoardEdge, ElevatorHopEdge, FreeEdge, IntersectionTransitLink, LegSwitchingEdge, OnBoardDepartPatternHop, ParkAndRideEdge, ParkAndRideLinkEdge, PathwayEdge, PatternInterlineDwell, RentABikeAbstractEdge, SampleEdge, SimpleTransfer, StationStopEdge, StreetBikeParkLink, StreetBikeRentalLink, StreetEdge, StreetTransitLink, TablePatternEdge, TimedTransferEdge, TransferEdge
```
public abstract class Edge
extends Object
implements Serializable
```
This is the standard implementation of an edge with fixed from and to Vertex instances; all standard OTP edges are subclasses of this.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Edge.ValidVertexTypes

Nested Classes
Modifier and Type	Class and Description
`static class`	`Edge.ValidVertexTypes`

Field Summary

Fields
Modifier and Type Field and Description

protected Vertex fromv

protected Vertex tov

Fields
Modifier and Type	Field and Description
`protected Vertex`	`fromv`
`protected Vertex`	`tov`

Constructor Summary

Constructors
Modifier Constructor and Description

protected Edge(Vertex v1, Vertex v2)

Constructors
Modifier	Constructor and Description
`protected`	`Edge(Vertex v1, Vertex v2)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`getAzimuth()` Returns the azimuth of this edge from head to tail.
`String`	`getDirection()` Get a direction on paths where it matters, or null
`double`	`getDistance()`
`Vertex`	`getFromVertex()`
`com.vividsolutions.jts.geom.LineString`	`getGeometry()`
`int`	`getId()`
`abstract String`	`getName()` Gets english localized name
`abstract String`	`getName(Locale locale)` Gets wanted localization
`Vertex`	`getToVertex()`
`org.onebusaway.gtfs.model.Trip`	`getTrip()` This should only be called inside State; other methods should call org.opentripplanner.routing.core.State.getBackTrip()
`Edge.ValidVertexTypes`	`getValidVertexTypes()`
`boolean`	`hasBogusName()`
`int`	`hashCode()`
`boolean`	`isEquivalentTo(Edge e)` Checks equivalency to another edge.
`boolean`	`isPartial()` Returns true if this edge is partial - overriden by subclasses.
`boolean`	`isReverseOf(Edge e)` Returns true if this edge is the reverse of another.
`boolean`	`isRoundabout()` Edges are not roundabouts by default.
`State`	`optimisticTraverse(State s0)`
`double`	`timeLowerBound(RoutingRequest options)` Returns a lower bound on traversal time given the routing options.
`String`	`toString()`
`abstract State`	`traverse(State s0)` Traverse this edge.
`boolean`	`vertexTypesValid()`
`double`	`weightLowerBound(RoutingRequest options)` Returns a lower bound on edge weight given the routing options.

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

- Field Detail
  - fromv
```
protected Vertex fromv
```
  - tov
```
protected Vertex tov
```
- Constructor Detail
  - Edge
```
protected Edge(Vertex v1,
               Vertex v2)
```
- Method Detail
  - getFromVertex
```
public Vertex getFromVertex()
```
  - getToVertex
```
public Vertex getToVertex()
```
  - isPartial
```
public boolean isPartial()
```
    Returns true if this edge is partial - overriden by subclasses.
  - isEquivalentTo
```
public boolean isEquivalentTo(Edge e)
```
    Checks equivalency to another edge. Default implementation is trivial equality, but subclasses may want to do something more tricky.
  - isReverseOf
```
public boolean isReverseOf(Edge e)
```
    Returns true if this edge is the reverse of another.
  - getDirection
```
public String getDirection()
```
    Get a direction on paths where it matters, or null
    
    Returns:
  - getTrip
```
public org.onebusaway.gtfs.model.Trip getTrip()
```
    This should only be called inside State; other methods should call org.opentripplanner.routing.core.State.getBackTrip()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - isRoundabout
```
public boolean isRoundabout()
```
    Edges are not roundabouts by default.
  - traverse
```
public abstract State traverse(State s0)
```
    Traverse this edge.
    
    Parameters:
    
    s0 - The State coming into the edge.
    
    Returns:
    
    The State upon exiting the edge.
  - optimisticTraverse
```
public State optimisticTraverse(State s0)
```
  - weightLowerBound
```
public double weightLowerBound(RoutingRequest options)
```
    Returns a lower bound on edge weight given the routing options.
    
    Parameters:
    
    options -
    
    Returns:
    
    edge weight as a double.
  - timeLowerBound
```
public double timeLowerBound(RoutingRequest options)
```
    Returns a lower bound on traversal time given the routing options.
    
    Parameters:
    
    options -
    
    Returns:
    
    edge weight as a double.
  - getName
```
public abstract String getName()
```
    Gets english localized name
    
    Returns:
    
    english localized name
  - getName
```
public abstract String getName(Locale locale)
```
    Gets wanted localization
    
    Parameters:
    
    locale - wanted locale
    
    Returns:
    
    Localized in specified locale name
  - hasBogusName
```
public boolean hasBogusName()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getGeometry
```
public com.vividsolutions.jts.geom.LineString getGeometry()
```
  - getAzimuth
```
public double getAzimuth()
```
    Returns the azimuth of this edge from head to tail.
    
    Returns:
  - getDistance
```
public double getDistance()
```
  - getValidVertexTypes
```
public Edge.ValidVertexTypes getValidVertexTypes()
```
  - vertexTypesValid
```
public final boolean vertexTypesValid()
```
  - getId
```
public int getId()
```

Class Edge

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

fromv

tov

Constructor Detail

Edge

Method Detail

getFromVertex

getToVertex

isPartial

isEquivalentTo

isReverseOf

getDirection

getTrip

hashCode

isRoundabout

traverse

optimisticTraverse

weightLowerBound

timeLowerBound

getName

getName

hasBogusName

toString

getGeometry

getAzimuth

getDistance

getValidVertexTypes

vertexTypesValid

getId