NetworkRoute.java

Go to the documentation of this file.

/* *********************************************************************** *
 * project: org.matsim.*
 * CarRoute.java
 *                                                                         *
 * *********************************************************************** *
 *                                                                         *
 * copyright       : (C) 2008 by the members listed in the COPYING,        *
 *                   LICENSE and WARRANTY file.                            *
 * email           : info at matsim dot org                                *
 *                                                                         *
 * *********************************************************************** *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *   See also COPYING, LICENSE and WARRANTY file                           *
 *                                                                         *
 * *********************************************************************** */

package org.matsim.core.population.routes;

import java.util.List;

import org.matsim.api.core.v01.Id;
import org.matsim.api.core.v01.network.Link;
import org.matsim.api.core.v01.population.Route;
import org.matsim.vehicles.Vehicle;


public interface NetworkRoute extends Route {

    public void setLinkIds(final Id<Link> startLinkId, final List<Id<Link>> linkIds, final Id<Link> endLinkId);

    public void setTravelCost(final double travelCost);

    public double getTravelCost();

    public List<Id<Link>> getLinkIds();

    public NetworkRoute getSubRoute(final Id<Link> fromLinkId, final Id<Link> toLinkId);
    // yyyy my intuition is that this should be removed from the API (and replaced by a static method in RouteUtils). kai, oct'17

    public abstract void setVehicleId(final Id<Vehicle> vehicleId);

    public abstract Id<Vehicle> getVehicleId();
    // Does it really make sense to couple the vehicle to the route?  I would have coupled it to the leg.  kai, aug'10
    // Well, I guess now it belongs to the route. :-)  kai, aug'10

    @Override
    public NetworkRoute clone();
    // to get the correct interface type.  kai, sep'17

}