RaptorState.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.impl.raptor;

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

import org.onebusaway.gtfs.model.AgencyAndId;
import org.onebusaway.gtfs.model.Route;
import org.onebusaway.gtfs.model.Trip;
import org.opentripplanner.routing.core.RoutingRequest;
import org.opentripplanner.routing.core.ServiceDay;
import org.opentripplanner.routing.core.State;
import org.opentripplanner.routing.trippattern.TripTimes;

/* RaptorStates are always at some transit stop;
 * they either got there via a walk, in which case walkPath != null, or
 * via a transit hop, in which case boardStop etc have been set.
*/

public class RaptorState implements Comparable<RaptorState>, Cloneable {
    /* dominance characteristics */
    double walkDistance;
    int nBoardings;
    int arrivalTime;

    /* if this state has just boarded transit, this is the boarding location */
    RaptorStop boardStop;
    int boardStopSequence = -1; //this is the index in this route
    RaptorRoute route;
    public int patternIndex = -1; 
    public TripTimes tripTimes = null;

    boolean rentingBike;

    public AgencyAndId tripId;

    /* if has walked to transit,  */
    State walkPath;
    
    /* path info */
    private RaptorState parent;
    public ServiceDay serviceDay;
    public RaptorStop stop;
    private boolean arriveBy;

    public double weight;
    public int initialWaitTime;

    public boolean interlining = false;
    private RoutingRequest request;

    public RaptorState(RoutingRequest request) {
        this.request = request;
        arriveBy = request.arriveBy;
    }
    
    public RaptorState(RaptorState parent) {
        this.parent = parent;
        this.arriveBy = parent.arriveBy;
        this.weight = parent.weight;
        this.initialWaitTime = parent.initialWaitTime;
        this.rentingBike = parent.rentingBike;
    }

    public String toString() {
        if (stop == null) {
            String routes = "";
            RaptorState cur = this;
            while (cur != null) {
                if (cur.route != null) {
                    routes += cur.route + ", ";
                }
                cur = cur.parent;
            }
            return "(" + routes + ") at " + new Date(((long) arrivalTime) * 1000);
        } else {
            return "at " + stop + " boarded at " + boardStop + " on " + route + " time "
                + new Date(((long) arrivalTime) * 1000) + " walkDistance " + walkDistance;
        }
    }

    public void dump () {
        RaptorState state = this;
        while (state != null) {
            String routeStr = "()";
            if (state.route != null) {
                Trip gtfsTrip = state.route.boards[0][0].getPattern().getExemplar();
                Route gtfsRoute = gtfsTrip.getRoute();
                routeStr = gtfsTrip.getTripHeadsign();
                if (routeStr == null) {
                    routeStr = gtfsRoute.getId().getId();
                } else {
                    routeStr = gtfsRoute.getId().getId() + " " + routeStr;
                }
            }
            System.out.println("At stop " + state.stop.stopVertex.getName() + "(" + state.stop
                    + ") on " + routeStr + " at time "
                    + new Date(((long) state.arrivalTime) * 1000));
            state = state.parent;
        }
    }

    public boolean eDominates(RaptorState other) {
        if (rentingBike != other.rentingBike)
            return false;
        if (arriveBy) {
            return nBoardings <= other.nBoardings
                    && walkDistance <= other.walkDistance * Raptor.WALK_EPSILON
                    && arrivalTime >= other.arrivalTime;
        } else {
            return nBoardings <= other.nBoardings
                    && walkDistance <= other.walkDistance * Raptor.WALK_EPSILON
                    && arrivalTime <= other.arrivalTime;
            }
    }

    @Override
    public int compareTo(RaptorState other) {
        return (int) Math.signum(weight - other.weight);
    }

    public RaptorState getParent() {
        return parent;
    }

    public RaptorRoute getRoute() {
        return route;
    }

    public void setRoute(RaptorRoute route) {
        this.route = route;
    }

    public RaptorState clone() {
        try {
            return (RaptorState) super.clone();
        } catch (CloneNotSupportedException e) {
            throw new RuntimeException(e);
        }
    }

    public List<AgencyAndId> getTrips() {
        ArrayList<AgencyAndId> out = new ArrayList<AgencyAndId>();
        RaptorState cur = this;
        while (cur != null) {
            if (cur.tripId != null)
                out.add(cur.tripId);
            cur = cur.parent;
        }
        return out;
    }

    public RoutingRequest getRequest() {
        if (request == null) {
            return parent.getRequest();
        }
        return request;
    }
}