feat: separate travel time recording from general analysis (#271)

* feat: separate travel time recording from general analysis

* add changelog

* fix problem in unit tests

Author: sebhoerl

CHANGELOG.md

@@ -6,6 +6,7 @@ included in the (note yet determined) next version number.
 
 **Development version**
 
+- Introduce `travelTimeRecordingInterval` config option that decouples travel time writing from general analysis
 - Add eqasim_activities.csv for analysis
 - The cutters now take a GeoPackage file as an alterative to a ShapeFile
 - Emissions tools have been moved to core package (from ile_de_france)

core/src/main/java/org/eqasim/core/components/config/EqasimConfigGroup.java

@@ -22,6 +22,8 @@ public class EqasimConfigGroup extends ReflectiveConfigGroup {
 
 	private final static String ANALYSIS_INTERVAL = "analysisInterval";
 	private final static String ANALYSIS_DISTANCE_UNIT = "analysisDistanceUnit";
+	
+	private final static String TRAVEL_TIME_RECORDING_INTERVAL = "travelTimeRecordingInterval";
 
 	private final static String USE_SCHEDULE_BASED_TRANSPORT = "useScheduleBasedTransport";
 
@@ -35,6 +37,8 @@ public class EqasimConfigGroup extends ReflectiveConfigGroup {
 
 	private int analysisInterval = 0;
 	private DistanceUnit analysisDistanceUnit = DistanceUnit.meter;
+	
+	private int travelTimeRecordingInterval = 0;
 
 	private boolean useScheduleBasedTransport = true;
 
@@ -208,6 +212,16 @@ public void setAnalysisInterval(int analysisInterval) {
 		this.analysisInterval = analysisInterval;
 	}
 
+	@StringGetter(TRAVEL_TIME_RECORDING_INTERVAL)
+	public int getTravelTimeRecordingInterval() {
+		return travelTimeRecordingInterval;
+	}
+
+	@StringSetter(TRAVEL_TIME_RECORDING_INTERVAL)
+	public void setTravelTimeRecordingInterval(int travelTimeRecordingInterval) {
+		this.travelTimeRecordingInterval = travelTimeRecordingInterval;
+	}
+
 	@StringGetter(DISTANCE_UNIT)
 	public DistanceUnit getDistanceUnit() {
 		return distanceUnit;

core/src/main/java/org/eqasim/core/simulation/analysis/AnalysisOutputListener.java

@@ -44,21 +44,25 @@ public class AnalysisOutputListener implements IterationStartsListener, Iteratio
 	private final TravelTimeRecorder travelTimeRecorder;
 
 	private final int analysisInterval;
+	private final int travelTimeInterval;
+
 	private boolean isAnalysisActive = false;
+	private boolean isTravelTimeActive = false;
 
 	private final DistanceUnit scenarioDistanceUnit;
 	private final DistanceUnit analysisDistanceUnit;
 
 	@Inject
 	public AnalysisOutputListener(EqasimConfigGroup config, OutputDirectoryHierarchy outputDirectory,
-								  TripListener tripListener, LegListener legListener, PublicTransportLegListener ptListener,
-								  ActivityListener activityAnalysisListener, TravelTimeRecorder travelTimeRecorder) {
+			TripListener tripListener, LegListener legListener, PublicTransportLegListener ptListener,
+			ActivityListener activityAnalysisListener, TravelTimeRecorder travelTimeRecorder) {
 		this.outputDirectory = outputDirectory;
 
 		this.scenarioDistanceUnit = config.getDistanceUnit();
 		this.analysisDistanceUnit = config.getAnalysisDistanceUnit();
 
 		this.analysisInterval = config.getAnalysisInterval();
+		this.travelTimeInterval = config.getTravelTimeRecordingInterval();
 
 		this.tripAnalysisListener = tripListener;
 		this.legAnalysisListener = legListener;
@@ -70,15 +74,21 @@ public AnalysisOutputListener(EqasimConfigGroup config, OutputDirectoryHierarchy
 	@Override
 	public void notifyIterationStarts(IterationStartsEvent event) {
 		isAnalysisActive = false;
+		isTravelTimeActive = false;
 
 		if (analysisInterval > 0) {
 			if (event.getIteration() % analysisInterval == 0 || event.isLastIteration()) {
 				isAnalysisActive = true;
 				event.getServices().getEvents().addHandler(tripAnalysisListener);
 				event.getServices().getEvents().addHandler(legAnalysisListener);
 				event.getServices().getEvents().addHandler(ptAnalysisListener);
+			}
+		}
+
+		if (travelTimeInterval > 0) {
+			if (event.getIteration() % travelTimeInterval == 0 || event.isLastIteration()) {
+				isTravelTimeActive = true;
 				event.getServices().getEvents().addHandler(activityAnalysisListener);
-				event.getServices().getEvents().addHandler(travelTimeRecorder);
 			}
 		}
 	}
@@ -91,7 +101,6 @@ public void notifyIterationEnds(IterationEndsEvent event) {
 				event.getServices().getEvents().removeHandler(legAnalysisListener);
 				event.getServices().getEvents().removeHandler(ptAnalysisListener);
 				event.getServices().getEvents().removeHandler(activityAnalysisListener);
-				event.getServices().getEvents().removeHandler(travelTimeRecorder);
 
 				new TripWriter(tripAnalysisListener.getTripItems(), scenarioDistanceUnit, analysisDistanceUnit)
 						.write(outputDirectory.getIterationFilename(event.getIteration(), TRIPS_FILE_NAME));
@@ -101,11 +110,16 @@ public void notifyIterationEnds(IterationEndsEvent event) {
 
 				new ActivityWriter(activityAnalysisListener.getActivityItems())
 						.write(outputDirectory.getIterationFilename(event.getIteration(), ACTIVITIES_FILE_NAME));
-				
+
 				new PublicTransportLegWriter(ptAnalysisListener.getTripItems())
 						.write(outputDirectory.getIterationFilename(event.getIteration(), PT_FILE_NAME));
+			}
+
+			if (isTravelTimeActive) {
+				event.getServices().getEvents().removeHandler(travelTimeRecorder);
 
-				RecordedTravelTime.writeBinary(outputDirectory.getIterationFilename(event.getIteration(), TRAVEL_TIMES_FILE_NAME),
+				RecordedTravelTime.writeBinary(
+						outputDirectory.getIterationFilename(event.getIteration(), TRAVEL_TIMES_FILE_NAME),
 						this.travelTimeRecorder.getTravelTime());
 			}
 		} catch (IOException | InterruptedException e) {
@@ -122,10 +136,11 @@ public void notifyShutdown(ShutdownEvent event) {
 					new File(outputDirectory.getOutputFilename(LEGS_FILE_NAME)).toPath());
 			Files.copy(new File(outputDirectory.getIterationFilename(event.getIteration(), PT_FILE_NAME)).toPath(),
 					new File(outputDirectory.getOutputFilename(PT_FILE_NAME)).toPath());
-			Files.copy(new File(outputDirectory.getIterationFilename(event.getIteration(), ACTIVITIES_FILE_NAME)).toPath(),
+			Files.copy(
+					new File(outputDirectory.getIterationFilename(event.getIteration(), ACTIVITIES_FILE_NAME)).toPath(),
 					new File(outputDirectory.getOutputFilename(ACTIVITIES_FILE_NAME)).toPath());
-			Files.copy(new File(outputDirectory.getIterationFilename(event.getIteration(), TRAVEL_TIMES_FILE_NAME)).toPath(),
-					new File(outputDirectory.getOutputFilename(TRAVEL_TIMES_FILE_NAME)).toPath());
+			Files.copy(new File(outputDirectory.getIterationFilename(event.getIteration(), TRAVEL_TIMES_FILE_NAME))
+					.toPath(), new File(outputDirectory.getOutputFilename(TRAVEL_TIMES_FILE_NAME)).toPath());
 		} catch (IOException e) {
 		}
 	}

core/src/main/java/org/eqasim/core/standalone_mode_choice/RunStandaloneModeChoice.java

@@ -3,6 +3,7 @@
 
 import java.io.BufferedReader;
 import java.io.FileInputStream;
+import java.io.FileNotFoundException;
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.InputStreamReader;
@@ -219,6 +220,8 @@ RecordedTravelTime provideRecordedTravelTime() {
                     RecordedTravelTime recordedTravelTime = RecordedTravelTime.readBinary(inputStream);
                     inputStream.close();
                     return recordedTravelTime;
+                } catch (FileNotFoundException e) {
+                	throw new IllegalStateException("Travel time input file not found: " + path);
                 } catch (IOException e) {
                     throw new RuntimeException(e);
                 }

core/src/test/java/org/eqasim/TestSimulationPipeline.java

@@ -13,6 +13,7 @@
 import org.eqasim.core.analysis.run.RunLegAnalysis;
 import org.eqasim.core.analysis.run.RunPublicTransportLegAnalysis;
 import org.eqasim.core.analysis.run.RunTripAnalysis;
+import org.eqasim.core.components.config.EqasimConfigGroup;
 import org.eqasim.core.scenario.cutter.RunScenarioCutter;
 import org.eqasim.core.scenario.cutter.RunScenarioCutterV2;
 import org.eqasim.core.scenario.routing.RunPopulationRouting;
@@ -90,6 +91,7 @@ private void runMelunSimulation(String configPath, String outputPath, String inp
         if(lastIteration != null) {
             config.controller().setLastIteration(lastIteration);
         }
+        EqasimConfigGroup.get(config).setTravelTimeRecordingInterval(1000);
 
         Scenario scenario = ScenarioUtils.createScenario(config);
         eqasimConfigurator.configureScenario(scenario);

ile_de_france/src/test/java/org/eqasim/ile_de_france/TestCorisica.java

@@ -70,6 +70,7 @@ public void testCorsicaPipeline()
 					"--config-path", "corsica_test/corsica_config.xml", //
 					"--config:controler.lastIteration", "2", // ,
 					"--config:controler.outputDirectory", "corsica_test/simulation_output", //
+					"--config:eqasim.travelTimeRecordingInterval", "1000", //
 			});
 
 			Assert.assertEquals(389, countPersons("corsica_test/simulation_output/output_plans.xml.gz"));
@@ -115,6 +116,7 @@ public void testCorsicaPipeline()
 					"--config-path", "corsica_test/cut_config.xml", //
 					"--config:controler.lastIteration", "2", // ,
 					"--config:controler.outputDirectory", "corsica_test/cut_output", //
+					"--config:eqasim.travelTimeRecordingInterval", "1000", //
 			});
 
 			Map<String, Long> counts = countLegs("corsica_test/cut_output/output_events.xml.gz");