Merge branch 'main' into kn/aComment

Author: kainagel

contribs/dvrp/src/main/java/org/matsim/contrib/dvrp/fleet/FleetModule.java

@@ -24,10 +24,8 @@
 
 import org.matsim.api.core.v01.network.Network;
 import org.matsim.contrib.dvrp.analysis.ExecutedScheduleCollector;
-import org.matsim.contrib.dvrp.load.DefaultDvrpLoadFromFleet;
 import org.matsim.contrib.dvrp.load.DefaultDvrpLoadFromVehicle;
 import org.matsim.contrib.dvrp.load.DefaultDvrpLoadFromVehicle.CapacityMapping;
-import org.matsim.contrib.dvrp.load.DvrpLoadFromFleet;
 import org.matsim.contrib.dvrp.load.DvrpLoadFromVehicle;
 import org.matsim.contrib.dvrp.load.DvrpLoadModule;
 import org.matsim.contrib.dvrp.load.DvrpLoadParams;
@@ -81,13 +79,6 @@ public void install() {
 
 		install(new DvrpLoadModule(getMode(), loadParams));
 
-		bindModal(DefaultDvrpLoadFromFleet.class).toProvider(modalProvider(getter -> {
-			DvrpLoadType loadType = getter.getModal(DvrpLoadType.class);
-			return new DefaultDvrpLoadFromFleet(loadType, loadParams.getMapFleetCapacity());
-		})).in(Singleton.class);
-
-		bindModal(DvrpLoadFromFleet.class).to(modalKey(DefaultDvrpLoadFromFleet.class));
-
 		bindModal(DvrpLoadFromVehicle.class).toProvider(modalProvider(getter -> {
 			DvrpLoadType loadType = getter.getModal(DvrpLoadType.class);
 			return new DefaultDvrpLoadFromVehicle(loadType, CapacityMapping.build(loadParams));
@@ -96,8 +87,8 @@ public void install() {
 		if (fleetSpecificationUrl != null) {
 			bindModal(FleetSpecification.class).toProvider(modalProvider((getter) -> {
 				FleetSpecification fleetSpecification = new FleetSpecificationImpl();
-				DvrpLoadFromFleet dvrpLoadFromFleet = getter.getModal(DvrpLoadFromFleet.class);
-				new FleetReader(fleetSpecification, dvrpLoadFromFleet).parse(fleetSpecificationUrl);
+				DvrpLoadType loadType = getter.getModal(DvrpLoadType.class);
+				new FleetReader(fleetSpecification, loadType).parse(fleetSpecificationUrl);
 				return fleetSpecification;
 			})).asEagerSingleton();
 		} else {

contribs/dvrp/src/main/java/org/matsim/contrib/dvrp/fleet/FleetReader.java

@@ -20,12 +20,11 @@
 
 package org.matsim.contrib.dvrp.fleet;
 
-import java.util.Optional;
 import java.util.Stack;
 
 import org.matsim.api.core.v01.Id;
 import org.matsim.contrib.dvrp.load.DvrpLoad;
-import org.matsim.contrib.dvrp.load.DvrpLoadFromFleet;
+import org.matsim.contrib.dvrp.load.DvrpLoadType;
 import org.matsim.core.utils.io.MatsimXmlParser;
 import org.xml.sax.Attributes;
 
@@ -38,12 +37,12 @@ public class FleetReader extends MatsimXmlParser {
 	private static final int DEFAULT_CAPACITY = 1;
 
 	private final FleetSpecification fleet;
-	private final DvrpLoadFromFleet dvrpVehicleLoadCreator;
+	private final DvrpLoadType loadType;
 
-	public FleetReader(FleetSpecification fleet, DvrpLoadFromFleet dvrpVehicleLoadCreator) {
+	public FleetReader(FleetSpecification fleet, DvrpLoadType loadType) {
 		super(ValidationType.DTD_ONLY);
 		this.fleet = fleet;
-		this.dvrpVehicleLoadCreator = dvrpVehicleLoadCreator;
+		this.loadType = loadType;
 	}
 
 	@Override
@@ -62,18 +61,13 @@ private DvrpVehicleSpecification createSpecification(Attributes atts) {
 		return ImmutableDvrpVehicleSpecification.newBuilder()
 				.id(vehicleId)
 				.startLinkId(Id.createLinkId(atts.getValue("start_link")))
-				.capacity(getCapacity(atts.getValue("capacity"), vehicleId, this.dvrpVehicleLoadCreator))
+				.capacity(getCapacity(atts.getValue("capacity")))
 				.serviceBeginTime(Double.parseDouble(atts.getValue("t_0")))
 				.serviceEndTime(Double.parseDouble(atts.getValue("t_1")))
 				.build();
 	}
 
-	private static DvrpLoad getCapacity(String capacityAttribute, Id<DvrpVehicle> vehicleId, DvrpLoadFromFleet dvrpVehicleLoadCreator) {
-		double capacity = Double.parseDouble(Optional.ofNullable(capacityAttribute).orElse(DEFAULT_CAPACITY + ""));
-		if ((int)capacity != capacity) {
-			//for backwards compatibility: use double when reading files (capacity used to be double)
-			throw new IllegalArgumentException("capacity must be an integer value");
-		}
-		return dvrpVehicleLoadCreator.getDvrpVehicleLoad((int)capacity, vehicleId);
+	private DvrpLoad getCapacity(String val) {
+		return loadType.deserialize(val == null ? String.valueOf(DEFAULT_CAPACITY) : val);
 	}
 }

contribs/dvrp/src/main/java/org/matsim/contrib/dvrp/load/DefaultDvrpLoadFromFleet.java

@@ -70,14 +70,6 @@ public void setMapVehicleTypeOther(String mapVehicleTypeOther) {
         this.mapVehicleTypeOther = mapVehicleTypeOther;
     }
 
-    public String getMapFleetCapacity() {
-        return mapFleetCapacity;
-    }
-
-    public void setMapFleetCapacity(String mapFleetCapacity) {
-        this.mapFleetCapacity = mapFleetCapacity;
-    }
-
     public String getDefaultRequestDimension() {
         return defaultRequestDimension;
     }
@@ -124,10 +116,6 @@ public enum VehicleCapacitySource {
     @Comment("maps the other capacity of a the dvrp vehicle type to a specific dimension")
     private String mapVehicleTypeOther = null;
 
-    @Parameter
-    @Comment("maps the vehicle capacity when loading from dvrp fleet format to a specific dimension")
-    private String mapFleetCapacity = "passengers";
-
     @Parameter
     @Comment("if no other load information is given, each request obtains a unit load for the given dimension")
     private String defaultRequestDimension = "passengers";
@@ -155,8 +143,5 @@ public void checkConsistency(Config config) {
 
         Preconditions.checkState(getMapVehicleTypeOther() == null || getDimensions().contains(getMapVehicleTypeOther()),
                 "the dimension configured for the vehicle type other capacity does not exist");
-
-        Preconditions.checkState(getMapFleetCapacity() == null || getDimensions().contains(getMapFleetCapacity()),
-                "the dimension configured for the dvrp fleet vehicle capacity does not exist");
     }
 }

contribs/dvrp/src/main/java/org/matsim/contrib/dvrp/load/DvrpLoadFromFleet.java

@@ -96,9 +96,13 @@ public DvrpLoad deserialize(String representation) {
             // list of numbers
 
             String[] components = representation.split(",");
-            int[] values = new int[components.length];
+            if (components.length > dimensions.size()) {
+                throw new IllegalStateException("Too many load values given: " + representation);
+            }
+
+            int[] values = new int[dimensions.size()];
 
-            for (int k = 0; k < values.length; k++) {
+            for (int k = 0; k < components.length; k++) {
                 values[k] = Integer.parseInt(components[k].trim());
             }
 

contribs/dvrp/src/main/java/org/matsim/contrib/dvrp/load/DvrpLoadParams.java

@@ -45,16 +45,6 @@ By default, one person is mapped to one slot of the capacity. This is set by def
 
 This example indicates that, if no other load information is provided for a trip/person, a unit load is assumed for the slot *passengers*. An exception will be thrown if the option is set to null. This way, the user can enforce that a load is defined for every request.
 
-### Defining vehicle capacities from the fleet file
-
-One option of loading vehicles for a DVRP mode is to use a fleet file with its respective format. In the fleet file, each *vehicle* has a *capacity* given as an integer. This value is transformed into a capacity by assigning the given integer to a slot that is configurable:
-
-```xml
-<parameterset name="load">
-  <param name="mapFleetCapacity" value="passengers">
-</parameterset>
-```
-
 ### Defining vehicle capacities from the vehicles file
 
 When reading the vehicles for the DVRP fleet from a vehicles file, each vehicle can have a `dvrp:capacity` attribute defining the quantities that are assigned to each capacity slot:
@@ -84,6 +74,14 @@ If neither the vehicle, nor the vehilce type, define capacities, the quantities
 </parameterset>
 ```
 
+### Defining vehicle capacities from the fleet file
+
+One option of loading vehicles for a DVRP mode is to use a fleet file with its respective format. In the fleet file, each *vehicle* has a *capacity*. This value can either be given as an integer (referring to the first dimension of the load, i.e., passengers by default) or as a complex capacity of the format described above:
+
+```xml
+<vehicle id="drt1" ... capacity="passengers=4,luggage=8" />
+```
+
 ### Defining an even more complex load/capacity logic
 
 DVRP now provides the `DvrpLoadType` and `DvrpLoad` interfaces. By creating new implementations of those interfaces one can define an arbitrary logic with respect to how capacities are handled in DVRP. In particular, the base functionality allows to define multi-dimensional loads and capacities that have *independent* slots. This means that, for instance, adding one more luggage to a vehicle does not affect the capacity of passengers. Such a logic, however, can be implemented using the cited interfaces.