org.opentripplanner.routing.graphfinder.StopAtDistance Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of otp Show documentation
The OpenTripPlanner multimodal journey planning system
There is a newer version: 2.5.0
package org.opentripplanner.routing.graphfinder;

import org.locationtech.jts.geom.Coordinate;
import org.locationtech.jts.geom.GeometryFactory;
import org.locationtech.jts.geom.LineString;
import org.opentripplanner.api.resource.CoordinateArrayListSequence;
import org.opentripplanner.common.geometry.GeometryUtils;
import org.opentripplanner.common.geometry.PackedCoordinateSequence;
import org.opentripplanner.model.Stop;
import org.opentripplanner.model.StopLocation;
import org.opentripplanner.routing.core.State;
import org.opentripplanner.routing.edgetype.PathwayEdge;
import org.opentripplanner.routing.edgetype.StreetEdge;
import org.opentripplanner.routing.graph.Edge;
import org.opentripplanner.routing.spt.GraphPath;
import org.opentripplanner.routing.vertextype.TransitStopVertex;

import java.util.ArrayList;
import java.util.List;

/**
 * A specific stop at a distance. Also includes a geometry and potentially a list of edges and a
 * state of how to reach the stop from the search origin
 */
public class StopAtDistance implements Comparable {

  private static GeometryFactory geometryFactory = GeometryUtils.getGeometryFactory();

  public final StopLocation stop;
  public final double distance;

  public final List edges;
  public final LineString geometry;
  public final State state;

  public StopAtDistance(
      StopLocation stop, double distance, List edges, LineString geometry, State state
  ) {
    this.stop = stop;
    this.distance = distance;
    this.edges = edges;
    this.geometry = geometry;
    this.state = state;
  }

  public StopAtDistance(
      TransitStopVertex stopVertex, double distance, List edges, LineString geometry,
      State state
  ) {
    this(stopVertex.getStop(), distance, edges, geometry, state);
  }

  @Override
  public int compareTo(StopAtDistance that) {
    return (int) (this.distance) - (int) (that.distance);
  }

  public String toString() {
    return String.format("stop %s at %.1f meters", stop, distance);
  }

  /**
   * Given a State at a StopVertex, bundle the StopVertex together with information about how far
   * away it is and the geometry of the path leading up to the given State.
   */
  public static StopAtDistance stopAtDistanceForState(State state, StopLocation stop) {
    double effectiveWalkDistance = 0.0;
    GraphPath graphPath = new GraphPath(state, false);
    CoordinateArrayListSequence coordinates = new CoordinateArrayListSequence();
    List edges = new ArrayList<>();
    for (Edge edge : graphPath.edges) {
      if (edge instanceof StreetEdge) {
        LineString geometry = edge.getGeometry();
        if (geometry != null) {
          if (coordinates.size() == 0) {
            coordinates.extend(geometry.getCoordinates());
          }
          else {
            coordinates.extend(geometry.getCoordinates(), 1);
          }
        }
        effectiveWalkDistance += edge.getEffectiveWalkDistance();
      }
      else if (edge instanceof PathwayEdge) {
        effectiveWalkDistance += edge.getDistanceMeters();
      }
      edges.add(edge);
    }
    if (coordinates.size() < 2) {   // Otherwise the walk step generator breaks.
      ArrayList coordinateList = new ArrayList(2);
      coordinateList.add(graphPath.states.get(1).getVertex().getCoordinate());
      State lastState = graphPath.states.getLast().getBackState();
      coordinateList.add(lastState.getVertex().getCoordinate());
      coordinates = new CoordinateArrayListSequence(coordinateList);
    }
    return new StopAtDistance(
        stop,
        effectiveWalkDistance,
        edges,
        geometryFactory.createLineString(new PackedCoordinateSequence.Double(coordinates.toCoordinateArray())),
        state
    );
  }
}