feat: DrtServiceAreaConstraint (#287)

Author: tkchouaki

core/src/main/java/org/eqasim/core/simulation/mode_choice/EqasimModeChoiceModule.java

@@ -25,6 +25,7 @@
 import org.eqasim.core.simulation.mode_choice.utilities.predictors.PersonPredictor;
 import org.eqasim.core.simulation.mode_choice.utilities.predictors.PtPredictor;
 import org.eqasim.core.simulation.mode_choice.utilities.predictors.WalkPredictor;
+import org.eqasim.core.simulation.modes.drt.mode_choice.constraints.DrtServiceAreaConstraint;
 import org.eqasim.core.simulation.modes.drt.mode_choice.constraints.DrtWalkConstraint;
 import org.eqasim.core.simulation.modes.drt.mode_choice.predictors.DefaultDrtPredictor;
 import org.eqasim.core.simulation.modes.drt.mode_choice.predictors.DrtPredictor;
@@ -47,6 +48,7 @@ public class EqasimModeChoiceModule extends AbstractEqasimExtension {
 	public static final String PASSENGER_CONSTRAINT_NAME = "PassengerConstraint";
 	public static final String OUTSIDE_CONSTRAINT_NAME = "OutsideConstraint";
 	public static final String DRT_WALK_CONSTRAINT = "DrtWalkConstraint";
+	public static final String DRT_SERVICE_AREA_CONSTRAINT = "DrtServiceAreaConstraint";
 	public static final String TOUR_LENGTH_FILTER_NAME = "TourLengthFilter";
 	public static final String OUTSIDE_FILTER_NAME = "OutsideFilter";
 
@@ -69,6 +71,7 @@ protected void installEqasimExtension() {
 		bindTripConstraintFactory(PASSENGER_CONSTRAINT_NAME).to(PassengerConstraint.Factory.class);
 		bindTripConstraintFactory(OUTSIDE_CONSTRAINT_NAME).to(OutsideConstraint.Factory.class);
 		bindTripConstraintFactory(DRT_WALK_CONSTRAINT).to(DrtWalkConstraint.Factory.class);
+		bindTripConstraintFactory(DRT_SERVICE_AREA_CONSTRAINT).to(DrtServiceAreaConstraint.Factory.class);
 
 		bindTourFilter(TOUR_LENGTH_FILTER_NAME).to(TourLengthFilter.class);
 		bindTourFilter(OUTSIDE_FILTER_NAME).to(OutsideFilter.class);

core/src/main/java/org/eqasim/core/simulation/modes/drt/mode_choice/constraints/DrtServiceAreaConstraint.java

@@ -0,0 +1,65 @@
+package org.eqasim.core.simulation.modes.drt.mode_choice.constraints;
+
+import com.google.inject.Inject;
+import org.eqasim.core.scenario.cutter.extent.ScenarioExtent;
+import org.eqasim.core.scenario.cutter.extent.ShapeScenarioExtent;
+import org.matsim.api.core.v01.population.Person;
+import org.matsim.contrib.drt.run.DrtConfigGroup;
+import org.matsim.contrib.drt.run.MultiModeDrtConfigGroup;
+import org.matsim.contribs.discrete_mode_choice.model.DiscreteModeChoiceTrip;
+import org.matsim.contribs.discrete_mode_choice.model.constraints.AbstractTripConstraint;
+import org.matsim.contribs.discrete_mode_choice.model.trip_based.TripConstraint;
+import org.matsim.contribs.discrete_mode_choice.model.trip_based.TripConstraintFactory;
+import org.matsim.core.config.Config;
+import org.matsim.core.config.ConfigGroup;
+
+import java.io.File;
+import java.io.IOException;
+import java.util.*;
+
+public class DrtServiceAreaConstraint extends AbstractTripConstraint {
+
+    private final Map<String, ScenarioExtent> scenarioExtentByMode;
+
+    public DrtServiceAreaConstraint(Map<String, ScenarioExtent> scenarioExtentByMode) {
+        this.scenarioExtentByMode = scenarioExtentByMode;
+    }
+
+    @Override
+    public boolean validateBeforeEstimation(DiscreteModeChoiceTrip trip, String mode, List<String> previousModes) {
+        ScenarioExtent scenarioExtent = scenarioExtentByMode.get(mode);
+        if(scenarioExtent != null) {
+            return scenarioExtent.isInside(trip.getOriginActivity().getCoord()) && scenarioExtent.isInside(trip.getDestinationActivity().getCoord());
+        }
+        return true;
+    }
+
+
+
+    public static class Factory implements TripConstraintFactory {
+
+        private final Map<String, ScenarioExtent> scenarioExtentByMode = new HashMap<>();
+
+        @Inject
+        public Factory(Config config) {
+            if(config.getModules().containsKey(MultiModeDrtConfigGroup.GROUP_NAME)) {
+                MultiModeDrtConfigGroup multiModeDrtConfigGroup = (MultiModeDrtConfigGroup) config.getModules().get(MultiModeDrtConfigGroup.GROUP_NAME);
+                multiModeDrtConfigGroup.getModalElements().stream()
+                        .filter(drtConfigGroup -> drtConfigGroup.operationalScheme.equals(DrtConfigGroup.OperationalScheme.serviceAreaBased))
+                        .forEach(drtConfigGroup -> {
+                            String extentPath = ConfigGroup.getInputFileURL(config.getContext(), drtConfigGroup.drtServiceAreaShapeFile).getPath();
+                            try {
+                                scenarioExtentByMode.put(drtConfigGroup.mode, new ShapeScenarioExtent.Builder(new File(extentPath), Optional.empty(), Optional.empty()).build());
+                            } catch (IOException e) {
+                                throw new RuntimeException(e);
+                            }
+                        });
+            }
+        }
+
+        @Override
+        public TripConstraint createConstraint(Person person, List<DiscreteModeChoiceTrip> list, Collection<String> collection) {
+            return new DrtServiceAreaConstraint(scenarioExtentByMode);
+        }
+    }
+}

core/src/main/java/org/eqasim/core/simulation/modes/drt/utils/AdaptConfigForDrt.java

@@ -70,10 +70,15 @@ public static void adapt(Config config, Map<String, String> vehiclesPathByDrtMod
         cachedModes.addAll(vehiclesPathByDrtMode.keySet());
         dmcConfig.setCachedModes(cachedModes);
 
+        boolean serviceAreaDrt = false;
+
         for(String drtMode: vehiclesPathByDrtMode.keySet()) {
             DrtConfigGroup drtConfigGroup = new DrtConfigGroup();
             drtConfigGroup.mode = drtMode;
             drtConfigGroup.operationalScheme = DrtConfigGroup.OperationalScheme.valueOf(operationalSchemes.get(drtMode));
+            if(drtConfigGroup.operationalScheme.equals(DrtConfigGroup.OperationalScheme.serviceAreaBased)) {
+                serviceAreaDrt = true;
+            }
             drtConfigGroup.stopDuration = 15.0;
             DefaultDrtOptimizationConstraintsSet defaultDrtOptimizationConstraintsSet = (DefaultDrtOptimizationConstraintsSet) drtConfigGroup.addOrGetDrtOptimizationConstraintsParams().addOrGetDefaultDrtOptimizationConstraintsSet();
             defaultDrtOptimizationConstraintsSet.maxWaitTime = 600;
@@ -132,6 +137,9 @@ public static void adapt(Config config, Map<String, String> vehiclesPathByDrtMod
             legTimeConstraintSingleLegConfigGroups.forEach(legTimeConstraintConfigGroup::addParameterSet);
         }
         tripConstraints.add(EqasimModeChoiceModule.DRT_WALK_CONSTRAINT);
+        if(serviceAreaDrt) {
+            tripConstraints.add(EqasimModeChoiceModule.DRT_SERVICE_AREA_CONSTRAINT);
+        }
         dmcConfig.setTripConstraints(tripConstraints);
 
         DrtConfigs.adjustMultiModeDrtConfig(multiModeDrtConfigGroup, config.scoring(), config.routing());