ConfigConsistencyCheckerImpl.java

Go to the documentation of this file.

/* *********************************************************************** *
 * project: org.matsim.*
 * ConfigConsistencyCheckerImpl
 *                                                                         *
 * *********************************************************************** *
 *                                                                         *
 * copyright       : (C) 2009 by the members listed in the COPYING,        *
 *                   LICENSE and WARRANTY file.                            *
 * email           : info at matsim dot org                                *
 *                                                                         *
 * *********************************************************************** *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *   See also COPYING, LICENSE and WARRANTY file                           *
 *                                                                         *
 * *********************************************************************** */
package org.matsim.core.config.consistency;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.matsim.api.core.v01.TransportMode;
import org.matsim.core.config.Config;
import org.matsim.core.config.groups.ControllerConfigGroup.EventsFileFormat;
import org.matsim.core.config.groups.ControllerConfigGroup.RoutingAlgorithmType;
import org.matsim.core.config.groups.ScoringConfigGroup;
import org.matsim.core.config.groups.ScoringConfigGroup.ActivityParams;
import org.matsim.core.config.groups.ScoringConfigGroup.ModeParams;
import org.matsim.pt.PtConstants;

public final class ConfigConsistencyCheckerImpl implements ConfigConsistencyChecker {

    private static final Logger log = LogManager.getLogger(ConfigConsistencyCheckerImpl.class);

    public ConfigConsistencyCheckerImpl() { // explicit constructor so that I can eclipse-search for instantiation.  kai, may'11
        // nothing to do
    }

    @Override
    public void checkConsistency(final Config config) {
        checkScenarioFeaturesEnabled(config);
        checkEventsFormatLanesSignals(config);
        checkTravelTimeCalculationRoutingConfiguration(config);
        checkLaneDefinitionRoutingConfiguration(config);
        checkPlanCalcScore(config);
        checkTransit(config);
        checkConsistencyBetweenRouterAndTravelTimeCalculator( config );
    }

    static boolean checkConsistencyBetweenRouterAndTravelTimeCalculator( final Config config ) {
        boolean problem = false ;
//      if ( config.travelTimeCalculator().getSeparateModes() ) {
//          if ( ! config.travelTimeCalculator().getAnalyzedModes().containsAll( config.plansCalcRoute().getNetworkModes() ) ) {
//              log.warn("AnalyzedModes in travelTimeCalculator config is not superset of network routing modes.  Will fail later except when defined by other means.");
//              problem = true ;
//          }
//      }
        // not sure if it ever worked like this, but now the analyzedModes are honoured only when separateModes is false and so the check does not make
        // sense IMO.  kai, jun'19
        return problem ;
    }

    /*package because of test */ static void checkPlanCalcScore(final Config c) {
        ModeParams ptModeParams = c.scoring().getModes().get(TransportMode.pt);
        if (ptModeParams!=null && ptModeParams.getMarginalUtilityOfTraveling() > 0) {
            log.warn(ScoringConfigGroup.GROUP_NAME + ".travelingPt is > 0. This values specifies a utility. " +
                    "Typically, this should be a disutility, i.e. have a negative value.");
        }
        ModeParams carModeParams = c.scoring().getModes().get(TransportMode.car);
        if (carModeParams!=null && carModeParams.getMarginalUtilityOfTraveling() > 0) {
            log.warn(ScoringConfigGroup.GROUP_NAME + ".traveling is > 0. This values specifies a utility. " +
            "Typically, this should be a disutility, i.e. have a negative value.");
        }
        ModeParams bikeModeParams = c.scoring().getModes().get(TransportMode.bike);
        if (bikeModeParams!=null && bikeModeParams.getMarginalUtilityOfTraveling() > 0) {
            log.warn(ScoringConfigGroup.GROUP_NAME + ".travelingBike is > 0. This values specifies a utility. " +
            "Typically, this should be a disutility, i.e. have a negative value.");
        }
        ModeParams walkModeParams = c.scoring().getModes().get(TransportMode.walk);
        if (walkModeParams!=null && walkModeParams.getMarginalUtilityOfTraveling() > 0) {
            log.warn(ScoringConfigGroup.GROUP_NAME + ".travelingWalk is > 0. This values specifies a utility. " +
            "Typically, this should be a disutility, i.e. have a negative value.");
        }


        ActivityParams ptAct = c.scoring().getActivityParams(PtConstants.TRANSIT_ACTIVITY_TYPE) ;
        if ( ptAct != null ) {
//          if ( ptAct.getClosingTime()!=0. && ptAct.getClosingTime()!=Time.getUndefinedTime() ) {
//              if ( !c.vspExperimental().isAbleToOverwritePtInteractionParams()==true ) {
//                  throw new RuntimeException("setting the pt interaction activity closing time away from 0/undefined is not allowed because it breaks pt scoring." +
//                  " If you need this anyway (for backwards compatibility reasons), you can allow this by a parameter in VspExperimentalConfigGroup.") ;
//              }
//          }
            if ( ptAct.isScoringThisActivityAtAll() ) {
                if ( !c.vspExperimental().isAbleToOverwritePtInteractionParams() ) {
                    throw new RuntimeException("Scoring " + ptAct.getActivityType() + " is not allowed because it breaks pt scoring." +
                    " If you need this anyway (for backwards compatibility reasons), you can allow this by a parameter in VspExperimentalConfigGroup.") ;
                }
            }
        }

    }

