ScenarioUtils.java

Go to the documentation of this file.

/* *********************************************************************** *
 * project: org.matsim.*
 * ScenarioUtils.java
 *                                                                         *
 * *********************************************************************** *
 *                                                                         *
 * copyright       : (C) 2019 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.scenario;

import java.util.Collections;
import java.util.Map;

import org.matsim.api.core.v01.Scenario;
import org.matsim.api.core.v01.network.Network;
import org.matsim.api.core.v01.population.Population;
import org.matsim.core.config.Config;
import org.matsim.facilities.ActivityFacilities;
import org.matsim.households.Households;
import org.matsim.lanes.Lanes;
import org.matsim.pt.transitSchedule.api.TransitSchedule;
import org.matsim.utils.objectattributes.AttributeConverter;
import org.matsim.vehicles.Vehicles;


public final class ScenarioUtils {

    private ScenarioUtils() {
        // make it private, so it cannot be instantiated
    }

    public static Scenario createScenario(final Config config) {
        if (config == null) {
            throw new NullPointerException("config must not be null!");
        }
        return new MutableScenario(config);
    }
    public static MutableScenario createMutableScenario(final Config config) {
        if (config == null) {
            throw new NullPointerException("config must not be null!");
        }
        return new MutableScenario(config);
    }

    public static Scenario loadScenario(final Config config) {
        return loadScenario(config, Collections.emptyMap());
    }

    public static Scenario loadScenario(final Config config, Map<Class<?>, AttributeConverter<?>> attributeConverters) {
        ScenarioLoaderImpl scenarioLoader = new ScenarioLoaderImpl(config);
        scenarioLoader.setAttributeConverters(attributeConverters);
        return scenarioLoader.loadScenario();
    }

    public static void loadScenario(final Scenario scenario) {
        loadScenario(scenario, Collections.emptyMap());
    }

    public static void loadScenario(final Scenario scenario, Map<Class<?>, AttributeConverter<?>> attributeConverters) {
        ScenarioLoaderImpl scenarioLoader = new ScenarioLoaderImpl(scenario);
        scenarioLoader.setAttributeConverters(attributeConverters);
        scenarioLoader.loadScenario();
    }
    
    public final static class ScenarioBuilder {
        private MutableScenario scenario;
        public ScenarioBuilder( Config config ) {
            this.scenario = new MutableScenario( config ) ;
        }
        public ScenarioBuilder addScenarioElement(String name, Object o) {
            scenario.addScenarioElement(name, o); 
            return this ;
        }
        public ScenarioBuilder setHouseholds( Households households ) {
            scenario.setHouseholds(households);
            return this ;
        }
        public ScenarioBuilder setTransitSchedule( TransitSchedule schedule ) {
            scenario.setTransitSchedule(schedule);
            return this ;
        }
        public ScenarioBuilder setVehicles( Vehicles vehicles ) {
            scenario.setTransitVehicles(vehicles);
            return this;
        }
        public ScenarioBuilder setNetwork( Network network ) {
            scenario.setNetwork(network);
            return this ;
        }
        public ScenarioBuilder setPopulation( Population population ) {
            scenario.setPopulation(population);
            return this ;
        }
        public ScenarioBuilder setActivityFacilities( ActivityFacilities facilities ) {
            scenario.setActivityFacilities(facilities);
            return this ;
        }
        public ScenarioBuilder setLanes( Lanes lanes ) {
            scenario.setLanes(lanes);
            return this ;
        }
        // final creational method:
        public Scenario build() {
            this.scenario.setLocked(); // prevents that one can cast to ScenarioImpl and change the containers again. kai, nov'14
            return this.scenario ;
        }
    }

}