QSimModule.java

Go to the documentation of this file.

/* *********************************************************************** *
 * project: org.matsim.*
 * QSimModule.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.mobsim.qsim;


import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Set;

import org.matsim.core.controler.AbstractModule;
import org.matsim.core.mobsim.framework.Mobsim;
import org.matsim.core.mobsim.qsim.changeeventsengine.NetworkChangeEventsModule;
import org.matsim.core.mobsim.qsim.components.QSimComponentsModule;
import org.matsim.core.mobsim.qsim.messagequeueengine.MessageQueueModule;
import org.matsim.core.mobsim.qsim.pt.TransitEngineModule;
import org.matsim.core.mobsim.qsim.qnetsimengine.QNetsimEngineModule;

import com.google.inject.Key;
import com.google.inject.TypeLiteral;
import com.google.inject.name.Names;

public final class QSimModule extends AbstractModule {
    private final boolean addDefaultQSimModules;

    public QSimModule() {
        this(true);
    }

    public QSimModule(boolean addDefaultQSimModules) {
        this.addDefaultQSimModules = addDefaultQSimModules;
    }

    @Override
    public void install() {
        install(new QSimComponentsModule());
        // this is essentially a structured collection of strings that determines which QSimModules will later be used.  Can be
        // used to configure from config, but maybe easiest just ignore when getting started with this.  The default QSimModules
        // bind the corresponding implementations under the correct names.

        if (addDefaultQSimModules) {
            getDefaultQSimModules().forEach(this::installQSimModule);
            // this binds all the default modules, i.e. sets up the default QSim
        }

        bind(
                Key.get(new TypeLiteral<List<AbstractQSimModule>>() {}, Names.named("overrides"))
        ).toInstance(Collections.emptyList());
        // this initializes (I think) the container with the overriding bindings with an empty container.  Recall that "Key" and
        // "TypeLiteral" are only there to circumvent Java type erasure, so what we really have is
        //     List<AbstractQSimModule> annotated with "overrides"

        bind( new TypeLiteral<Collection<AbstractQSimModule>>() {} ).to(new TypeLiteral<Set<AbstractQSimModule>>() {});
        // I think that the result of this that you can use @Inject Collection<AbstractQSimModule> in addition to @Inject
        // Set<AbstractQSimModule>.  Don't know why this is needed.  kai, jun'23

        bind(Mobsim.class).toProvider(QSimProvider.class);
    }

    static public Collection<AbstractQSimModule> getDefaultQSimModules() {
        return Arrays.asList(
                new MessageQueueModule(),  // defines "MessageQueueEngine"
                new ActivityEngineModule(), // defines "ActivityEngine"
                new QNetsimEngineModule(), // defines "NetsimEngine"
                new TeleportationModule(), // etc.
                new PopulationModule(),
                new NetworkChangeEventsModule(),
                new TransitEngineModule()
                );
    }
}