Improve error message of network link check (#3775)

* improve error message of network link check

* add method to remove legs to clean population

Author: rakow

contribs/application/src/main/java/org/matsim/application/prepare/population/CleanPopulation.java

@@ -9,13 +9,17 @@
 import org.matsim.core.population.algorithms.PersonAlgorithm;
 import org.matsim.core.population.algorithms.TripsToLegsAlgorithm;
 import org.matsim.core.router.RoutingModeMainModeIdentifier;
+import org.matsim.core.router.TripStructureUtils;
 import picocli.CommandLine;
 
 import java.nio.file.Files;
 import java.nio.file.Path;
+import java.util.List;
+import java.util.Optional;
+import java.util.Set;
 
 /**
- * Removes information from a popoulation file.
+ * Removes information from a population file.
  *
  * @author rakow
  */
@@ -38,11 +42,17 @@ public class CleanPopulation implements MATSimAppCommand, PersonAlgorithm {
 	@CommandLine.Option(names = "--remove-activity-location", description = "Remove link and facility from activities", defaultValue = "false")
 	private boolean rmActivityLocations;
 
+	@CommandLine.Option(names = "--remove-activity-facilities", description = "Remove facility ids from activities", defaultValue = "false")
+	private boolean rmActivityFacilities;
+
 	@CommandLine.Option(names = "--remove-routes", description = "Remove route information", defaultValue = "false")
 	private boolean rmRoutes;
 
-	@CommandLine.Option(names = "--trips-to-legs", description = "Convert trips in older plan format to legs first (Removes routes implicitly).", defaultValue = "false")
-	private  boolean tripsToLegs;
+	@CommandLine.Option(names = "--trips-to-legs", description = "Convert trips to single legs (Removes all routing and individual legs).", defaultValue = "false")
+	private boolean tripsToLegs;
+
+	@CommandLine.Option(names = "--remove-legs", description = "Remove the legs of trips for given modes, e.g. pt", split = ",", defaultValue = "")
+	private Set<String> rmLegs;
 
 	@CommandLine.Option(names = "--output", description = "Output file name", required = true)
 	private Path output;
@@ -60,7 +70,7 @@ public Integer call() throws Exception {
 
 		Population population = PopulationUtils.readPopulation(plans.toString());
 
-		if (!rmRoutes && !rmActivityLocations && !rmUnselected && !tripsToLegs) {
+		if (!rmRoutes && !rmActivityLocations && !rmUnselected && !tripsToLegs && !rmActivityFacilities && (rmLegs == null || rmLegs.isEmpty())) {
 			log.error("None of the 'remove' commands specified.");
 			return 2;
 		}
@@ -87,6 +97,10 @@ public void run(Person person) {
 			if (tripsToLegs)
 				trips2Legs.run(plan);
 
+			if (rmLegs != null && !rmLegs.isEmpty()) {
+				removeLegs(plan, rmLegs);
+			}
+
 			for (PlanElement el : plan.getPlanElements()) {
 				if (rmRoutes) {
 					removeRouteFromLeg(el);
@@ -95,10 +109,44 @@ public void run(Person person) {
 				if (rmActivityLocations) {
 					removeActivityLocation(el);
 				}
+
+				if (rmActivityFacilities && el instanceof Activity act) {
+					act.setFacilityId(null);
+				}
 			}
 		}
 	}
 
+	/**
+	 * Remove the legs of trips that contain any of the given modes.
+	 */
+	public static void removeLegs(Plan plan, Set<String> modes) {
+
+		final List<PlanElement> planElements = plan.getPlanElements();
+
+		// Remove all pt trips
+		for (TripStructureUtils.Trip trip : TripStructureUtils.getTrips(plan)) {
+
+			// Check if any of the modes is in the trip
+			Optional<Leg> cleanLeg = trip.getLegsOnly().stream().filter(l -> modes.contains(l.getMode())).findFirst();
+
+			if (cleanLeg.isEmpty())
+				continue;
+
+			// Replaces all trip elements and inserts single leg
+			final List<PlanElement> fullTrip =
+				planElements.subList(
+					planElements.indexOf(trip.getOriginActivity()) + 1,
+					planElements.indexOf(trip.getDestinationActivity()));
+
+			fullTrip.clear();
+
+			Leg leg = PopulationUtils.createLeg(cleanLeg.get().getMode());
+			TripStructureUtils.setRoutingMode(leg, cleanLeg.get().getMode());
+			fullTrip.add(leg);
+		}
+	}
+
 	/**
 	 * Remove link and facility information from activity.
 	 */
@@ -128,4 +176,6 @@ public static void removeUnselectedPlans(Person person) {
 				person.removePlan(plan);
 		}
 	}
+
+
 }

matsim/src/main/java/org/matsim/core/population/algorithms/PersonPrepareForSim.java

@@ -22,6 +22,7 @@
 
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
+import org.matsim.api.core.v01.Id;
 import org.matsim.api.core.v01.Scenario;
 import org.matsim.api.core.v01.TransportMode;
 import org.matsim.api.core.v01.network.Link;
@@ -204,13 +205,15 @@ private void checkModeConsistent(Person person, Leg leg) {
 			return;
 		}
 
-		Optional<? extends Link> inconsistentLink = networkRoute.getLinkIds().stream()
-												  .map(l -> scenario.getNetwork().getLinks().get(l))
-												  .filter(l -> !l.getAllowedModes().contains(leg.getMode()))
+		Optional<Id<Link>> inconsistentLink = networkRoute.getLinkIds().stream()
+												  .filter(linkId -> {
+													  Link link = scenario.getNetwork().getLinks().get(linkId);
+													  return link == null || !link.getAllowedModes().contains(leg.getMode());
+												  })
 			.findFirst();
 
 		if (inconsistentLink.isPresent()) {
-			String errorMessage = "Route inconsistent with link modes for: Link: " + inconsistentLink.get() + " Person " + person.getId() + "; Leg '" + leg + "'";
+			String errorMessage = "Route inconsistent with link modes for link: " + inconsistentLink.get() + " Person " + person.getId() + "; Leg '" + leg + "'";
 			log.error(errorMessage + "\n Consider cleaning inconsistent routes by using PopulationUtils.checkRouteModeAndReset()." +
 				"\n If this is intended, set the routing config parameter 'networkRouteConsistencyCheck' to 'disable'.");
 			throw new RuntimeException(errorMessage);