org.matsim.withinday.controller.WithinDayModule Class Reference

Inheritance diagram for org.matsim.withinday.controller.WithinDayModule:

Public Member Functions
void	install ()
final void	configure (Binder binder)

Static Public Member Functions
static AbstractModule	override (final Iterable<? extends AbstractModule > modules, final AbstractModule abstractModule)
static AbstractModule	emptyModule ()

Protected Member Functions
final Binder	binder ()
final void	install (Module module)
final Config	getConfig ()
final LinkedBindingBuilder< EventHandler >	addEventHandlerBinding ()
final void	installQSimModule (AbstractQSimModule qsimModule)
final void	installOverridingQSimModule (AbstractQSimModule qsimModule)
final LinkedBindingBuilder< ControlerListener >	addControlerListenerBinding ()
final com.google.inject.binder.LinkedBindingBuilder< PlanSelector< Plan, Person > >	bindPlanSelectorForRemoval ()
final com.google.inject.binder.LinkedBindingBuilder< PlanStrategy >	addPlanStrategyBinding (String selectorName)
final com.google.inject.binder.LinkedBindingBuilder< Mobsim >	bindMobsim ()
final com.google.inject.binder.LinkedBindingBuilder< ScoringFunctionFactory >	bindScoringFunctionFactory ()
final com.google.inject.binder.LinkedBindingBuilder< MobsimListener >	addMobsimListenerBinding ()
final com.google.inject.binder.LinkedBindingBuilder< SnapshotWriter >	addSnapshotWriterBinding ()
final LinkedBindingBuilder< AttributeConverter<?> >	addAttributeConverterBinding (final Class<?> clazz)
final com.google.inject.binder.LinkedBindingBuilder< TravelDisutilityFactory >	bindCarTravelDisutilityFactory ()
final Key< TravelDisutilityFactory >	carTravelDisutilityFactoryKey ()
final com.google.inject.binder.LinkedBindingBuilder< TravelDisutilityFactory >	addTravelDisutilityFactoryBinding (String mode)
final com.google.inject.binder.LinkedBindingBuilder< LeastCostPathCalculatorFactory >	bindLeastCostPathCalculatorFactory ()
final com.google.inject.binder.LinkedBindingBuilder< TravelTime >	addTravelTimeBinding (String mode)
final LinkedBindingBuilder< RoutingModule >	addRoutingModuleBinding (String mode)
final LinkedBindingBuilder< PersonPrepareForSimAlgorithm >	addPersonPrepareForSimAlgorithm ()
final com.google.inject.binder.LinkedBindingBuilder< EventsManager >	bindEventsManager ()
final LinkedBindingBuilder< TravelTime >	bindNetworkTravelTime ()
final Key< TravelTime >	networkTravelTime ()
final Key< TravelTime >	carTravelTime ()
final< T > jakarta.inject.Provider< T >	getProvider (TypeLiteral< T > typeLiteral)

Detailed Description

Definition at line 46 of file WithinDayModule.java.

Member Function Documentation

install() [1/2]

void org.matsim.withinday.controller.WithinDayModule.install

(

)

Definition at line 48 of file WithinDayModule.java.

References org.matsim.core.controler.AbstractModule.addControlerListenerBinding(), and org.matsim.api.core.v01.TransportMode.car.

                          {
        install(new WithinDayTravelTimeModule());
        bind(WithinDayEngine.class);
        bind(Mobsim.class).toProvider(WithinDayQSimFactory.class);
        bind(FixedOrderSimulationListener.class).asEagerSingleton();
        bind(WithinDayControlerListener.class).asEagerSingleton();
        addControlerListenerBinding().to(WithinDayControlerListener.class);
        bind(MobsimDataProvider.class).asEagerSingleton();
        bind(ActivityReplanningMap.class).asEagerSingleton();
        bind(LinkReplanningMap.class).asEagerSingleton();
        bind(EarliestLinkExitTimeProvider.class).asEagerSingleton();
    }

Here is the call graph for this function:

binder()

final Binder org.matsim.core.controler.AbstractModule.binder ( )

protectedinherited

Definition at line 246 of file AbstractModule.java.

