ScenarioConfigGroup.java

Go to the documentation of this file.

/* *********************************************************************** *
 * project: org.matsim.*
 * ScenarioConfigGroup
 *                                                                         *
 * *********************************************************************** *
 *                                                                         *
 * 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.groups;

import java.util.Map;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.matsim.core.config.ConfigGroup;
import org.matsim.core.config.ReflectiveConfigGroup.StringGetter;
import org.matsim.core.config.ReflectiveConfigGroup.StringSetter;

public final class ScenarioConfigGroup extends ConfigGroup {
    public static final String GROUP_NAME = "scenario";

    private static final String USE_LANES = "useLanes";
    private static final String USE_HOUSEHOLDS = "useHouseholds";
    private static final String USE_TRANSIT = "useTransit";
    private static final String USE_VEHICLES = "useVehicles";
    private static final String SIMULATION_PERIOD_DAYS = "simulationPeriodInDays"; // is not yet written to log-output so we can still rename it internally
    
    private static final Logger log = LogManager.getLogger( ScenarioConfigGroup.class ) ;

    private double simulationPeriodInDays = 1.0;
    
    public ScenarioConfigGroup() {
        super(GROUP_NAME);
    }

    @Override
    public Map<String, String> getComments() {
        Map<String,String> map = super.getComments();
        
        // I don't think that the following is used anywhere: 
        final String message = "Deprecated, do not use.  The file is loaded when the filename is given.  Functionality needs to be switched on elsewhere.";
        map.put(USE_LANES, message) ; // since jul'15
        map.put(USE_HOUSEHOLDS, message); // since jul'15
        map.put(USE_VEHICLES, message); // since jul'15
        map.put(USE_TRANSIT, "Deprecated, do not use.  See transit section of config file.") ; // since jul'15
        
        return map;
    }

    @Override
    public final void addParam(final String paramName, final String value) {
        // emulate previous behavior of reader (ignore null values at reading). td Apr'15
        if ( "null".equalsIgnoreCase( value ) ) return;

        if (USE_LANES.equals(paramName)) {
            this.setUseLanes( Boolean.parseBoolean(value) );
        } else if (USE_HOUSEHOLDS.equals(paramName)) {
            this.setUseHouseholds( Boolean.parseBoolean(value) );
        } else if (USE_VEHICLES.equals(paramName)) {
            this.setUseVehicles( Boolean.parseBoolean(value) );
        } else if (USE_TRANSIT.equals(paramName)) {
            this.setUseTransit( Boolean.parseBoolean(value) );
        } else {
            throw new IllegalArgumentException("Parameter '" + paramName + "' is not supported by config group '" + GROUP_NAME + "'.");
        }
    }
    @Override
    public final String getValue(final String param_name) {
        throw new UnsupportedOperationException("Use getters for accessing values!");
    }

    @Override
    public final Map<String, String> getParams() {
        Map<String, String> params = super.getParams();
        return params;
    }

    // if they are not in getParams, they will not be included into the config file dump.
    
    // if they are, however, in addParam, then the methods will be called (which throw exceptions).
    
    // Once the methods below are removed throughout the code, those exceptions can be moved into the addParam method.
    
    // Eventually, the whole scenario config group can be moved away.
    
    // kai, jul'15

    
    

    @Deprecated // since jul'15
        throw new RuntimeException( getMessage( USE_LANES ) ) ;
    }

    @Deprecated // since jul'15
        throw new RuntimeException( getMessage( USE_HOUSEHOLDS ) ) ;
    }

    @Deprecated // since jul'15
        throw new RuntimeException( getMessage( USE_VEHICLES ) ) ;
    }
    
    @Deprecated // since jul'15
        throw new RuntimeException("The " + USE_TRANSIT + " switch has moved to the transit section of the config file." ) ;
    }

    @StringSetter( SIMULATION_PERIOD_DAYS )
    public void setSimulationPeriodInDays(final double simulationPeriodInDays) {
        this.simulationPeriodInDays = simulationPeriodInDays;
    }
    
    @StringGetter( SIMULATION_PERIOD_DAYS )
    public double getSimulationPeriodInDays() {
        return this.simulationPeriodInDays;
    }

    
    private static String getMessage( String module ) {
        return "The " + module + " switch is no longer operational.  The file is loaded if the file name"
                + " is different from null.  If you needed this for the creation of the container, use the ScenarioBuilder in "
                + "ScenarioUtils.  Note that loading the file does not mean that it is used anywhere; such functionality needs to be "
                + "switched on elsewhere (e.g. in qsim, in transit, ...).  If this does not work for you, please let us know. kai, jun'15";
    }
    
}