add OneTruckExample

contribs/dvrp/src/main/java/org/matsim/contrib/dvrp/examples/onetruck/OneTruckActionCreator.java

@@ -0,0 +1,59 @@
+/* *********************************************************************** *
+ * project: org.matsim.*
+ *                                                                         *
+ * *********************************************************************** *
+ *                                                                         *
+ * copyright       : (C) 2012 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.contrib.dvrp.examples.onetruck;
+
+import org.matsim.contrib.dvrp.data.Vehicle;
+import org.matsim.contrib.dvrp.schedule.DriveTask;
+import org.matsim.contrib.dvrp.schedule.StayTask;
+import org.matsim.contrib.dvrp.schedule.Task;
+import org.matsim.contrib.dvrp.vrpagent.VrpActivity;
+import org.matsim.contrib.dvrp.vrpagent.VrpAgentLogic;
+import org.matsim.contrib.dvrp.vrpagent.VrpLegs;
+import org.matsim.contrib.dynagent.DynAction;
+import org.matsim.contrib.dynagent.DynAgent;
+import org.matsim.contrib.dynagent.StaticDynActivity;
+import org.matsim.core.mobsim.framework.MobsimTimer;
+import org.matsim.core.mobsim.qsim.QSim;
+
+import com.google.inject.Inject;
+
+/**
+ * @author michalm
+ */
+final class OneTruckActionCreator implements VrpAgentLogic.DynActionCreator {
+	private final MobsimTimer timer;
+
+	@Inject
+	public OneTruckActionCreator(QSim qSim) {
+		this.timer = qSim.getSimTimer();
+	}
+
+	@Override
+	public DynAction createAction(DynAgent dynAgent, Vehicle vehicle, double now) {
+		Task task = vehicle.getSchedule().getCurrentTask();
+		if (task instanceof DriveTask) {
+			return VrpLegs.createLegWithOfflineTracker(vehicle, timer);
+		} else if (task instanceof OneTruckServeTask) { // PICKUP or DROPOFF
+			return new StaticDynActivity(((OneTruckServeTask)task).isPickup() ? "pickup" : "dropoff", task.getEndTime());
+		} else { // WAIT
+			return new VrpActivity("OneTaxiStay", (StayTask)task);
+		}
+	}
+}

contribs/dvrp/src/main/java/org/matsim/contrib/dvrp/examples/onetruck/OneTruckOptimizer.java