Referenced by org.matsim.core.controler.AbstractModule.addPersonPrepareForSimAlgorithm(), org.matsim.core.controler.AbstractModule.addPlanStrategyBinding(), org.matsim.core.controler.AbstractModule.addRoutingModuleBinding(), org.matsim.core.controler.AbstractModule.addTravelDisutilityFactoryBinding(), org.matsim.core.controler.AbstractModule.addTravelTimeBinding(), org.matsim.core.controler.AbstractModule.bindEventsManager(), org.matsim.core.modal.AbstractModalModule< M extends Annotation >.getMode(), org.matsim.core.controler.NewControlerModule.install(), org.matsim.core.replanning.conflicts.ConflictModule.install(), org.matsim.core.controler.DefaultPrepareForSimModule.install(), org.matsim.core.events.MobsimScopeEventHandlingModule.install(), org.matsim.core.replanning.StrategyManagerModule.install(), and org.matsim.core.controler.AbstractModule.override().

                                    {
        return binder;
    }

configure()

final void org.matsim.core.controler.AbstractModule.configure ( Binder  binder )

inherited

Definition at line 93 of file AbstractModule.java.

References org.matsim.core.controler.AbstractModule.initializeMultibinders(), and org.matsim.core.controler.AbstractModule.install().

                                               {
        if (this.config == null) {
            this.config = bootstrapInjector.getInstance(Config.class);
        }
        // Guice error messages should give the code location of the error in the user's module,
        // not in this class.
        this.binder = binder.skipSources(AbstractModule.class);

        initializeMultibinders();

        this.install();
    }

Here is the call graph for this function:

install() [2/2]

final void org.matsim.core.controler.AbstractModule.install ( Module  module )

protectedinherited

Definition at line 124 of file AbstractModule.java.

                                                {
        bootstrapInjector.injectMembers(module);
        binder.install(module);
    }

getConfig()

final Config org.matsim.core.controler.AbstractModule.getConfig ( )

protectedinherited

Definition at line 120 of file AbstractModule.java.

References org.matsim.core.controler.AbstractModule.config.

Referenced by org.matsim.analysis.LinkStatsModule.install(), org.matsim.core.population.VspPlansCleanerModule.install(), org.matsim.core.replanning.conflicts.ConflictModule.install(), org.matsim.core.router.costcalculators.TravelDisutilityModule.install(), org.matsim.pt.router.TransitRouterModule.install(), org.matsim.core.scenario.ScenarioByConfigModule.install(), org.matsim.core.mobsim.DefaultMobsimModule.install(), org.matsim.core.router.LeastCostPathCalculatorModule.install(), org.matsim.withinday.trafficmonitoring.WithinDayTravelTimeModule.install(), org.matsim.core.events.EventsManagerModule.install(), org.matsim.core.router.TripRouterModule.install(), ch.sbb.matsim.routing.pt.raptor.SwissRailRaptorModule.install(), org.matsim.core.replanning.StrategyManagerModule.install(), org.matsim.vis.snapshotwriters.SnapshotWritersModule.install(), org.matsim.core.scenario.ScenarioByInstanceModule.install(), org.matsim.core.trafficmonitoring.TravelTimeCalculatorModule.install(), org.matsim.core.replanning.strategies.DefaultPlanStrategiesModule.install(), org.matsim.core.controler.ControlerDefaultsModule.install(), org.matsim.core.replanning.inheritance.PlanInheritanceModule.install(), and org.matsim.core.utils.timing.TimeInterpretationModule.provideTimeInterpretation().

                                       {
        return config;
    }

addEventHandlerBinding()

final LinkedBindingBuilder<EventHandler> org.matsim.core.controler.AbstractModule.addEventHandlerBinding ( )

protectedinherited

Definition at line 129 of file AbstractModule.java.

Referenced by ch.sbb.matsim.routing.pt.raptor.SwissRailRaptorModule.install(), and org.matsim.core.scoring.StandaloneExperiencedPlansModule.install().

                                                                                {
        return Multibinder.newSetBinder(this.binder, EventHandler.class).addBinding();
    }

installQSimModule()

final void org.matsim.core.controler.AbstractModule.installQSimModule ( AbstractQSimModule  qsimModule )

protectedinherited

Definition at line 133 of file AbstractModule.java.

Referenced by org.matsim.core.events.MobsimScopeEventHandlingModule.install().

                                                                          {
        Multibinder.newSetBinder(this.binder, AbstractQSimModule.class).addBinding().toInstance(qsimModule);
    }

