FrequencyHop.java

/* This program is free software: you can redistribute it and/or
 modify it under the terms of the GNU Lesser General Public License
 as published by the Free Software Foundation, either version 3 of
 the License, or (at your option) any later version.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>. */

package org.opentripplanner.routing.edgetype;

import org.onebusaway.gtfs.model.Stop;
import org.onebusaway.gtfs.model.Trip;
import org.opentripplanner.common.geometry.SphericalDistanceLibrary;
import org.opentripplanner.common.geometry.GeometryUtils;
import org.opentripplanner.gtfs.GtfsLibrary;
import org.opentripplanner.routing.core.RoutingRequest;
import org.opentripplanner.routing.core.State;
import org.opentripplanner.routing.core.StateEditor;
import org.opentripplanner.routing.core.TraverseMode;
import org.opentripplanner.routing.graph.Edge;
import org.opentripplanner.routing.vertextype.TransitVertex;

import com.vividsolutions.jts.geom.Coordinate;
import com.vividsolutions.jts.geom.LineString;

public class FrequencyHop extends Edge implements OnBoardForwardEdge, OnBoardReverseEdge, HopEdge {

    private static final long serialVersionUID = 2389378459266920841L;

    private FrequencyBasedTripPattern pattern;
    private Stop start;
    private Stop end;
    private int stopIndex;
    private LineString geometry;

    public FrequencyHop(TransitVertex depart, TransitVertex arrive, Stop s0, Stop s1,
            int stopIndex, FrequencyBasedTripPattern pattern) {
        super(depart, arrive);
        this.pattern = pattern;
        this.start = s0;
        this.end = s1;
        this.stopIndex = stopIndex;
    }

    public double getDistance() {
        //it's ok that this is slow because it's not used in
        //a tight loop
        return SphericalDistanceLibrary.getInstance().distance(start.getLat(), start.getLon(), end.getLat(),
                end.getLon());
    }

    public TraverseMode getMode() {
        return GtfsLibrary.getTraverseMode(pattern.getTrip().getRoute());
    }

    public String getName() {
        return GtfsLibrary.getRouteName(pattern.getTrip().getRoute());
    }

    @Override
    public Trip getTrip() {
        return pattern.getTrip();
    }

    public String getDirection () {
        return pattern.getHeadsign(stopIndex);
    }
    
    public State optimisticTraverse(State state0) {
        int runningTime = pattern.getRunningTime(stopIndex);
        StateEditor s1 = state0.edit(this);
        s1.setBackMode(getMode());
        s1.incrementTimeInSeconds(runningTime);
        s1.incrementWeight(runningTime);
        return s1.makeState();
    }

    @Override
    public double timeLowerBound(RoutingRequest options) {
        return pattern.getRunningTime(stopIndex);
    }
    
    @Override
    public double weightLowerBound(RoutingRequest options) {
        return timeLowerBound(options);
    }
    
    public State traverse(State s0) {
        int runningTime = pattern.getRunningTime(stopIndex);
        // TODO: Stop headsigns
        StateEditor s1 = s0.edit(this);
        s1.incrementTimeInSeconds(runningTime);
        if (s0.getOptions().isArriveBy())
            s1.setZone(getStartStop().getZoneId());
        else
            s1.setZone(getEndStop().getZoneId());
        s1.setRoute(pattern.getTrip().getRoute().getId());
        s1.setBackMode(getMode());
        s1.incrementWeight(runningTime);
        return s1.makeState();
    }

    public void setGeometry(LineString geometry) {
        this.geometry = geometry;
    }

    public LineString getGeometry() {
        if (geometry == null) {

            Coordinate c1 = new Coordinate(start.getLon(), start.getLat());
            Coordinate c2 = new Coordinate(end.getLon(), end.getLat());

            geometry = GeometryUtils.getGeometryFactory().createLineString(new Coordinate[] { c1, c2 });
        }
        return geometry;
    }

    @Override
    public Stop getEndStop() {
        return end;
    }

    @Override
    public Stop getStartStop() {
        return start;
    }

    public String toString() {
        return "PatternHop(" + getFromVertex() + ", " + getToVertex() + ")";
    }

    @Override
    public int getStopIndex() {
        return stopIndex;
    }

}