Merge pull request #3772 from moia-oss/shiftTypes

nkuehnel · web-flow · commit 2acd683491f7 · 2025-03-11T12:55:34.000+01:00
DRT shifts: add shift type
diff --git a/contribs/drt-extensions/src/main/java/org/matsim/contrib/drt/extension/operations/shifts/dispatcher/AssignShiftToVehicleLogic.java b/contribs/drt-extensions/src/main/java/org/matsim/contrib/drt/extension/operations/shifts/dispatcher/AssignShiftToVehicleLogic.java
@@ -1,10 +1,21 @@
 /*
- * Copyright (C) 2022 MOIA GmbH - All Rights Reserved
- *
- * You may use, distribute and modify this code 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.
+ * *********************************************************************** *
+ * project: org.matsim.*
+ * *********************************************************************** *
+ *                                                                         *
+ * copyright       : (C) 2025 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.drt.extension.operations.shifts.dispatcher;
 
diff --git a/contribs/drt-extensions/src/main/java/org/matsim/contrib/drt/extension/operations/shifts/dispatcher/DefaultAssignShiftToVehicleLogic.java b/contribs/drt-extensions/src/main/java/org/matsim/contrib/drt/extension/operations/shifts/dispatcher/DefaultAssignShiftToVehicleLogic.java
@@ -1,10 +1,21 @@
 /*
- * Copyright (C) 2022 MOIA GmbH - All Rights Reserved
- *
- * You may use, distribute and modify this code 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.
+ * *********************************************************************** *
+ * project: org.matsim.*
+ * *********************************************************************** *
+ *                                                                         *
+ * copyright       : (C) 2025 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.drt.extension.operations.shifts.dispatcher;
 
diff --git a/contribs/drt-extensions/src/main/java/org/matsim/contrib/drt/extension/operations/shifts/dispatcher/DefaultShiftScheduler.java b/contribs/drt-extensions/src/main/java/org/matsim/contrib/drt/extension/operations/shifts/dispatcher/DefaultShiftScheduler.java
@@ -1,3 +1,22 @@
+/*
+ * *********************************************************************** *
+ * project: org.matsim.*
+ * *********************************************************************** *
+ *                                                                         *
+ * copyright       : (C) 2025 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.drt.extension.operations.shifts.dispatcher;
 
 import com.google.common.collect.ImmutableMap;
@@ -26,7 +45,7 @@ public final class DefaultShiftScheduler implements ShiftScheduler {
         }
         return (DrtShift) new DrtShiftImpl(spec.getId(), spec.getStartTime(), spec.getEndTime(),
                 spec.getOperationFacilityId().orElse(null), spec.getDesignatedVehicleId().orElse(null),
-                shiftBreak);
+                shiftBreak, spec.getShiftType().orElse(null));
     };
 
     public DefaultShiftScheduler(DrtShiftsSpecification shiftsSpecification) {
diff --git a/contribs/drt-extensions/src/main/java/org/matsim/contrib/drt/extension/operations/shifts/dispatcher/DefaultShiftStartLogic.java b/contribs/drt-extensions/src/main/java/org/matsim/contrib/drt/extension/operations/shifts/dispatcher/DefaultShiftStartLogic.java
@@ -1,10 +1,21 @@
 /*
- * Copyright (C) 2022 MOIA GmbH - All Rights Reserved
- *
- * You may use, distribute and modify this code 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.
+ * *********************************************************************** *
+ * project: org.matsim.*
+ * *********************************************************************** *
+ *                                                                         *
+ * copyright       : (C) 2025 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.drt.extension.operations.shifts.dispatcher;
 
diff --git a/contribs/drt-extensions/src/main/java/org/matsim/contrib/drt/extension/operations/shifts/dispatcher/DrtShiftDispatcher.java b/contribs/drt-extensions/src/main/java/org/matsim/contrib/drt/extension/operations/shifts/dispatcher/DrtShiftDispatcher.java
@@ -1,3 +1,22 @@
+/*
+ * *********************************************************************** *
+ * project: org.matsim.*
+ * *********************************************************************** *
+ *                                                                         *
+ * copyright       : (C) 2025 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.drt.extension.operations.shifts.dispatcher;
 
 import org.matsim.api.core.v01.Id;
diff --git a/contribs/drt-extensions/src/main/java/org/matsim/contrib/drt/extension/operations/shifts/dispatcher/DrtShiftDispatcherImpl.java b/contribs/drt-extensions/src/main/java/org/matsim/contrib/drt/extension/operations/shifts/dispatcher/DrtShiftDispatcherImpl.java
@@ -1,3 +1,22 @@
+/*
+ * *********************************************************************** *
+ * project: org.matsim.*
+ * *********************************************************************** *
+ *                                                                         *
+ * copyright       : (C) 2025 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.drt.extension.operations.shifts.dispatcher;
 
 import com.google.common.base.Verify;
diff --git a/contribs/drt-extensions/src/main/java/org/matsim/contrib/drt/extension/operations/shifts/dispatcher/ShiftScheduler.java b/contribs/drt-extensions/src/main/java/org/matsim/contrib/drt/extension/operations/shifts/dispatcher/ShiftScheduler.java
@@ -1,3 +1,22 @@
+/*
+ * *********************************************************************** *
+ * project: org.matsim.*
+ * *********************************************************************** *
+ *                                                                         *
+ * copyright       : (C) 2025 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.drt.extension.operations.shifts.dispatcher;
 
 import com.google.common.collect.ImmutableMap;
diff --git a/contribs/drt-extensions/src/main/java/org/matsim/contrib/drt/extension/operations/shifts/dispatcher/ShiftStartLogic.java b/contribs/drt-extensions/src/main/java/org/matsim/contrib/drt/extension/operations/shifts/dispatcher/ShiftStartLogic.java
@@ -1,10 +1,21 @@
 /*
- * Copyright (C) 2022 MOIA GmbH - All Rights Reserved
- *
- * You may use, distribute and modify this code 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.
+ * *********************************************************************** *
+ * project: org.matsim.*
+ * *********************************************************************** *
+ *                                                                         *
+ * copyright       : (C) 2025 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.drt.extension.operations.shifts.dispatcher;
 
diff --git a/contribs/drt-extensions/src/main/java/org/matsim/contrib/drt/extension/operations/shifts/io/DrtShiftsReader.java b/contribs/drt-extensions/src/main/java/org/matsim/contrib/drt/extension/operations/shifts/io/DrtShiftsReader.java
@@ -25,15 +25,19 @@ public class DrtShiftsReader extends MatsimXmlParser {
     private final static String BREAK_NAME = "break";
 
     public static final String ID = "id";
+
     public static final String START_TIME = "start";
     public static final String END_TIME = "end";
+
     public static final String OPERATION_FACILITY_ID = "operationFacilityId";
     public static final String DESIGNATED_VEHICLE_ID = "designatedVehicleId";
 
     public static final String EARLIEST_BREAK_START_TIME = "earliestStart";
     public static final String LATEST_BREAK_END_TIME = "latestEnd";
     public static final String BREAK_DURATION = "duration";
 
+    public static final String TYPE = "type";
+
     private static final Logger log = LogManager.getLogger( DrtShiftsReader.class ) ;
 
     private final DrtShiftsSpecification shiftsSpecification;
@@ -63,6 +67,10 @@ public void startTag(final String name, final Attributes atts, final Stack<Strin
                 if(designatedVehicleId != null) {
                     builder.designatedVehicle(Id.create(designatedVehicleId, DvrpVehicle.class));
                 }
+                String type = atts.getValue(TYPE);
+                if(type != null) {
+                    builder.type(type);
+                }
                 currentBuilder = builder;
                 break;
             case BREAK_NAME:
diff --git a/contribs/drt-extensions/src/main/java/org/matsim/contrib/drt/extension/operations/shifts/io/DrtShiftsWriter.java b/contribs/drt-extensions/src/main/java/org/matsim/contrib/drt/extension/operations/shifts/io/DrtShiftsWriter.java
@@ -28,15 +28,19 @@ public class DrtShiftsWriter extends MatsimXmlWriter {
     private final static String BREAK_NAME = "break";
 
     public static final String ID = "id";
+
     public static final String START_TIME = "start";
     public static final String END_TIME = "end";
+
     public static final String OPERATION_FACILITY_ID = "operationFacilityId";
     public static final String DESIGNATED_VEHICLE_ID = "designatedVehicleId";
 
     public static final String EARLIEST_BREAK_START_TIME = "earliestStart";
     public static final String LATEST_BREAK_END_TIME = "latestEnd";
     public static final String BREAK_DURATION = "duration";
 
+    public static final String TYPE = "type";
+
     private static final Logger log = LogManager.getLogger(DrtShiftsWriter.class);
 
     private final Map<Id<DrtShift>, DrtShiftSpecification> shifts;
@@ -64,7 +68,7 @@ private void writeShifts(Map<Id<DrtShift>, DrtShiftSpecification> shifts) throws
         List<DrtShiftSpecification> sortedShifts = shifts.values()
                 .stream()
                 .sorted(Comparator.comparing(Identifiable::getId))
-                .collect(Collectors.toList());
+                .toList();
         for (DrtShiftSpecification shift : sortedShifts) {
             atts.clear();
             atts.add(createTuple(ID, shift.getId().toString()));
@@ -74,6 +78,8 @@ private void writeShifts(Map<Id<DrtShift>, DrtShiftSpecification> shifts) throws
 					atts.add(createTuple(OPERATION_FACILITY_ID, operationFacilityId.toString())));
             shift.getDesignatedVehicleId().ifPresent(designatedVehicleId ->
                     atts.add(createTuple(DESIGNATED_VEHICLE_ID, designatedVehicleId.toString())));
+            shift.getShiftType().ifPresent(shiftType ->
+                    atts.add(createTuple(TYPE, shiftType)));
             this.writeStartTag(SHIFT_NAME, atts);
 
             //Write break, if present
diff --git a/contribs/drt-extensions/src/main/java/org/matsim/contrib/drt/extension/operations/shifts/shift/DrtShift.java b/contribs/drt-extensions/src/main/java/org/matsim/contrib/drt/extension/operations/shifts/shift/DrtShift.java
@@ -29,4 +29,6 @@ public interface DrtShift extends Identifiable<DrtShift>, Comparable<DrtShift> {
 	Optional<DrtShiftBreak> getBreak();
 
 	Optional<Id<DvrpVehicle>> getDesignatedVehicleId();
+
+	Optional<String> getShiftType();
 }
diff --git a/contribs/drt-extensions/src/main/java/org/matsim/contrib/drt/extension/operations/shifts/shift/DrtShiftImpl.java b/contribs/drt-extensions/src/main/java/org/matsim/contrib/drt/extension/operations/shifts/shift/DrtShiftImpl.java
@@ -15,22 +15,26 @@ public class DrtShiftImpl implements DrtShift {
 
 	private final double start;
 	private final double end;
+
 	private final Id<OperationFacility> operationFacilityId;
 	private final Id<DvrpVehicle> designatedVehicleId;
 
+	private final String type;
+
 	private final DrtShiftBreak shiftBreak;
 
 	private boolean started = false;
 	private boolean ended = false;
 
 	public DrtShiftImpl(Id<DrtShift> id, double start, double end, Id<OperationFacility> operationFacilityId,
-						Id<DvrpVehicle> designatedVehicleId, DrtShiftBreak shiftBreak) {
+                        Id<DvrpVehicle> designatedVehicleId, DrtShiftBreak shiftBreak, String type) {
 		this.id = id;
 		this.start = start;
 		this.end = end;
 		this.operationFacilityId = operationFacilityId;
         this.designatedVehicleId = designatedVehicleId;
         this.shiftBreak = shiftBreak;
+        this.type = type;
 	}
 
 	@Override
@@ -53,6 +57,11 @@ public Optional<Id<DvrpVehicle>> getDesignatedVehicleId() {
 		return Optional.ofNullable(designatedVehicleId);
 	}
 
+	@Override
+	public Optional<String> getShiftType() {
+		return Optional.ofNullable(type);
+	}
+
 	@Override
 	public boolean isStarted() {
 		return started;
diff --git a/contribs/drt-extensions/src/main/java/org/matsim/contrib/drt/extension/operations/shifts/shift/DrtShiftSpecification.java b/contribs/drt-extensions/src/main/java/org/matsim/contrib/drt/extension/operations/shifts/shift/DrtShiftSpecification.java
@@ -12,13 +12,33 @@
  */
 public interface DrtShiftSpecification extends Identifiable<DrtShift> {
 
+	/**
+	 * The shift's start time
+	 */
 	double getStartTime();
 
+	/**
+	 * The shift's end time.
+	 */
 	double getEndTime();
 
+	/**
+	 * Returns an optional break during the shift.
+	 */
 	Optional<DrtShiftBreakSpecification> getBreak();
 
+	/**
+	 * Indicates whether the shift should start and end at a specific operation facility
+	 */
 	Optional<Id<OperationFacility>> getOperationFacilityId();
 
+	/**
+	 * Indicates whether the shift is already predefined to operate an a given vehicle
+	 */
     Optional<Id<DvrpVehicle>> getDesignatedVehicleId();
+
+	/**
+	 * Type may be used to distinguish various specifications of the shift, e.g., for specifically trained drivers/operators
+	 */
+	Optional<String> getShiftType();
 }
diff --git a/contribs/drt-extensions/src/main/java/org/matsim/contrib/drt/extension/operations/shifts/shift/DrtShiftSpecificationImpl.java b/contribs/drt-extensions/src/main/java/org/matsim/contrib/drt/extension/operations/shifts/shift/DrtShiftSpecificationImpl.java
diff --git a/contribs/drt-extensions/src/test/java/org/matsim/contrib/drt/extension/operations/shifts/ShiftsIOTest.java b/contribs/drt-extensions/src/test/java/org/matsim/contrib/drt/extension/operations/shifts/ShiftsIOTest.java
diff --git a/contribs/drt-extensions/test/input/org/matsim/contrib/drt/extension/operations/shifts/testShifts.xml b/contribs/drt-extensions/test/input/org/matsim/contrib/drt/extension/operations/shifts/testShifts.xml