installOverridingQSimModule()

final void org.matsim.core.controler.AbstractModule.installOverridingQSimModule ( AbstractQSimModule  qsimModule )

protectedinherited

Definition at line 136 of file AbstractModule.java.

                                                                                    {
        Multibinder.newSetBinder( this.binder, AbstractQSimModule.class, Names.named( "overridesFromAbstractModule" ) ).addBinding().toInstance(qsimModule);
    }

addControlerListenerBinding()

final LinkedBindingBuilder<ControlerListener> org.matsim.core.controler.AbstractModule.addControlerListenerBinding ( )

protectedinherited

See also

ControlerListener

Definition at line 143 of file AbstractModule.java.

Referenced by org.matsim.guice.DependencyGraphModule.install(), org.matsim.analysis.linkpaxvolumes.LinkPaxVolumesAnalysisModule.install(), org.matsim.analysis.LegHistogramModule.install(), org.matsim.analysis.IterationTravelStatsModule.install(), org.matsim.analysis.LinkStatsModule.install(), org.matsim.analysis.ModeStatsModule.install(), org.matsim.core.population.VspPlansCleanerModule.install(), org.matsim.analysis.LegTimesModule.install(), org.matsim.analysis.ScoreStatsModule.install(), org.matsim.analysis.pt.stop2stop.PtStop2StopAnalysisModule.install(), org.matsim.analysis.personMoney.PersonMoneyEventsAnalysisModule.install(), org.matsim.core.events.MobsimScopeEventHandlingModule.install(), org.matsim.counts.CountsModule.install(), org.matsim.withinday.controller.WithinDayModule.install(), org.matsim.core.controler.ControlerDefaultsModule.install(), and org.matsim.core.replanning.inheritance.PlanInheritanceModule.install().

                                                                                          {
        return Multibinder.newSetBinder(this.binder, ControlerListener.class).addBinding();
    }

bindPlanSelectorForRemoval()

final com.google.inject.binder.LinkedBindingBuilder<PlanSelector<Plan, Person> > org.matsim.core.controler.AbstractModule.bindPlanSelectorForRemoval ( )

protectedinherited

See also

StrategyManagerModule

Definition at line 150 of file AbstractModule.java.

Referenced by org.matsim.core.replanning.strategies.DefaultPlanStrategiesModule.install().

                                                                                                                           {
        return bind(new TypeLiteral<PlanSelector<Plan, Person>>(){});
    }

addPlanStrategyBinding()

final com.google.inject.binder.LinkedBindingBuilder<PlanStrategy> org.matsim.core.controler.AbstractModule.addPlanStrategyBinding ( String  selectorName )

protectedinherited

Definition at line 154 of file AbstractModule.java.

References org.matsim.core.controler.AbstractModule.binder().

Referenced by org.matsim.core.replanning.strategies.DefaultPlanStrategiesModule.install().

                                                                                                                            {
        return binder().bind(PlanStrategy.class).annotatedWith(Names.named(selectorName));
    }

Here is the call graph for this function:

bindMobsim()

final com.google.inject.binder.LinkedBindingBuilder<Mobsim> org.matsim.core.controler.AbstractModule.bindMobsim ( )

protectedinherited

Definition at line 158 of file AbstractModule.java.

Referenced by org.matsim.core.mobsim.DefaultMobsimModule.install().

                                                                                       {
        return bind(Mobsim.class);
    }

bindScoringFunctionFactory()

final com.google.inject.binder.LinkedBindingBuilder<ScoringFunctionFactory> org.matsim.core.controler.AbstractModule.bindScoringFunctionFactory ( )

protectedinherited

Definition at line 162 of file AbstractModule.java.

                                                                                                                       {
        return bind(ScoringFunctionFactory.class);
    }

addMobsimListenerBinding()

final com.google.inject.binder.LinkedBindingBuilder<MobsimListener> org.matsim.core.controler.AbstractModule.addMobsimListenerBinding ( )

protectedinherited

Contents retrieved (I think) by injected method QSim::addQueueSimulationListeners(...). Is not public, and therefore cannot be referenced from here.
I think that that method will be called every time the mobsim will be constructed. If the injected classes are singletons, they will presumably be re-used, otherwise they will be newly constructed.

Definition at line 172 of file AbstractModule.java.

