Package org.matsim.core.config.groups

Class PlanCalcScoreConfigGroup

java.lang.Object

org.matsim.core.config.ConfigGroup

org.matsim.core.config.groups.PlanCalcScoreConfigGroup

All Implemented Interfaces:

MatsimExtensionPoint

public final class PlanCalcScoreConfigGroup
extends ConfigGroup

Design decisions:

• I have decided to modify those setters/getters that do not use SI units such that the units are attached. This means all the utility parameters which are "per hour" instead of "per second". kai, dec'10
• Note that a similar thing is not necessary for money units since money units do not need to be specified (they are always implicit). kai, dec'10
• The parameter names in the config file are not changed in this way since this would mean a public api change. kai, dec'10

Author:

nagel

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PlanCalcScoreConfigGroup.ActivityParams
static class	PlanCalcScoreConfigGroup.ModeParams
static class	PlanCalcScoreConfigGroup.ScoringParameterSet
static class	PlanCalcScoreConfigGroup.TypicalDurationScoreComputation

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_SUBPOPULATION
static String	EXPERIENCED_PLAN_KEY	This is the key for customizable.
static String	GROUP_NAME

Constructor Summary

Constructors

Constructor	Description
PlanCalcScoreConfigGroup()

Method Summary

Modifier and Type	Method	Description
void	addActivityParams(PlanCalcScoreConfigGroup.ActivityParams params)
void	addModeParams(PlanCalcScoreConfigGroup.ModeParams params)
void	addParam(String key, String value)
void	addParameterSet(ConfigGroup set)
protected void	checkConsistency(Config config)	Check if the set values go well together.
protected void	checkParameterSet(ConfigGroup module)	Method called on parameter sets added by the add methods.
ConfigGroup	createParameterSet(String type)	Override if parameter sets of a certain type need a special implementation
static String	createStageActivityType(String mode)
Collection<PlanCalcScoreConfigGroup.ActivityParams>	getActivityParams()
PlanCalcScoreConfigGroup.ActivityParams	getActivityParams(String actType)
Collection<String>	getActivityTypes()
Collection<String>	getAllModes()
double	getBrainExpBeta()
Map<String,String>	getComments()
double	getEarlyDeparture_utils_hr()
Double	getFractionOfIterationsToStartScoreMSA()
double	getLateArrival_utils_hr()
double	getLearningRate()
double	getMarginalUtilityOfMoney()
double	getMarginalUtlOfWaiting_utils_hr()
double	getMarginalUtlOfWaitingPt_utils_hr()
Map<String,PlanCalcScoreConfigGroup.ModeParams>	getModes()
PlanCalcScoreConfigGroup.ModeParams	getOrCreateModeParams(String modeName)
PlanCalcScoreConfigGroup.ScoringParameterSet	getOrCreateScoringParameters(String subpopulation)
Map<String,String>	getParams()
double	getPathSizeLogitBeta()
double	getPerforming_utils_hr()
PlanCalcScoreConfigGroup.ScoringParameterSet	getScoringParameters(String subpopulation)
Map<String,PlanCalcScoreConfigGroup.ScoringParameterSet>	getScoringParametersPerSubpopulation()
double	getUtilityOfLineSwitch()
String	getValue(String key)
boolean	isMemorizingExperiencedPlans()
boolean	isUsingOldScoringBelowZeroUtilityDuration()
boolean	isWriteExperiencedPlans()
void	setBrainExpBeta(double brainExpBeta)
void	setEarlyDeparture_utils_hr(double earlyDeparture)
void	setFractionOfIterationsToStartScoreMSA(Double val)
void	setLateArrival_utils_hr(double lateArrival)
void	setLearningRate(double learningRate)
void	setLocked()
void	setMarginalUtilityOfMoney(double marginalUtilityOfMoney)
void	setMarginalUtlOfWaiting_utils_hr(double waiting)
void	setMarginalUtlOfWaitingPt_utils_hr(double val)
void	setMemorizingExperiencedPlans(boolean memorizingExperiencedPlans)
void	setPathSizeLogitBeta(double beta)
void	setPerforming_utils_hr(double performing)
void	setUsingOldScoringBelowZeroUtilityDuration(boolean usingOldScoringBelowZeroUtilityDuration)
void	setUtilityOfLineSwitch(double utilityOfLineSwitch)
void	setWriteExperiencedPlans(boolean writeExperiencedPlans)

Methods inherited from class org.matsim.core.config.ConfigGroup

addParameterToMap, clearParameterSetsForType, getInputFileURL, getName, getParameterSets, getParameterSets, isLocked, removeParameterSet, 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

EXPERIENCED_PLAN_KEY

public static final String EXPERIENCED_PLAN_KEY

This is the key for customizable. where should this go?

See Also:

Constant Field Values

DEFAULT_SUBPOPULATION

public static final String DEFAULT_SUBPOPULATION

See Also:

Constant Field Values

Constructor Detail

PlanCalcScoreConfigGroup

public PlanCalcScoreConfigGroup()

Method Detail

createStageActivityType

public static String createStageActivityType(String mode)

getValue

public String getValue(String key)

Overrides:

getValue in class ConfigGroup

addParam

public void addParam(String key,
                     String value)

Overrides:

addParam in class ConfigGroup

getOrCreateModeParams