@@ -0,0 +1,170 @@
+/* *********************************************************************** *
+ * project: org.matsim.*
+ *                                                                         *
+ * *********************************************************************** *
+ *                                                                         *
+ * copyright       : (C) 2013 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.contrib.dvrp.examples.onetruck;
+
+import java.util.List;
+
+import org.matsim.api.core.v01.network.Link;
+import org.matsim.api.core.v01.network.Network;
+import org.matsim.contrib.dvrp.data.Fleet;
+import org.matsim.contrib.dvrp.data.Request;
+import org.matsim.contrib.dvrp.data.Vehicle;
+import org.matsim.contrib.dvrp.optimizer.VrpOptimizer;
+import org.matsim.contrib.dvrp.path.VrpPathWithTravelData;
+import org.matsim.contrib.dvrp.path.VrpPaths;
+import org.matsim.contrib.dvrp.router.DvrpRoutingNetworkProvider;
+import org.matsim.contrib.dvrp.router.TimeAsTravelDisutility;
+import org.matsim.contrib.dvrp.schedule.DriveTaskImpl;
+import org.matsim.contrib.dvrp.schedule.Schedule;
+import org.matsim.contrib.dvrp.schedule.Schedule.ScheduleStatus;
+import org.matsim.contrib.dvrp.schedule.Schedules;
+import org.matsim.contrib.dvrp.schedule.StayTask;
+import org.matsim.contrib.dvrp.schedule.StayTaskImpl;
+import org.matsim.contrib.dvrp.schedule.Task;
+import org.matsim.core.mobsim.framework.MobsimTimer;
+import org.matsim.core.mobsim.qsim.QSim;
+import org.matsim.core.router.DijkstraFactory;
+import org.matsim.core.router.util.LeastCostPathCalculator;
+import org.matsim.core.router.util.TravelTime;
+import org.matsim.core.trafficmonitoring.FreeSpeedTravelTime;
+
+import com.google.inject.Inject;
+import com.google.inject.name.Named;
+
+/**
+ * @author michalm
+ */
+final class OneTruckOptimizer implements VrpOptimizer {
+	private final MobsimTimer timer;
+
+	private final TravelTime travelTime;
+	private final LeastCostPathCalculator router;
+
+	private final Vehicle vehicle;// we have only one vehicle
+
+	public static final double PICKUP_DURATION = 120;
+	public static final double DROPOFF_DURATION = 60;
+
+	@Inject
+	public OneTruckOptimizer(@Named(DvrpRoutingNetworkProvider.DVRP_ROUTING) Network network, Fleet fleet, QSim qSim) {
+		timer = qSim.getSimTimer();
+		travelTime = new FreeSpeedTravelTime();
+		router = new DijkstraFactory().createPathCalculator(network, new TimeAsTravelDisutility(travelTime), travelTime);
+
+		vehicle = fleet.getVehicles().values().iterator().next();
+		vehicle.resetSchedule();
+		vehicle.getSchedule().addTask(new StayTaskImpl(vehicle.getServiceBeginTime(), vehicle.getServiceEndTime(),
+				vehicle.getStartLink(), "wait"));
+	}
+
+	@Override
+	public void requestSubmitted(Request request) {
+		Schedule schedule = vehicle.getSchedule();
+		StayTask lastTask = (StayTask)Schedules.getLastTask(schedule);// only WaitTask possible here
+		double currentTime = timer.getTimeOfDay();
+
+		switch (lastTask.getStatus()) {
+			case PLANNED:
+				schedule.removeLastTask();// remove wait task
+				break;
+
+			case STARTED:
+				lastTask.setEndTime(currentTime);// shorten wait task
+				break;
+
+			case PERFORMED:
+			default:
+				throw new IllegalStateException();
+		}
+
+		OneTruckRequest req = (OneTruckRequest)request;
+		Link fromLink = req.getFromLink();
+		Link toLink = req.getToLink();
+
+		double t0 = schedule.getStatus() == ScheduleStatus.UNPLANNED ? //
+				Math.max(vehicle.getServiceBeginTime(), currentTime) : //
+				Schedules.getLastTask(schedule).getEndTime();
+
+		VrpPathWithTravelData pathToCustomer = VrpPaths.calcAndCreatePath(lastTask.getLink(), fromLink, t0, router,
+				travelTime);
+		schedule.addTask(new DriveTaskImpl(pathToCustomer));
+
+		double t1 = pathToCustomer.getArrivalTime();
+		double t2 = t1 + PICKUP_DURATION;// 2 minutes for picking up the passenger
+		schedule.addTask(new OneTruckServeTask(t1, t2, fromLink, true, req));
+
+		VrpPathWithTravelData pathWithCustomer = VrpPaths.calcAndCreatePath(fromLink, toLink, t2, router, travelTime);
+		schedule.addTask(new DriveTaskImpl(pathWithCustomer));
+
+		double t3 = pathWithCustomer.getArrivalTime();
+		double t4 = t3 + DROPOFF_DURATION;// 1 minute for dropping off the passenger
+		schedule.addTask(new OneTruckServeTask(t3, t4, toLink, false, req));
+
+		// just wait (and be ready) till the end of the vehicle's time window (T1)
+		double tEnd = Math.max(t4, vehicle.getServiceEndTime());
+		schedule.addTask(new StayTaskImpl(t4, tEnd, toLink, "wait"));
+	}
+
+	@Override
+	public void nextTask(Vehicle vehicle1) {
+		updateTimings();
+		vehicle1.getSchedule().nextTask();
+	}
+
+	/**
+	 * Simplified version. For something more advanced, see
+	 * {@link org.matsim.contrib.taxi.scheduler.TaxiScheduler#updateBeforeNextTask(Schedule)} in the taxi contrib
+	 */
+	private void updateTimings() {
+		Schedule schedule = vehicle.getSchedule();
+		if (schedule.getStatus() != ScheduleStatus.STARTED) {
+			return;
+		}
+
+		double now = timer.getTimeOfDay();
+		Task currentTask = schedule.getCurrentTask();
+		double diff = now - currentTask.getEndTime();
+
+		if (diff == 0) {
+			return;
+		}
+
+		currentTask.setEndTime(now);
+
+		List<? extends Task> tasks = schedule.getTasks();
+		int nextTaskIdx = currentTask.getTaskIdx() + 1;
+
+		// all except the last task (waiting)
+		for (int i = nextTaskIdx; i < tasks.size() - 1; i++) {
+			Task task = tasks.get(i);
+			task.setBeginTime(task.getBeginTime() + diff);
+			task.setEndTime(task.getEndTime() + diff);
+		}
+
+		// wait task
+		if (nextTaskIdx != tasks.size()) {
+			Task waitTask = tasks.get(tasks.size() - 1);
+			waitTask.setBeginTime(waitTask.getBeginTime() + diff);
+
+			double tEnd = Math.max(waitTask.getBeginTime(), vehicle.getServiceEndTime());
+			waitTask.setEndTime(tEnd);
+		}
+	}
+}