    private static void checkEventsFormatLanesSignals(final Config c) {
        if (c.qsim().isUseLanes()) {
            if (!c.controller().getEventsFileFormats().contains(EventsFileFormat.xml)){
                log.error("Xml events are not enabled, but lanes and possibly signal systems" +
                        "are enalbed. Events from this features will only be written to the xml format, consider" +
                        "to add xml events in the controler config module");
            }
        }
    }

    private static void checkScenarioFeaturesEnabled(final Config c) {
        if (! ("qsim".equals(c.controller().getMobsim()) ||  c.qsim() != null)){
          log.warn("The signal system implementation is only supported by the org.matsim.ptproject.qsim mobility simulation that is not activated. Please make sure you are using the correct" +
                "mobility simulation. This warning can be ingored if a customized mobility simulation developed outside of org.matsim is used and set correctly.");
        }
    }


    private static void checkTravelTimeCalculationRoutingConfiguration(final Config config){
        if (config.controller().isLinkToLinkRoutingEnabled() &&
                !config.travelTimeCalculator().isCalculateLinkToLinkTravelTimes()){
            throw new IllegalStateException("LinkToLinkRouting is activated in config and" +
                    " link to link traveltime calculation is not enabled but required!");
        }

        if (config.travelTimeCalculator().isCalculateLinkTravelTimes() &&
                config.travelTimeCalculator().isCalculateLinkToLinkTravelTimes() &&
                !config.controller().isLinkToLinkRoutingEnabled()) {
            log.warn("Config enables link travel time calculation and link to link " +
                    "travel time calculation. This requires at least twice as much memory as " +
                    "if only one method is used, however it might be necessary to enable " +
                    "a certain module configuration.");
        }

        if (!config.travelTimeCalculator().isCalculateLinkTravelTimes()){
            log.warn("Link travel time calculation is switched off, be aware that this optimization" +
                    "might not work with all modules. ");
        }

        if (config.travelTimeCalculator().isCalculateLinkToLinkTravelTimes() &&
                config.qsim().isRemoveStuckVehicles()){
            throw new IllegalStateException("Link to link travel time calculation is not" +
                    "available if using the remove stuck vehicles option!");
        }

        if ( config.controller().isLinkToLinkRoutingEnabled() &&
                config.controller().getRoutingAlgorithmType() != RoutingAlgorithmType.Dijkstra ) {
            log.warn("We don't know if non-Dijkstra routing works together with LinkToLink routing.");
        }

    }


    private static void checkLaneDefinitionRoutingConfiguration(final Config config) {
        if ((config.qsim().isUseLanes()) &&
            !config.controller().isLinkToLinkRoutingEnabled()){
            log.warn("Using lanes without enabling linktolinkrouting might not lead to expected simulation results");
        }
    }

    private static void checkTransit(final Config config) {
//      if ( config.transit().isUseTransit() && config.transit().getVehiclesFile()==null ) {
//          log.warn("Your are using Transit but have not provided a transit vehicles file. This most likely won't work.");
//      }
        // The warning will also be logged when the vehicles are defined in code, which is perfectly acceptable.  kai, jun'19
    }
}