java.lang.Object
- org.matsim.core.controler.Controler

All Implemented Interfaces:

Runnable, AllowsConfiguration, ControlerI, IterationCounter, MatsimServices
```
public final class Controler
extends Object
implements ControlerI, MatsimServices, AllowsConfiguration
```
The Controler is responsible for complete simulation runs, including the initialization of all required data, running the iterations and the replanning, analyses, etc.

Author:

mrieser

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Controler.DefaultFiles

Field Summary

Fields
Modifier and Type Field Description

static PatternLayout DEFAULTLOG4JLAYOUT

static String DIRECTORY_ITERS

static String DIVIDER

Constructor Summary

Constructors
Constructor	Description
`Controler(String configFileName)`
`Controler(String[] args)`	Initializes a new instance of Controler with the given arguments.
`Controler(Scenario scenario)`
`Controler(Config config)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	`addControlerListener(ControlerListener controlerListener)`
`Controler`	`addOverridingModule(AbstractModule abstractModule)`
`Controler`	`addOverridingQSimModule(AbstractQSimModule qsimModule)`
`Controler`	`addQSimModule(AbstractQSimModule qsimModule)`
`Controler`	`configureQSimComponents(QSimComponentsConfigurator configurator)`	Only use if you know what you are doing, for experts only.
`TravelDisutility`	`createTravelDisutilityCalculator()`
`Config`	`getConfig()`
`OutputDirectoryHierarchy`	`getControlerIO()`
`EventsManager`	`getEvents()`
`com.google.inject.Injector`	`getInjector()`
`Integer`	`getIterationNumber()`
`LeastCostPathCalculatorFactory`	`getLeastCostPathCalculatorFactory()`
`CalcLinkStats`	`getLinkStats()`	Deprecated. Do not use this, as it may not contain values in every iteration
`TravelTime`	`getLinkTravelTimes()`
`Scenario`	`getScenario()`
`ScoreStats`	`getScoreStats()`
`ScoringFunctionFactory`	`getScoringFunctionFactory()`
`IterationStopWatch`	`getStopwatch()`
`StrategyManager`	`getStrategyManager()`	Deprecated. -- try to use services.addPlanStrategyFactory or services.addPlanSelectoryFactory.
`TravelDisutilityFactory`	`getTravelDisutilityFactory()`
`com.google.inject.Provider<TripRouter>`	`getTripRouterProvider()`	Gives access to a `TripRouter` instance.
`VolumesAnalyzer`	`getVolumes()`
`static void`	`main(String[] args)`
`void`	`run()`	Starts the iterations.
`void`	`setModules(AbstractModule... modules)`
`void`	`setScoringFunctionFactory(ScoringFunctionFactory scoringFunctionFactory)`
`void`	`setTerminationCriterion(TerminationCriterion terminationCriterion)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DIRECTORY_ITERS
```
public static final String DIRECTORY_ITERS
```
    See Also:
    
    Constant Field Values
  - DIVIDER
```
public static final String DIVIDER
```
    See Also:
    
    Constant Field Values
  - DEFAULTLOG4JLAYOUT
```
public static final PatternLayout DEFAULTLOG4JLAYOUT
```
- Constructor Detail
  - Controler
```
public Controler(String[] args)
```
    Initializes a new instance of Controler with the given arguments.
    
    Parameters:
    
    args - The arguments to initialize the services with. args[0] is expected to contain the path to a configuration file, args[1], if set, is expected to contain the path to a local copy of the DTD file used in the configuration file.
  - Controler
```
public Controler(String configFileName)
```
  - Controler
```
public Controler(Config config)
```
  - Controler
```
public Controler(Scenario scenario)
```
- Method Detail
  - getStopwatch
```
public IterationStopWatch getStopwatch()
```
    Specified by:
    
    getStopwatch in interface MatsimServices
  - main
```
public static void main(String[] args)
```
  - run
```
public final void run()
```
    Starts the iterations.
    
    Specified by:
    
    run in interface Runnable
  - getLinkTravelTimes
```
public final TravelTime getLinkTravelTimes()
```
    Specified by:
    
    getLinkTravelTimes in interface MatsimServices
  - getTripRouterProvider
```
public final com.google.inject.Provider<TripRouter> getTripRouterProvider()
```
    Gives access to a TripRouter instance. This is a routing service which you can use to calculate routes, e.g. from your own replanning code or your own within-day replanning agent code. You get a Provider (and not an instance directly) because your code may want to later create more than one instance. A TripRouter is not guaranteed to be thread-safe, so you must get() an instance for each thread if you plan to write multi-threaded code. See TripRouter for more information and pointers to examples.
    
    Specified by:
    
    getTripRouterProvider in interface MatsimServices
  - createTravelDisutilityCalculator
