WithinDayConfigGroup (MATSim 12.0 API)

java.lang.Object
- org.matsim.core.config.ConfigGroup
- - org.matsim.core.config.ReflectiveConfigGroup
  - - org.matsim.withinday.controller.WithinDayConfigGroup

All Implemented Interfaces:: MatsimExtensionPoint

public final class WithinDayConfigGroup
extends ReflectiveConfigGroup

Author:: nagel

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class WithinDayConfigGroup.ShortTermPredictionMethod
- Nested classes/interfaces inherited from class org.matsim.core.config.ReflectiveConfigGroup
  ReflectiveConfigGroup.DoNotConvertNull, ReflectiveConfigGroup.InconsistentModuleException, ReflectiveConfigGroup.StringGetter, ReflectiveConfigGroup.StringSetter

Field Summary

Fields
Modifier and Type Field Description

static String GROUP_NAME

Constructor Summary

Constructors
Constructor Description

WithinDayConfigGroup()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Map<String,String>`	`getComments()`	Comments for parameters which setter get an enum type are automatically generated, containing a list of possible values.
`WithinDayConfigGroup.ShortTermPredictionMethod`	`getPredictionMethod()`	"method to predict travel times for the future"
`void`	`setPredictionMethod(WithinDayConfigGroup.ShortTermPredictionMethod predictionMethod)`	"method to predict travel times for the future"

Methods inherited from class org.matsim.core.config.ReflectiveConfigGroup
addParam, getParams, getValue

Methods inherited from class org.matsim.core.config.ConfigGroup
addParameterSet, addParameterToMap, checkConsistency, checkParameterSet, clearParameterSetsForType, createParameterSet, getInputFileURL, getName, getParameterSets, getParameterSets, isLocked, removeParameterSet, setLocked, testForLocked, toString

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

- Field Detail
  - GROUP_NAME
```
public static final String GROUP_NAME
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - WithinDayConfigGroup
```
public WithinDayConfigGroup()
```
- Method Detail
  - getPredictionMethod
```
public WithinDayConfigGroup.ShortTermPredictionMethod getPredictionMethod()
```
    "method to predict travel times for the future"
    
    Returns:
    
    the predictionMethod
  - setPredictionMethod
```
public void setPredictionMethod(WithinDayConfigGroup.ShortTermPredictionMethod predictionMethod)
```
    "method to predict travel times for the future"
    
    Parameters:
    
    predictionMethod - the predictionMethod to set
  - getComments
```
public Map<String,String> getComments()
```
    Description copied from class: ReflectiveConfigGroup
    
    Comments for parameters which setter get an enum type are automatically generated, containing a list of possible values. They can be overriden by subclasses without problems.
    it is recommended for subclasses to get this map using super.getComments() and fill it with additional comments, rather than generate an empty map.
    
    Overrides:
    
    getComments in class ReflectiveConfigGroup
    
    Returns:
    
    a Map containing description to some or all parameters return in ConfigGroup.getParams().