contribs/dvrp/src/main/java/org/matsim/contrib/dvrp/examples/onetruck/OneTruckRequest.java

@@ -0,0 +1,60 @@
+/* *********************************************************************** *
+ * project: org.matsim.*
+ *                                                                         *
+ * *********************************************************************** *
+ *                                                                         *
+ * copyright       : (C) 2013 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.contrib.dvrp.examples.onetruck;
+
+import org.matsim.api.core.v01.Id;
+import org.matsim.api.core.v01.network.Link;
+import org.matsim.contrib.dvrp.data.Request;
+
+/**
+ * @author michalm
+ */
+public final class OneTruckRequest implements Request {
+	private final Id<Request> id;
+	private final double submissionTime;
+
+	private final Link fromLink;
+	private final Link toLink;
+
+	public OneTruckRequest(Id<Request> id, Link fromLink, Link toLink, double submissionTime) {
+		this.id = id;
+		this.submissionTime = submissionTime;
+		this.fromLink = fromLink;
+		this.toLink = toLink;
+	}
+
+	@Override
+	public Id<Request> getId() {
+		return id;
+	}
+
+	@Override
+	public double getSubmissionTime() {
+		return submissionTime;
+	}
+
+	public Link getFromLink() {
+		return fromLink;
+	}
+
+	public Link getToLink() {
+		return toLink;
+	}
+}

contribs/dvrp/src/main/java/org/matsim/contrib/dvrp/examples/onetruck/OneTruckRequestCreator.java

@@ -0,0 +1,79 @@
+/* *********************************************************************** *
+ * project: org.matsim.*
+ *                                                                         *
+ * *********************************************************************** *
+ *                                                                         *
+ * copyright       : (C) 2012 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.contrib.dvrp.examples.onetruck;
+
+import java.util.Arrays;
+import java.util.Comparator;
+import java.util.PriorityQueue;
+
+import javax.inject.Inject;
+
+import org.matsim.api.core.v01.Id;
+import org.matsim.api.core.v01.network.Network;
+import org.matsim.contrib.dvrp.data.Request;
+import org.matsim.contrib.dvrp.optimizer.VrpOptimizer;
+import org.matsim.contrib.dvrp.router.DvrpRoutingNetworkProvider;
+import org.matsim.core.mobsim.framework.events.MobsimAfterSimStepEvent;
+import org.matsim.core.mobsim.framework.listeners.MobsimAfterSimStepListener;
+
+import com.google.inject.name.Named;
+
+/**
+ * @author michalm
+ */
+final class OneTruckRequestCreator implements MobsimAfterSimStepListener {
+	private final VrpOptimizer optimizer;
+	private final PriorityQueue<OneTruckRequest> requests = new PriorityQueue<>(10,
+			Comparator.comparing(Request::getSubmissionTime));
+
+	@Inject
+	public OneTruckRequestCreator(VrpOptimizer optimizer,
+			@Named(DvrpRoutingNetworkProvider.DVRP_ROUTING) Network network) {
+		this.optimizer = optimizer;
+		requests.addAll(Arrays.asList(createRequest("parcel_0", "114", "349", 0, network),
+				createRequest("parcel_1", "144", "437", 300, network),
+				createRequest("parcel_2", "223", "347", 600, network),
+				createRequest("parcel_3", "234", "119", 900, network),
+				createRequest("parcel_4", "314", "260", 1200, network),
+				createRequest("parcel_5", "333", "438", 1500, network),
+				createRequest("parcel_6", "325", "111", 1800, network),
+				createRequest("parcel_7", "412", "318", 2100, network),
+				createRequest("parcel_8", "455", "236", 2400, network),
+				createRequest("parcel_9", "139", "330", 2700, network)));
+	}
+
+	private OneTruckRequest createRequest(String requestId, String fromLinkId, String toLinkId, double time,
+			Network network) {
+		return new OneTruckRequest(Id.create(requestId, Request.class),
+				network.getLinks().get(Id.createLinkId(fromLinkId)), network.getLinks().get(Id.createLinkId(toLinkId)),
+				time);
+	}
+
+	@Override
+	public void notifyMobsimAfterSimStep(@SuppressWarnings("rawtypes") MobsimAfterSimStepEvent e) {
+		while (isReadyForSubmission(requests.peek(), e.getSimulationTime())) {
+			optimizer.requestSubmitted(requests.poll());
+		}
+	}
+
+	private boolean isReadyForSubmission(OneTruckRequest request, double currentTime) {
+		return request != null && request.getSubmissionTime() <= currentTime;
+	}
+}