ConsistencyChecker now skips test (3) when lookupBehavior does not need average entry

Author: Aleksander1234519

contribs/emissions/src/main/java/org/matsim/contrib/emissions/EmissionModule.java

@@ -183,7 +183,7 @@ private void createLookupTables() {
 
 		if(emissionConfigGroup.getHbefaConsistencyChecker() == EmissionsConfigGroup.UseHbefaConsistencyChecker.check){
 			logger.info("Checking consistency of hbefa-tables");
-			HbefaConsistencyChecker.checkConsistency(avgHbefaWarmTable, detailedHbefaWarmTable, avgHbefaColdTable, detailedHbefaColdTable);
+			HbefaConsistencyChecker.checkConsistency(emissionConfigGroup.getDetailedVsAverageLookupBehavior(), avgHbefaWarmTable, detailedHbefaWarmTable, avgHbefaColdTable, detailedHbefaColdTable);
 		}
 
 		logger.info("leaving createLookupTables");

contribs/emissions/src/main/java/org/matsim/contrib/emissions/HbefaConsistencyChecker.java

@@ -2,24 +2,25 @@
 
 
 import com.google.common.collect.Iterables;
+import org.matsim.contrib.emissions.utils.EmissionsConfigGroup;
 
 import javax.annotation.Nullable;
 import java.util.*;
 
 public class HbefaConsistencyChecker {
-
 	/**
 	 * Tests the read-in hbefa-maps and makes sure that: <br>
 	 * 	(1) Technology-column contains petrol or diesel <br>
 	 * 	(2) EmissionConcept contains neither petrol nor diesel <br>
-	 * 	(3) EmissionConcept and SizeClass contains "average" as fallback (used in technology-average-lookup) <br>
+	 * 	(3) EmissionConcept and SizeClass contains "average" as fallback (used in technology-average-lookup, skipped if not needed by lookup-behavior) <br>
 	 * 	(4) Average table contain only average entries in VehicleAttributes <br>
 	 *
 	 * 	Background of this consistency check is an error in the hbefa database, which causes the column names to be named wrong.
 	 *
 	 * @throws IllegalArgumentException with explanation, if one of the check listed above failed.
 	 */
-	static void checkConsistency(@Nullable Map<HbefaWarmEmissionFactorKey, HbefaWarmEmissionFactor> hbefaAvgWarm,
+	static void checkConsistency(EmissionsConfigGroup.DetailedVsAverageLookupBehavior lookupBehavior,
+								 @Nullable Map<HbefaWarmEmissionFactorKey, HbefaWarmEmissionFactor> hbefaAvgWarm,
 								 @Nullable Map<HbefaWarmEmissionFactorKey, HbefaWarmEmissionFactor> hbefaDetWarm,
 								 @Nullable Map<HbefaColdEmissionFactorKey, HbefaColdEmissionFactor> hbefaAvgCold,
 								 @Nullable Map<HbefaColdEmissionFactorKey, HbefaColdEmissionFactor> hbefaDetCold) throws IllegalArgumentException {
@@ -106,19 +107,23 @@ static void checkConsistency(@Nullable Map<HbefaWarmEmissionFactorKey, HbefaWarm
 					"The first 5 entries of emission-concept-column are: " + Iterables.limit(emConcepts, 5));
 
 			// Test (3)
-			if( !emConcepts.contains("average") )
-				throw new IllegalArgumentException("""
+			if( lookupBehavior != EmissionsConfigGroup.DetailedVsAverageLookupBehavior.onlyTryDetailedElseAbort &&
+				lookupBehavior != EmissionsConfigGroup.DetailedVsAverageLookupBehavior.directlyTryAverageTable){
+				if( !emConcepts.contains("average"))
+					throw new IllegalArgumentException("""
 					Emission-concept-column of warm detailed table does not contain average as key.\s
 					This may cause problems with the lookup-behaviors "tryDetailedThenTechnologyAverageElseAbort" and\s
 					"tryDetailedThenTechnologyAverageThenAverageTable". If you use one of these behaviors, make sure that an average entry exists!\s
 					If you want to proceed without average values, you can deactivate the ConsistencyCheck with EmissionsConfigGroup.setHbefaConsistencyChecker()\s""");
 
-			if( !sizeClass.contains("average") )
-				throw new IllegalArgumentException("""
+				if( !sizeClass.contains("average"))
+					throw new IllegalArgumentException("""
 					size-class-column of warm detailed table does not contain average as key.\s
 					This may cause problems with the lookup-behaviors "tryDetailedThenTechnologyAverageElseAbort" and\s
 					"tryDetailedThenTechnologyAverageThenAverageTable". If you use one of these behaviors, make sure that an average entry exists!\s
 					If you want to proceed without average values, you can deactivate the ConsistencyCheck with EmissionsConfigGroup.setHbefaConsistencyChecker()\s""");
+			}
+
 
 			technologies.clear();
 			emConcepts.clear();
@@ -142,19 +147,22 @@ static void checkConsistency(@Nullable Map<HbefaWarmEmissionFactorKey, HbefaWarm
 				throw new CorruptedHbefaTableException("Detailed cold table contains diesel or petrol key in the emission-concept-column. Unless you specifically put them in, you are probably using a corrupted hbefa table!");
 
 			// Test (3)
-			if( !emConcepts.contains("average") )
-				throw new IllegalArgumentException("""
-					Emission-concept-column of warm detailed table does not contain average as key.\s
-					This may cause problems with the lookup-behaviors "tryDetailedThenTechnologyAverageElseAbort" and\s
-					"tryDetailedThenTechnologyAverageThenAverageTable". If you use one of these behaviors, make sure that an average entry exists!\s
-					If you want to proceed without average values, you can deactivate the ConsistencyCheck with EmissionsConfigGroup.setHbefaConsistencyChecker()""");
-
-			if( !sizeClass.contains("average") )
-				throw new IllegalArgumentException("""
-					size-class-column of warm detailed table does not contain average as key.\s
-					This may cause problems with the lookup-behaviors "tryDetailedThenTechnologyAverageElseAbort" and\s
-					"tryDetailedThenTechnologyAverageThenAverageTable". If you use one of these behaviors, make sure that an average entry exists!\s
-					If you want to proceed without average values, you can deactivate the ConsistencyCheck with EmissionsConfigGroup.setHbefaConsistencyChecker()""");
+			if( lookupBehavior != EmissionsConfigGroup.DetailedVsAverageLookupBehavior.onlyTryDetailedElseAbort &&
+				lookupBehavior != EmissionsConfigGroup.DetailedVsAverageLookupBehavior.directlyTryAverageTable) {
+				if ( !emConcepts.contains("average"))
+					throw new IllegalArgumentException("""
+						Emission-concept-column of warm detailed table does not contain average as key.\s
+						This may cause problems with the lookup-behaviors "tryDetailedThenTechnologyAverageElseAbort" and\s
+						"tryDetailedThenTechnologyAverageThenAverageTable". If you use one of these behaviors, make sure that an average entry exists!\s
+						If you want to proceed without average values, you can deactivate the ConsistencyCheck with EmissionsConfigGroup.setHbefaConsistencyChecker()""");
+
+				if ( !sizeClass.contains("average"))
+					throw new IllegalArgumentException("""
+						size-class-column of warm detailed table does not contain average as key.\s
+						This may cause problems with the lookup-behaviors "tryDetailedThenTechnologyAverageElseAbort" and\s
+						"tryDetailedThenTechnologyAverageThenAverageTable". If you use one of these behaviors, make sure that an average entry exists!\s
+						If you want to proceed without average values, you can deactivate the ConsistencyCheck with EmissionsConfigGroup.setHbefaConsistencyChecker()""");
+			}
 
 			technologies.clear();
 			emConcepts.clear();