```
public final TravelDisutility createTravelDisutilityCalculator()
```
    Specified by:
    
    createTravelDisutilityCalculator in interface MatsimServices
  - getLeastCostPathCalculatorFactory
```
public final LeastCostPathCalculatorFactory getLeastCostPathCalculatorFactory()
```
    Specified by:
    
    getLeastCostPathCalculatorFactory in interface MatsimServices
  - getScoringFunctionFactory
```
public final ScoringFunctionFactory getScoringFunctionFactory()
```
    Specified by:
    
    getScoringFunctionFactory in interface MatsimServices
  - getConfig
```
public final Config getConfig()
```
    Specified by:
    
    getConfig in interface MatsimServices
  - getScenario
```
public final Scenario getScenario()
```
    Specified by:
    
    getScenario in interface MatsimServices
  - getEvents
```
public final EventsManager getEvents()
```
    Specified by:
    
    getEvents in interface MatsimServices
  - getInjector
```
public final com.google.inject.Injector getInjector()
```
    Specified by:
    
    getInjector in interface MatsimServices
  - getLinkStats
```
@Deprecated
public final CalcLinkStats getLinkStats()
```
    Deprecated.
    Do not use this, as it may not contain values in every iteration
    
    Specified by:
    
    getLinkStats in interface MatsimServices
  - getVolumes
```
public final VolumesAnalyzer getVolumes()
```
    Specified by:
    
    getVolumes in interface MatsimServices
  - getScoreStats
```
public final ScoreStats getScoreStats()
```
    Specified by:
    
    getScoreStats in interface MatsimServices
  - getTravelDisutilityFactory
```
public final TravelDisutilityFactory getTravelDisutilityFactory()
```
    Specified by:
    
    getTravelDisutilityFactory in interface MatsimServices
  - getStrategyManager
```
@Deprecated
public final StrategyManager getStrategyManager()
```
    Deprecated.
    -- try to use services.addPlanStrategyFactory or services.addPlanSelectoryFactory. There are cases when this does not work, which is in particular necessary if you need to re-configure the StrategyManager during the iterations, and you cannot do this before the iterations start. In such cases, using this method may be ok. kai/mzilske, aug'14
    
    Specified by:
    
    getStrategyManager in interface MatsimServices
    
    Returns:
    
    Returns the StrategyManager used for the replanning of plans.
  - getControlerIO
```
public OutputDirectoryHierarchy getControlerIO()
```
    Specified by:
    
    getControlerIO in interface MatsimServices
  - getIterationNumber
```
public Integer getIterationNumber()
```
    Specified by:
    
    getIterationNumber in interface IterationCounter
  - addControlerListener
```
public void addControlerListener(ControlerListener controlerListener)
```
    Specified by:
    
    addControlerListener in interface MatsimServices
  - setScoringFunctionFactory
```
public final void setScoringFunctionFactory(ScoringFunctionFactory scoringFunctionFactory)
```
  - setTerminationCriterion
```
public final void setTerminationCriterion(TerminationCriterion terminationCriterion)
```
  - addOverridingModule
```
public final Controler addOverridingModule(AbstractModule abstractModule)
```
    Specified by:
    
    addOverridingModule in interface AllowsConfiguration
  - setModules
```
public final void setModules(AbstractModule... modules)
```
  - addOverridingQSimModule
```
public final Controler addOverridingQSimModule(AbstractQSimModule qsimModule)
```
    Specified by:
    
    addOverridingQSimModule in interface AllowsConfiguration
  - addQSimModule
```
public final Controler addQSimModule(AbstractQSimModule qsimModule)
```
    Specified by:
    
    addQSimModule in interface AllowsConfiguration
  - configureQSimComponents
```
public final Controler configureQSimComponents(QSimComponentsConfigurator configurator)
```
    Only use if you know what you are doing, for experts only.
    
    Specified by:
    
    configureQSimComponents in interface AllowsConfiguration

Modifier and Type	Field	Description
`static PatternLayout`	`DEFAULTLOG4JLAYOUT`
`static String`	`DIRECTORY_ITERS`
`static String`	`DIVIDER`

Class Controler

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DIRECTORY_ITERS

DIVIDER

DEFAULTLOG4JLAYOUT

Constructor Detail

Controler

Controler

Controler

Controler

Method Detail

getStopwatch

main

run

getLinkTravelTimes

getTripRouterProvider

createTravelDisutilityCalculator

getLeastCostPathCalculatorFactory

getScoringFunctionFactory

getConfig

getScenario

getEvents

getInjector

getLinkStats

getVolumes

getScoreStats

getTravelDisutilityFactory

getStrategyManager

getControlerIO

getIterationNumber

addControlerListener

setScoringFunctionFactory

setTerminationCriterion

addOverridingModule

setModules

addOverridingQSimModule

addQSimModule

configureQSimComponents