Referenced by org.matsim.vis.snapshotwriters.SnapshotWritersModule.install().

                                                                                                             {
        return Multibinder.newSetBinder(this.binder, MobsimListener.class).addBinding();
    }

addSnapshotWriterBinding()

final com.google.inject.binder.LinkedBindingBuilder<SnapshotWriter> org.matsim.core.controler.AbstractModule.addSnapshotWriterBinding ( )

protectedinherited

Definition at line 176 of file AbstractModule.java.

Referenced by org.matsim.vis.snapshotwriters.SnapshotWritersModule.install().

                                                                                                             {
        return Multibinder.newSetBinder(this.binder, SnapshotWriter.class).addBinding();
    }

addAttributeConverterBinding()

final LinkedBindingBuilder<AttributeConverter<?> > org.matsim.core.controler.AbstractModule.addAttributeConverterBinding ( final Class<?>  clazz )

protectedinherited

Definition at line 180 of file AbstractModule.java.

                                                                                                                    {
        return MapBinder.newMapBinder(this.binder, new TypeLiteral<Class<?>>(){}, new TypeLiteral<AttributeConverter<?>>() {} ).addBinding( clazz );
    }

bindCarTravelDisutilityFactory()

final com.google.inject.binder.LinkedBindingBuilder<TravelDisutilityFactory> org.matsim.core.controler.AbstractModule.bindCarTravelDisutilityFactory ( )

protectedinherited

Deprecated:

better use addTravelDisutilityFactoryBinding(String).

Definition at line 187 of file AbstractModule.java.

References org.matsim.core.controler.AbstractModule.addTravelDisutilityFactoryBinding(), and org.matsim.api.core.v01.TransportMode.car.

                                                                                                                            {
        return addTravelDisutilityFactoryBinding( TransportMode.car );
    }

Here is the call graph for this function:

carTravelDisutilityFactoryKey()

final Key<TravelDisutilityFactory> org.matsim.core.controler.AbstractModule.carTravelDisutilityFactoryKey ( )

protectedinherited

Definition at line 191 of file AbstractModule.java.

References org.matsim.api.core.v01.TransportMode.car.

                                                                                 {
        return Key.get(TravelDisutilityFactory.class, Names.named(TransportMode.car));
    }

addTravelDisutilityFactoryBinding()

final com.google.inject.binder.LinkedBindingBuilder<TravelDisutilityFactory> org.matsim.core.controler.AbstractModule.addTravelDisutilityFactoryBinding ( String  mode )

protectedinherited

Definition at line 195 of file AbstractModule.java.

References org.matsim.core.controler.AbstractModule.binder().

Referenced by org.matsim.core.controler.AbstractModule.bindCarTravelDisutilityFactory(), and org.matsim.core.router.costcalculators.TravelDisutilityModule.install().

                                                                                                                                          {
        return binder().bind(TravelDisutilityFactory.class).annotatedWith(Names.named(mode));
    }

Here is the call graph for this function:

bindLeastCostPathCalculatorFactory()

final com.google.inject.binder.LinkedBindingBuilder<LeastCostPathCalculatorFactory> org.matsim.core.controler.AbstractModule.bindLeastCostPathCalculatorFactory ( )

protectedinherited

Definition at line 199 of file AbstractModule.java.

                                                                                                                                       {
        return bind(LeastCostPathCalculatorFactory.class);
    }

addTravelTimeBinding()

final com.google.inject.binder.LinkedBindingBuilder<TravelTime> org.matsim.core.controler.AbstractModule.addTravelTimeBinding ( String  mode )

protectedinherited

Definition at line 203 of file AbstractModule.java.

References org.matsim.core.controler.AbstractModule.binder().

                                                                                                                {
        return binder().bind(TravelTime.class).annotatedWith(Names.named(mode));
    }

Here is the call graph for this function:

addRoutingModuleBinding()

final LinkedBindingBuilder<RoutingModule> org.matsim.core.controler.AbstractModule.addRoutingModuleBinding ( String  mode )

protectedinherited

Definition at line 207 of file AbstractModule.java.

References org.matsim.core.controler.AbstractModule.binder().

Referenced by org.matsim.core.router.TripRouterModule.install(), and ch.sbb.matsim.routing.pt.raptor.SwissRailRaptorModule.install().

                                                                                             {
        return binder().bind(RoutingModule.class).annotatedWith(Names.named(mode));
    }