public PlanCalcScoreConfigGroup.ModeParams getOrCreateModeParams(String modeName)

getParams

public Map<String,String> getParams()

Overrides:

getParams in class ConfigGroup

Returns:

a Map containing all parameters and their values known to this config group.

getComments

public final Map<String,String> getComments()

Overrides:

getComments in class ConfigGroup

Returns:

a Map containing description to some or all parameters return in ConfigGroup.getParams().

getActivityTypes

public Collection<String> getActivityTypes()

getAllModes

public Collection<String> getAllModes()

getActivityParams

public Collection<PlanCalcScoreConfigGroup.ActivityParams> getActivityParams()

getModes

public Map<String,PlanCalcScoreConfigGroup.ModeParams> getModes()

getScoringParametersPerSubpopulation

public Map<String,PlanCalcScoreConfigGroup.ScoringParameterSet> getScoringParametersPerSubpopulation()

getMarginalUtlOfWaitingPt_utils_hr

public double getMarginalUtlOfWaitingPt_utils_hr()

setMarginalUtlOfWaitingPt_utils_hr

public void setMarginalUtlOfWaitingPt_utils_hr(double val)

getActivityParams

public PlanCalcScoreConfigGroup.ActivityParams getActivityParams(String actType)

getScoringParameters

public PlanCalcScoreConfigGroup.ScoringParameterSet getScoringParameters(String subpopulation)

getOrCreateScoringParameters

public PlanCalcScoreConfigGroup.ScoringParameterSet getOrCreateScoringParameters(String subpopulation)

addParameterSet

public void addParameterSet(ConfigGroup set)

Overrides:

addParameterSet in class ConfigGroup

addModeParams

public void addModeParams(PlanCalcScoreConfigGroup.ModeParams params)

addActivityParams

public void addActivityParams(PlanCalcScoreConfigGroup.ActivityParams params)

createParameterSet

public ConfigGroup createParameterSet(String type)

Description copied from class: ConfigGroup

Override if parameter sets of a certain type need a special implementation

Overrides:

createParameterSet in class ConfigGroup

checkParameterSet

protected void checkParameterSet(ConfigGroup module)

Description copied from class: ConfigGroup

Method called on parameter sets added by the add methods. Can be extended if there are consistency checks to makes, for instance if parameter sets of a given type should be instances of a particular class.

Overrides:

checkParameterSet in class ConfigGroup

checkConsistency

protected final void checkConsistency(Config config)

Description copied from class: ConfigGroup

Check if the set values go well together. This method is usually called after reading the configuration from a file. If an inconsistency is found, a warning or error should be issued and (optionally) a RuntimeException being thrown.

Overrides:

checkConsistency in class ConfigGroup

Parameters:

config - TODO

isMemorizingExperiencedPlans

public boolean isMemorizingExperiencedPlans()

setMemorizingExperiencedPlans

public void setMemorizingExperiencedPlans(boolean memorizingExperiencedPlans)

getLearningRate

public double getLearningRate()

setLearningRate

public void setLearningRate(double learningRate)

getBrainExpBeta

public double getBrainExpBeta()

setBrainExpBeta

public void setBrainExpBeta(double brainExpBeta)

getPathSizeLogitBeta

public double getPathSizeLogitBeta()

setPathSizeLogitBeta

public void setPathSizeLogitBeta(double beta)

getLateArrival_utils_hr

public double getLateArrival_utils_hr()

setLateArrival_utils_hr

public void setLateArrival_utils_hr(double lateArrival)

getEarlyDeparture_utils_hr

public double getEarlyDeparture_utils_hr()

setEarlyDeparture_utils_hr

public void setEarlyDeparture_utils_hr(double earlyDeparture)

getPerforming_utils_hr

public double getPerforming_utils_hr()

setPerforming_utils_hr

public void setPerforming_utils_hr(double performing)

getMarginalUtilityOfMoney

public double getMarginalUtilityOfMoney()

setMarginalUtilityOfMoney

public void setMarginalUtilityOfMoney(double marginalUtilityOfMoney)

getUtilityOfLineSwitch

public double getUtilityOfLineSwitch()

setUtilityOfLineSwitch

public void setUtilityOfLineSwitch(double utilityOfLineSwitch)

isUsingOldScoringBelowZeroUtilityDuration

public boolean isUsingOldScoringBelowZeroUtilityDuration()

setUsingOldScoringBelowZeroUtilityDuration

public void setUsingOldScoringBelowZeroUtilityDuration(boolean usingOldScoringBelowZeroUtilityDuration)

isWriteExperiencedPlans

public boolean isWriteExperiencedPlans()

setWriteExperiencedPlans

public void setWriteExperiencedPlans(boolean writeExperiencedPlans)

getMarginalUtlOfWaiting_utils_hr

public double getMarginalUtlOfWaiting_utils_hr()

setMarginalUtlOfWaiting_utils_hr

public void setMarginalUtlOfWaiting_utils_hr(double waiting)

setFractionOfIterationsToStartScoreMSA

public void setFractionOfIterationsToStartScoreMSA(Double val)

getFractionOfIterationsToStartScoreMSA

public Double getFractionOfIterationsToStartScoreMSA()

setLocked

public final void setLocked()

Overrides:

setLocked in class ConfigGroup