Here is the call graph for this function:

addPersonPrepareForSimAlgorithm()

final LinkedBindingBuilder<PersonPrepareForSimAlgorithm> org.matsim.core.controler.AbstractModule.addPersonPrepareForSimAlgorithm ( )

protectedinherited

Definition at line 211 of file AbstractModule.java.

References org.matsim.core.controler.AbstractModule.binder().

                                                                                                         {
        return Multibinder.newSetBinder(binder(), PersonPrepareForSimAlgorithm.class).addBinding();
    }

Here is the call graph for this function:

bindEventsManager()

final com.google.inject.binder.LinkedBindingBuilder<EventsManager> org.matsim.core.controler.AbstractModule.bindEventsManager ( )

protectedinherited

Definition at line 215 of file AbstractModule.java.

References org.matsim.core.controler.AbstractModule.binder().

Referenced by org.matsim.core.events.EventsManagerModule.install().

                                                                                                     {
        return binder().bind(EventsManager.class);
    }

Here is the call graph for this function:

bindNetworkTravelTime()

final LinkedBindingBuilder<TravelTime> org.matsim.core.controler.AbstractModule.bindNetworkTravelTime ( )

protectedinherited

Deprecated:

besser use addTravelTimeBinding(String).

Definition at line 223 of file AbstractModule.java.

References org.matsim.core.controler.AbstractModule.carTravelTime().

                                                                             {
        return bind( carTravelTime() );
    }

Here is the call graph for this function:

networkTravelTime()

final Key<TravelTime> org.matsim.core.controler.AbstractModule.networkTravelTime ( )

protectedinherited

Definition at line 228 of file AbstractModule.java.

References org.matsim.core.controler.AbstractModule.carTravelTime().

{ return carTravelTime(); }

Here is the call graph for this function:

carTravelTime()

final Key<TravelTime> org.matsim.core.controler.AbstractModule.carTravelTime ( )

protectedinherited

Definition at line 230 of file AbstractModule.java.

References org.matsim.api.core.v01.TransportMode.car.

Referenced by org.matsim.core.controler.AbstractModule.bindNetworkTravelTime(), and org.matsim.core.controler.AbstractModule.networkTravelTime().

                                                    {
        return Key.get(TravelTime.class, Names.named(TransportMode.car));
    }

getProvider()

final<T> jakarta.inject.Provider<T> org.matsim.core.controler.AbstractModule.getProvider ( TypeLiteral< T >  typeLiteral )

protectedinherited

Definition at line 250 of file AbstractModule.java.

                                                                                           {
        return binder.getProvider(Key.get(typeLiteral));
    }

override()

static AbstractModule org.matsim.core.controler.AbstractModule.override ( final Iterable<? extends AbstractModule >  modules, final AbstractModule  abstractModule  )

staticinherited

Definition at line 254 of file AbstractModule.java.

References org.matsim.core.controler.AbstractModule.AbstractModule(), org.matsim.core.controler.AbstractModule.binder(), and org.matsim.core.controler.AbstractModule.install().

Referenced by org.matsim.core.router.TripRouterFactoryBuilderWithDefaults.build(), org.matsim.core.mobsim.qsim.QSimBuilder.build(), org.matsim.core.controler.Controler.createInjector(), and org.matsim.run.InitRoutes.run().

                                                                                                                                 {
        return new AbstractModule() {
            @Override
            public void install() {
                final List<com.google.inject.Module> guiceModules = new ArrayList<>();
                for (AbstractModule module : modules) {
                    bootstrapInjector.injectMembers(module);
                    guiceModules.add(module);
                }
                bootstrapInjector.injectMembers(abstractModule);
                binder().install(Modules.override(guiceModules).with(abstractModule));
            }
        };
    }

Here is the call graph for this function:

emptyModule()

static AbstractModule org.matsim.core.controler.AbstractModule.emptyModule ( )

staticinherited

Definition at line 269 of file AbstractModule.java.

References org.matsim.core.controler.AbstractModule.AbstractModule(), and org.matsim.core.controler.AbstractModule.install().

                                               {
        return new AbstractModule() {
            @Override
            public void install() {}
        };
    }

Here is the call graph for this function:

---

The documentation for this class was generated from the following file:

• withinday/controller/WithinDayModule.java