org.matsim.core.config.groups.StrategyConfigGroup Class Reference

Inheritance diagram for org.matsim.core.config.groups.StrategyConfigGroup:

Classes
class	ReflectiveDelegate
class	StrategySettings

Public Member Functions
	StrategyConfigGroup ()
String	getValue (final String key)
void	addParam (final String key, final String value)
final Map< String, String >	getComments ()
ConfigGroup	createParameterSet (final String type)
void	addStrategySettings (final StrategySettings stratSets)
final void	clearStrategySettings ()
Collection< StrategySettings >	getStrategySettings ()
void	setMaxAgentPlanMemorySize (int maxAgentPlanMemorySize)
int	getMaxAgentPlanMemorySize ()
void	setExternalExeConfigTemplate (String externalExeConfigTemplate)
String	getExternalExeConfigTemplate ()
void	setExternalExeTmpFileRootDir (String externalExeTmpFileRootDir)
String	getExternalExeTmpFileRootDir ()
void	setExternalExeTimeOut (long externalExeTimeOut)
long	getExternalExeTimeOut ()
String	getPlanSelectorForRemoval ()
void	setPlanSelectorForRemoval (String planSelectorForRemoval)
double	getFractionOfIterationsToDisableInnovation ()
void	setFractionOfIterationsToDisableInnovation (double fraction)
final Map< String, String >	getParams ()
final String	getName ()
final String	toString ()
void	addParameterSet (final ConfigGroup set)
boolean	removeParameterSet (final ConfigGroup set)
final Collection<? extends ConfigGroup >	getParameterSets (final String type)
final Map< String, ? extends Collection<? extends ConfigGroup > >	getParameterSets ()
final boolean	isLocked ()
void	setLocked ()
final void	testForLocked ()

Static Public Member Functions
static URL	getInputFileURL (URL context, String filename)

Static Public Attributes
static final String	GROUP_NAME = "strategy"

Protected Member Functions
void	checkParameterSet (final ConfigGroup set)
void	checkConsistency (Config config)
void	addParameterToMap (final Map< String, String > map, final String paramName)
final Collection<? extends ConfigGroup >	clearParameterSetsForType (final String type)

Private Member Functions
StrategySettings	getStrategySettings (final Id< StrategySettings > index, final boolean createIfMissing)

Private Attributes
final ReflectiveDelegate	delegate = new ReflectiveDelegate()

Static Private Attributes
static final String	MODULE = "Module_"
static final String	MODULE_PROBABILITY = "ModuleProbability_"
static final String	MODULE_DISABLE_AFTER_ITERATION = "ModuleDisableAfterIteration_"
static final String	MODULE_EXE_PATH = "ModuleExePath_"
static final String	MODULE_SUBPOPULATION = "ModuleSubpopulation_"

Detailed Description

Configuration group for specifying the plans-replanning to be used. It can still be specified using the "underscored" way, but can only be written in hierarchical format "v2". Trying to write v1 will result in the strategy settings being silently lost!

Author

mrieser

Definition at line 44 of file StrategyConfigGroup.java.

Constructor & Destructor Documentation

StrategyConfigGroup()

org.matsim.core.config.groups.StrategyConfigGroup.StrategyConfigGroup

(

)

Definition at line 207 of file StrategyConfigGroup.java.

References org.matsim.core.config.groups.StrategyConfigGroup.GROUP_NAME.

                                 {
        super(GROUP_NAME);
    }

Member Function Documentation

getValue()

String org.matsim.core.config.groups.StrategyConfigGroup.getValue

(

final String

key

)

Definition at line 212 of file StrategyConfigGroup.java.

References org.matsim.core.config.groups.StrategyConfigGroup.delegate, org.matsim.core.config.ReflectiveConfigGroup.getValue(), org.matsim.core.config.groups.StrategyConfigGroup.MODULE, org.matsim.core.config.groups.StrategyConfigGroup.MODULE_DISABLE_AFTER_ITERATION, org.matsim.core.config.groups.StrategyConfigGroup.MODULE_EXE_PATH, org.matsim.core.config.groups.StrategyConfigGroup.MODULE_PROBABILITY, and org.matsim.core.config.groups.StrategyConfigGroup.MODULE_SUBPOPULATION.

                                             {
        // first check if the parameter is in "underscored" form
        if ( key.startsWith(MODULE)
                || key.startsWith(MODULE_PROBABILITY)
                || key.startsWith(MODULE_DISABLE_AFTER_ITERATION)
                || key.startsWith(MODULE_EXE_PATH)
                || key.startsWith(MODULE_SUBPOPULATION) ) {
            throw new IllegalArgumentException( "getting underscored parameter "+key+" is not allowed anymore. The supported way to get those parameters is via parameter sets." );
        }

        return delegate.getValue( key );
    }

Here is the call graph for this function:

addParam()

void org.matsim.core.config.groups.StrategyConfigGroup.addParam	(	final String	key,
		final String	value
	)

Definition at line 226 of file StrategyConfigGroup.java.

References org.matsim.core.config.ReflectiveConfigGroup.addParam(), org.matsim.api.core.v01.Id< T >.create(), org.matsim.core.config.groups.StrategyConfigGroup.delegate, org.matsim.core.config.groups.StrategyConfigGroup.getStrategySettings(), org.matsim.core.config.groups.StrategyConfigGroup.MODULE, org.matsim.core.config.groups.StrategyConfigGroup.MODULE_DISABLE_AFTER_ITERATION, org.matsim.core.config.groups.StrategyConfigGroup.MODULE_EXE_PATH, org.matsim.core.config.groups.StrategyConfigGroup.MODULE_PROBABILITY, org.matsim.core.config.groups.StrategyConfigGroup.MODULE_SUBPOPULATION, and org.matsim.core.config.groups.StrategyConfigGroup.StrategySettings.setDisableAfter().

                                                               {
        // adding underscore parameters is still supported for backward compatibility.
        if (key != null && key.startsWith(MODULE)) {
            StrategySettings settings = getStrategySettings(Id.create(key.substring(MODULE.length()), StrategySettings.class), true);
            settings.addParam( "strategyName" , value);
        }
        else if (key != null && key.startsWith(MODULE_PROBABILITY)) {
            StrategySettings settings = getStrategySettings(Id.create(key.substring(MODULE_PROBABILITY.length()), StrategySettings.class), true);
            settings.addParam( "weight" , value );
        }
        else if (key != null && key.startsWith(MODULE_DISABLE_AFTER_ITERATION)) {
            StrategySettings settings = getStrategySettings(Id.create(key.substring(MODULE_DISABLE_AFTER_ITERATION.length()), StrategySettings.class), true);
            settings.setDisableAfter(Integer.parseInt(value));
            settings.addParam( "disableAfterIteration" , value );
        }
        else if (key != null && key.startsWith(MODULE_EXE_PATH)) {
            StrategySettings settings = getStrategySettings(Id.create(key.substring(MODULE_EXE_PATH.length()), StrategySettings.class), true);
            settings.addParam( "executionPath" , value );
        }
        else if (key != null && key.startsWith(MODULE_SUBPOPULATION)) {
            StrategySettings settings = getStrategySettings(Id.create(key.substring(MODULE_SUBPOPULATION.length()), StrategySettings.class), true);
            settings.addParam( "subpopulation" , value );
        }
        else {
            delegate.addParam( key , value );
        }
    }

Here is the call graph for this function:

getStrategySettings() [1/2]

StrategySettings org.matsim.core.config.groups.StrategyConfigGroup.getStrategySettings ( final Id< StrategySettings >  index, final boolean  createIfMissing  )

private

Definition at line 254 of file StrategyConfigGroup.java.

References org.matsim.core.config.groups.StrategyConfigGroup.addStrategySettings(), org.matsim.core.config.groups.StrategyConfigGroup.getStrategySettings(), and org.matsim.core.config.groups.StrategyConfigGroup.StrategySettings.StrategySettings().

Referenced by org.matsim.core.config.consistency.VspConfigConsistencyCheckerImpl.checkStrategyConfigGroup(), org.matsim.core.config.ConfigUtils.createAvailableStrategyId(), org.matsim.core.replanning.annealing.ReplanningAnnealer.getInnovationStop(), org.matsim.core.replanning.annealing.ReplanningAnnealer.getStrategyWeights(), org.matsim.core.replanning.strategies.DefaultPlanStrategiesModule.install(), org.matsim.core.replanning.annealing.ReplanningAnnealer.notifyStartup(), and org.matsim.core.replanning.annealing.ReplanningAnnealer.rescaleStartupWeights().

                                                                                                                  {
        StrategySettings settings = null;

        // should be in a map, but it is difficult to keep consistency with the
        // delegate...
        for ( StrategySettings s : getStrategySettings() ) {
            if ( !s.getId().equals( index ) ) continue;
            if ( settings != null ) throw new IllegalStateException( "several settings with id "+index );
            settings = s;
        }

        if (settings == null && createIfMissing) {
            settings = new StrategySettings(index);
            addStrategySettings( settings );
        }

        return settings;
    }

Here is the call graph for this function:

getComments()

final Map<String, String> org.matsim.core.config.groups.StrategyConfigGroup.getComments

(

)

Definition at line 276 of file StrategyConfigGroup.java.

References org.matsim.core.config.ConfigGroup.name.

                                                   {
        Map<String,String> map = super.getComments();
        map.put(ReflectiveDelegate.ITERATION_FRACTION_TO_DISABLE_INNOVATION, "fraction of iterations where innovative strategies are switched off.  Something like 0.8 should be good.  E.g. if you run from iteration 400 to iteration 500, innovation is switched off at iteration 480" ) ;
        map.put(ReflectiveDelegate.MAX_AGENT_PLAN_MEMORY_SIZE, "maximum number of plans per agent.  ``0'' means ``infinity''.  Currently (2010), ``5'' is a good number");

        StringBuilder strb = new StringBuilder() ;
        for ( DefaultPlansRemover name : DefaultPlansRemover.values() ) {
            strb.append( name.toString() + " " ) ;
        }
        map.put(ReflectiveDelegate.PLAN_SELECTOR_FOR_REMOVAL,"strategyName of PlanSelector for plans removal.  "
                + "Possible defaults: " + strb.toString() + ". The current default, WorstPlanSelector is not a good " +
                "choice from a discrete choice theoretical perspective. Alternatives, however, have not been systematically " +
                "tested. kai, feb'12") ;
        
        map.put(ReflectiveDelegate.EXTERNAL_EXE_CONFIG_TEMPLATE,"the external executable will be called with a config file as argument.  This is the pathname to a possible "
                + "skeleton config, to which additional information will be added.  Can be null.");
        map.put(ReflectiveDelegate.EXTERNAL_EXE_TMP_FILE_ROOT_DIR, "root directory for temporary files generated by the external executable. Provided as a service; "
                + "I don't think this is used by MATSim.") ;
        map.put(ReflectiveDelegate.EXTERNAL_EXE_TIME_OUT, "time out value (in seconds) after which matsim will consider the external strategy as failed") ;
        return map ;
    }

checkParameterSet()

void org.matsim.core.config.groups.StrategyConfigGroup.checkParameterSet ( final ConfigGroup  set )

protected

Definition at line 299 of file StrategyConfigGroup.java.

References org.matsim.core.config.ConfigGroup.getName(), and org.matsim.core.config.groups.StrategyConfigGroup.StrategySettings.SET_NAME.

                                                            {
        switch ( set.getName() ) {
            case StrategySettings.SET_NAME:
                if ( !(set instanceof StrategySettings) ) {
                    throw new RuntimeException( set+" is not an instance of StrategySettings" );
                }
                break;
            default:
                throw new IllegalArgumentException( "unknown set type "+set.getName() );
        }
    }

Here is the call graph for this function:

createParameterSet()

ConfigGroup org.matsim.core.config.groups.StrategyConfigGroup.createParameterSet

(

final String

type

)

Definition at line 312 of file StrategyConfigGroup.java.

References org.matsim.core.config.groups.StrategyConfigGroup.StrategySettings.SET_NAME, and org.matsim.core.config.groups.StrategyConfigGroup.StrategySettings.StrategySettings().

                                                             {
        switch ( type ) {
            case StrategySettings.SET_NAME:
                return new StrategySettings( );
            default:
                throw new IllegalArgumentException( "unknown set type "+type );
        }
    }

Here is the call graph for this function:

addStrategySettings()

void org.matsim.core.config.groups.StrategyConfigGroup.addStrategySettings

(

final StrategySettings

stratSets

)

Adds the StrategySettings given as parameter to the map storing the settings for the strategies. An IllegalArgumentException is thrown, if a StrategySEttings instance with the id of the parameter already exists in the map.

Parameters

stratSets

Definition at line 328 of file StrategyConfigGroup.java.

References org.matsim.core.config.ConfigGroup.addParameterSet().

Referenced by org.matsim.core.config.groups.StrategyConfigGroup.getStrategySettings().

                                                                      {
        addParameterSet( stratSets );
    }

Here is the call graph for this function:

clearStrategySettings()

final void org.matsim.core.config.groups.StrategyConfigGroup.clearStrategySettings

(

)

Definition at line 332 of file StrategyConfigGroup.java.

References org.matsim.core.config.ConfigGroup.clearParameterSetsForType(), and org.matsim.core.config.groups.StrategyConfigGroup.StrategySettings.SET_NAME.

                                              {
        this.clearParameterSetsForType( StrategySettings.SET_NAME ) ;
    }

Here is the call graph for this function:

getStrategySettings() [2/2]

Collection<StrategySettings> org.matsim.core.config.groups.StrategyConfigGroup.getStrategySettings

(

)

Definition at line 336 of file StrategyConfigGroup.java.

References org.matsim.core.config.ConfigGroup.getParameterSets(), and org.matsim.core.config.groups.StrategyConfigGroup.StrategySettings.SET_NAME.

Referenced by org.matsim.core.config.groups.StrategyConfigGroup.addParam(), and org.matsim.core.config.groups.StrategyConfigGroup.getStrategySettings().

                                                              {
        // This does look pretty wrong, but is actually OK,
        // as the checkParameterSet method checks that strategy settings
        // parameter sets which are added have the proper type.
        // A cleaner solution would be nice, though... td, sep'14
        return (Collection<StrategySettings>) getParameterSets(StrategySettings.SET_NAME);
    }

Here is the call graph for this function:

checkConsistency()

void org.matsim.core.config.groups.StrategyConfigGroup.checkConsistency ( Config  config )

protected

Definition at line 345 of file StrategyConfigGroup.java.

                                                   {
        // to make available to tests
        super.checkConsistency(config);
    }

setMaxAgentPlanMemorySize()

void org.matsim.core.config.groups.StrategyConfigGroup.setMaxAgentPlanMemorySize

(

int

maxAgentPlanMemorySize

)

Definition at line 350 of file StrategyConfigGroup.java.

References org.matsim.core.config.groups.StrategyConfigGroup.delegate, and org.matsim.core.config.groups.StrategyConfigGroup.ReflectiveDelegate.setMaxAgentPlanMemorySize().

                                                                      {
        delegate.setMaxAgentPlanMemorySize(maxAgentPlanMemorySize);
    }

Here is the call graph for this function:

getMaxAgentPlanMemorySize()

int org.matsim.core.config.groups.StrategyConfigGroup.getMaxAgentPlanMemorySize

(

)

Definition at line 354 of file StrategyConfigGroup.java.

References org.matsim.core.config.groups.StrategyConfigGroup.delegate, and org.matsim.core.config.groups.StrategyConfigGroup.ReflectiveDelegate.getMaxAgentPlanMemorySize().

                                           {
        return delegate.getMaxAgentPlanMemorySize();
    }

Here is the call graph for this function:

setExternalExeConfigTemplate()

void org.matsim.core.config.groups.StrategyConfigGroup.setExternalExeConfigTemplate

(

String

externalExeConfigTemplate

)

Definition at line 358 of file StrategyConfigGroup.java.

References org.matsim.core.config.groups.StrategyConfigGroup.delegate, and org.matsim.core.config.groups.StrategyConfigGroup.ReflectiveDelegate.setExternalExeConfigTemplate().

                                                                               {
        delegate.setExternalExeConfigTemplate(externalExeConfigTemplate);
    }

Here is the call graph for this function:

getExternalExeConfigTemplate()

String org.matsim.core.config.groups.StrategyConfigGroup.getExternalExeConfigTemplate

(

)

Definition at line 362 of file StrategyConfigGroup.java.

References org.matsim.core.config.groups.StrategyConfigGroup.delegate, and org.matsim.core.config.groups.StrategyConfigGroup.ReflectiveDelegate.getExternalExeConfigTemplate().

Referenced by org.matsim.core.replanning.modules.ExternalModule.prepareExternalExeConfig().

                                                 {
        return delegate.getExternalExeConfigTemplate();
    }

Here is the call graph for this function:

setExternalExeTmpFileRootDir()

void org.matsim.core.config.groups.StrategyConfigGroup.setExternalExeTmpFileRootDir

(

String

externalExeTmpFileRootDir

)

Definition at line 366 of file StrategyConfigGroup.java.

References org.matsim.core.config.groups.StrategyConfigGroup.delegate, and org.matsim.core.config.groups.StrategyConfigGroup.ReflectiveDelegate.setExternalExeTmpFileRootDir().

                                                                               {
        delegate.setExternalExeTmpFileRootDir(externalExeTmpFileRootDir);
    }

Here is the call graph for this function:

getExternalExeTmpFileRootDir()

String org.matsim.core.config.groups.StrategyConfigGroup.getExternalExeTmpFileRootDir

(

)

Definition at line 370 of file StrategyConfigGroup.java.

References org.matsim.core.config.groups.StrategyConfigGroup.delegate, and org.matsim.core.config.groups.StrategyConfigGroup.ReflectiveDelegate.getExternalExeTmpFileRootDir().

                                                 {
        return delegate.getExternalExeTmpFileRootDir();
    }

Here is the call graph for this function:

setExternalExeTimeOut()

void org.matsim.core.config.groups.StrategyConfigGroup.setExternalExeTimeOut

(

long

externalExeTimeOut

)

Definition at line 374 of file StrategyConfigGroup.java.

References org.matsim.core.config.groups.StrategyConfigGroup.delegate, and org.matsim.core.config.groups.StrategyConfigGroup.ReflectiveDelegate.setExternalExeTimeOut().

                                                               {
        delegate.setExternalExeTimeOut(externalExeTimeOut);
    }

Here is the call graph for this function:

getExternalExeTimeOut()

long org.matsim.core.config.groups.StrategyConfigGroup.getExternalExeTimeOut

(

)

Definition at line 378 of file StrategyConfigGroup.java.

References org.matsim.core.config.groups.StrategyConfigGroup.delegate, and org.matsim.core.config.groups.StrategyConfigGroup.ReflectiveDelegate.getExternalExeTimeOut().

                                        {
        return delegate.getExternalExeTimeOut();
    }

Here is the call graph for this function:

getPlanSelectorForRemoval()

String org.matsim.core.config.groups.StrategyConfigGroup.getPlanSelectorForRemoval

(

)

Definition at line 382 of file StrategyConfigGroup.java.

References org.matsim.core.config.groups.StrategyConfigGroup.delegate, and org.matsim.core.config.groups.StrategyConfigGroup.ReflectiveDelegate.getPlanSelectorForRemoval().

                                              {
        return delegate.getPlanSelectorForRemoval();
    }

Here is the call graph for this function:

setPlanSelectorForRemoval()

void org.matsim.core.config.groups.StrategyConfigGroup.setPlanSelectorForRemoval

(

String

planSelectorForRemoval

)

Definition at line 386 of file StrategyConfigGroup.java.

References org.matsim.core.config.groups.StrategyConfigGroup.delegate, and org.matsim.core.config.groups.StrategyConfigGroup.ReflectiveDelegate.setPlanSelectorForRemoval().

                                                                         {
        switch ( planSelectorForRemoval ) {
        case "SelectExpBeta" :
            throw new RuntimeException("'SelectExpBeta' was replaced by 'SelectExpBetaForRemoval' in the plans removal setting" ) ;
        case "ChangeExpBeta" :
            throw new RuntimeException("'ChangeExpBeta' was replaced by 'ChangeExpBetaForRemoval' in the plans removal setting" ) ;
        case "PathSizeLogitSelector" :
            throw new RuntimeException("'PathSizeLogitSelector' was replaced by 'PathSizeLogitSelectorForRemoval' in the plans removal setting" ) ;
        default: 
            delegate.setPlanSelectorForRemoval(planSelectorForRemoval) ;
        }
    }

Here is the call graph for this function:

getFractionOfIterationsToDisableInnovation()

double org.matsim.core.config.groups.StrategyConfigGroup.getFractionOfIterationsToDisableInnovation

(

)

Definition at line 399 of file StrategyConfigGroup.java.

References org.matsim.core.config.groups.StrategyConfigGroup.delegate, and org.matsim.core.config.groups.StrategyConfigGroup.ReflectiveDelegate.getFractionOfIterationsToDisableInnovation().

Referenced by org.matsim.core.config.consistency.VspConfigConsistencyCheckerImpl.checkStrategyConfigGroup(), and org.matsim.core.replanning.annealing.ReplanningAnnealer.getInnovationStop().

                                                               {
        return delegate.getFractionOfIterationsToDisableInnovation();
    }

Here is the call graph for this function:

setFractionOfIterationsToDisableInnovation()

void org.matsim.core.config.groups.StrategyConfigGroup.setFractionOfIterationsToDisableInnovation

(

double

fraction

)

Definition at line 403 of file StrategyConfigGroup.java.

References org.matsim.core.config.groups.StrategyConfigGroup.delegate, and org.matsim.core.config.groups.StrategyConfigGroup.ReflectiveDelegate.setFractionOfIterationsToDisableInnovation().

                                                                            {
        delegate.setFractionOfIterationsToDisableInnovation(fraction);
    }

Here is the call graph for this function:

getParams()

final Map<String, String> org.matsim.core.config.groups.StrategyConfigGroup.getParams

(

)

Definition at line 408 of file StrategyConfigGroup.java.

References org.matsim.core.config.groups.StrategyConfigGroup.delegate, and org.matsim.core.config.ReflectiveConfigGroup.getParams().

                                                 {
        return delegate.getParams();
    }

Here is the call graph for this function:

addParameterToMap()

void org.matsim.core.config.ConfigGroup.addParameterToMap ( final Map< String, String >  map, final String  paramName  )

protectedinherited

Little helper for subclasses (i.e. the ConfigGroups). This method adds the value of the parameter to the given map only if the getValue() method of this Module doesn't return null (Java null-type) or the String representation of null, i.e. "null" or "NULL". If the value is null, the string "null" is added to the map to document the parameter.

Parameters

map
paramName

Definition at line 81 of file ConfigGroup.java.

References org.matsim.core.config.ConfigGroup.getValue().

Referenced by org.matsim.core.config.ReflectiveConfigGroup.getParams().

                                                                                            {
        String value = this.getValue(paramName);
        if (!((value == null) || value.equalsIgnoreCase("null"))) {
            map.put(paramName, value);
        } else {
            map.put(paramName, "null");
        }
    }

Here is the call graph for this function:

getName()

final String org.matsim.core.config.ConfigGroup.getName ( )

inherited

Definition at line 111 of file ConfigGroup.java.

References org.matsim.core.config.ConfigGroup.name.

Referenced by org.matsim.core.config.Config.addModule(), org.matsim.core.config.ReflectiveConfigGroup.addParam(), org.matsim.core.replanning.annealing.ReplanningAnnealerConfigGroup.addParameterSet(), org.matsim.core.config.groups.TimeAllocationMutatorConfigGroup.addParameterSet(), org.matsim.core.config.ConfigGroup.addParameterSet(), ch.sbb.matsim.config.SwissRailRaptorConfigGroup.addParameterSet(), org.matsim.core.config.groups.PlansCalcRouteConfigGroup.addParameterSet(), org.matsim.core.config.groups.PlanCalcScoreConfigGroup.addParameterSet(), org.matsim.core.replanning.annealing.ReplanningAnnealerConfigGroup.checkParameterSet(), org.matsim.core.config.groups.StrategyConfigGroup.checkParameterSet(), org.matsim.core.config.groups.PlansCalcRouteConfigGroup.checkParameterSet(), org.matsim.core.config.groups.PlanCalcScoreConfigGroup.checkParameterSet(), org.matsim.core.config.groups.PlanCalcScoreConfigGroup.ScoringParameterSet.checkParameterSet(), org.matsim.core.config.ReflectiveConfigGroup.getValue(), org.matsim.core.config.ConfigGroup.removeParameterSet(), org.matsim.run.OldToNewPlanCalcScoreConfigGroup.ModeParams.setMonetaryDistanceRate(), and org.matsim.core.config.ConfigGroup.toString().

                                  {
        return this.name;
    }

toString()

final String org.matsim.core.config.ConfigGroup.toString ( )

inherited

Definition at line 128 of file ConfigGroup.java.

References org.matsim.core.config.ConfigGroup.getName(), and org.matsim.core.config.ConfigGroup.getParams().

Referenced by org.matsim.core.config.ConfigGroup.addParam(), org.matsim.core.config.groups.SubtourModeChoiceConfigGroup.getChainBaseModesString(), org.matsim.core.config.groups.ChangeModeConfigGroup.getModesString(), org.matsim.core.config.groups.SubtourModeChoiceConfigGroup.getModesString(), org.matsim.core.config.ReflectiveConfigGroup.getParamField(), org.matsim.core.config.groups.PlansCalcRouteConfigGroup.getParams(), and org.matsim.core.config.ReflectiveConfigGroup.invokeGetter().

                                   {
        StringBuilder str = new StringBuilder();
        for ( Entry<String, String> entry : this.getParams().entrySet() ) {
            str.append('[');
            str.append(entry.getKey());
            str.append('=');
            str.append(entry.getValue());
            str.append(']');
        }
        return "[name=" + this.getName() + "]" +
                "[nOfParams=" + this.getParams().size() + "]" + str.toString();
    }

Here is the call graph for this function:

addParameterSet()

void org.matsim.core.config.ConfigGroup.addParameterSet ( final ConfigGroup  set )

inherited

Definition at line 166 of file ConfigGroup.java.

References org.matsim.core.config.ConfigGroup.checkParameterSet(), and org.matsim.core.config.ConfigGroup.getName().

Referenced by org.matsim.core.config.groups.PlansCalcRouteConfigGroup.addParameterSet(), org.matsim.core.config.groups.StrategyConfigGroup.addStrategySettings(), org.matsim.core.config.groups.PlansCalcRouteConfigGroup.addTeleportedModeParams(), org.matsim.core.config.Config.copyTo(), org.matsim.core.config.groups.PlanCalcScoreConfigGroup.ScoringParameterSet.getOrCreateModeParams(), org.matsim.core.config.groups.PlansCalcRouteConfigGroup.getOrCreateModeRoutingParams(), org.matsim.core.config.groups.PlansCalcRouteConfigGroup.PlansCalcRouteConfigGroup(), org.matsim.core.config.groups.PlansCalcRouteConfigGroup.setTeleportedModeFreespeedFactor(), and org.matsim.core.config.groups.PlansCalcRouteConfigGroup.setTeleportedModeSpeed().

                                                       {
        checkParameterSet( set );
        Collection<ConfigGroup> parameterSets = parameterSetsPerType.get( set.getName() );

        if ( parameterSets == null ) {
            parameterSets = new ArrayList<>();
            parameterSetsPerType.put( set.getName() ,  parameterSets );
        }

        parameterSets.add( set );
    }

Here is the call graph for this function:

removeParameterSet()

boolean org.matsim.core.config.ConfigGroup.removeParameterSet ( final ConfigGroup  set )

inherited

Definition at line 178 of file ConfigGroup.java.

References org.matsim.core.config.ConfigGroup.getName().

Referenced by org.matsim.core.config.groups.PlanCalcScoreConfigGroup.ScoringParameterSet.addActivityParams(), org.matsim.core.replanning.annealing.ReplanningAnnealerConfigGroup.addAnnealingVariable(), org.matsim.core.config.groups.PlanCalcScoreConfigGroup.ScoringParameterSet.addModeParams(), org.matsim.core.config.groups.PlanCalcScoreConfigGroup.addParam(), org.matsim.core.config.groups.PlanCalcScoreConfigGroup.addScoringParameters(), org.matsim.core.replanning.annealing.ReplanningAnnealer.notifyStartup(), and org.matsim.core.config.groups.PlansCalcRouteConfigGroup.removeModeRoutingParams().

                                                               {
        final Collection<ConfigGroup> parameterSets = parameterSetsPerType.get( set.getName() );
        return parameterSets != null ?
            parameterSets.remove( set ) :
            false;
    }

Here is the call graph for this function:

clearParameterSetsForType()

final Collection<? extends ConfigGroup> org.matsim.core.config.ConfigGroup.clearParameterSetsForType ( final String  type )

protectedinherited

Useful for instance if default values are provided but should be cleared if user provides values.

Definition at line 200 of file ConfigGroup.java.

Referenced by org.matsim.core.config.groups.PlansCalcRouteConfigGroup.addParameterSet(), org.matsim.core.config.groups.PlansCalcRouteConfigGroup.clearModeRoutingParams(), and org.matsim.core.config.groups.StrategyConfigGroup.clearStrategySettings().

                                                                                                     {
        return parameterSetsPerType.remove( type );
    }

getParameterSets() [1/2]

final Collection<? extends ConfigGroup> org.matsim.core.config.ConfigGroup.getParameterSets ( final String  type )

inherited

Definition at line 204 of file ConfigGroup.java.

Referenced by org.matsim.core.config.Config.copyTo().

                                                                                       {
        final Collection<ConfigGroup> sets = parameterSetsPerType.get( type );
        return sets == null ?
            Collections.<ConfigGroup>emptySet() :
            Collections.unmodifiableCollection( sets );
    }

getParameterSets() [2/2]

final Map<String, ? extends Collection<? extends ConfigGroup> > org.matsim.core.config.ConfigGroup.getParameterSets ( )

inherited

Definition at line 211 of file ConfigGroup.java.

Referenced by org.matsim.core.config.ConfigGroup.checkConsistency(), org.matsim.core.config.groups.PlanCalcScoreConfigGroup.ScoringParameterSet.getActivityParams(), org.matsim.core.replanning.annealing.ReplanningAnnealerConfigGroup.getAnnealingVariables(), org.matsim.core.config.groups.PlansCalcRouteConfigGroup.getModeRoutingParams(), org.matsim.core.config.groups.PlanCalcScoreConfigGroup.ScoringParameterSet.getModes(), org.matsim.core.config.groups.PlanCalcScoreConfigGroup.getScoringParametersPerSubpopulation(), org.matsim.core.config.groups.StrategyConfigGroup.getStrategySettings(), org.matsim.core.config.groups.TimeAllocationMutatorConfigGroup.getTimeAllocationMutatorSubpopulationSettings(), and org.matsim.core.config.groups.PlansCalcRouteConfigGroup.removeModeRoutingParams().

                                                                                             {
        // TODO: immutabilize (including lists)
        // maybe done with what I did below?  kai, sep'16
        
        //      return parameterSetsPerType;
        
        Map<String, Collection<ConfigGroup>> parameterSetsPerType2 = new TreeMap<>() ;
        for ( Entry<String, Collection<ConfigGroup>> entry : parameterSetsPerType.entrySet() ) {
            parameterSetsPerType2.put( entry.getKey(), Collections.unmodifiableCollection(entry.getValue()) ) ;
        }
        return Collections.unmodifiableMap( parameterSetsPerType2 ) ;
    }

isLocked()

final boolean org.matsim.core.config.ConfigGroup.isLocked ( )

inherited

Definition at line 224 of file ConfigGroup.java.

References org.matsim.core.config.ConfigGroup.locked.

Referenced by org.matsim.core.config.groups.PlanCalcScoreConfigGroup.ScoringParameterSet.getActivityParams(), org.matsim.core.config.groups.PlansCalcRouteConfigGroup.getBeelineDistanceFactors(), org.matsim.core.config.groups.PlansCalcRouteConfigGroup.getModeRoutingParams(), org.matsim.core.config.groups.PlanCalcScoreConfigGroup.ScoringParameterSet.getModes(), org.matsim.core.config.groups.PlansCalcRouteConfigGroup.getOrCreateModeRoutingParams(), org.matsim.core.config.groups.PlanCalcScoreConfigGroup.getScoringParametersPerSubpopulation(), org.matsim.core.config.groups.PlansCalcRouteConfigGroup.getTeleportedModeFreespeedFactors(), and org.matsim.core.config.groups.PlansCalcRouteConfigGroup.getTeleportedModeSpeeds().

                                    {
        return locked;
    }

setLocked()

void org.matsim.core.config.ConfigGroup.setLocked ( )

inherited

Definition at line 228 of file ConfigGroup.java.

Referenced by org.matsim.core.controler.Controler.Controler(), org.matsim.core.config.groups.PlansCalcRouteConfigGroup.getOrCreateModeRoutingParams(), org.matsim.core.config.groups.PlanCalcScoreConfigGroup.setLocked(), and org.matsim.pt.router.TransitRouterConfig.TransitRouterConfig().

                            {
        // need to have this non-final to be able to override in order to set delegates.  kai, jun'15
        this.locked = true ;
        for ( Collection<ConfigGroup> parameterSets : this.parameterSetsPerType.values() ) {
            for ( ConfigGroup parameterSet : parameterSets ) {
                parameterSet.setLocked(); 
            }
        }
    }

testForLocked()

final void org.matsim.core.config.ConfigGroup.testForLocked ( )

inherited

Definition at line 238 of file ConfigGroup.java.

Referenced by org.matsim.core.config.groups.PlanCalcScoreConfigGroup.addParam(), org.matsim.core.config.groups.PlansCalcRouteConfigGroup.addTeleportedModeParams(), org.matsim.core.config.groups.PlansCalcRouteConfigGroup.removeModeRoutingParams(), org.matsim.core.config.groups.VspExperimentalConfigGroup.setAbleToOverwritePtInteractionParams(), org.matsim.core.config.groups.PlanCalcScoreConfigGroup.ActivityParams.setActivityType(), org.matsim.pt.config.TransitRouterConfigGroup.setAdditionalTransferTime(), org.matsim.core.config.groups.PlansCalcRouteConfigGroup.TeleportedModeParams.setBeelineDistanceFactor(), org.matsim.core.config.groups.PlansCalcRouteConfigGroup.setBeelineDistanceFactor(), org.matsim.core.config.groups.PlanCalcScoreConfigGroup.ReflectiveDelegate.setBrainExpBeta(), org.matsim.core.config.groups.PlanCalcScoreConfigGroup.ActivityParams.setClosingTime(), org.matsim.core.config.groups.PlanCalcScoreConfigGroup.ModeParams.setConstant(), org.matsim.core.config.groups.PlanCalcScoreConfigGroup.ActivityParams.setEarliestEndTime(), org.matsim.core.config.groups.PlanCalcScoreConfigGroup.ScoringParameterSet.setEarlyDeparture_utils_hr(), org.matsim.pt.config.TransitRouterConfigGroup.setExtensionRadius(), org.matsim.core.config.groups.PlanCalcScoreConfigGroup.ReflectiveDelegate.setFractionOfIterationsToStartScoreMSA(), org.matsim.core.config.groups.VspExperimentalConfigGroup.setGeneratingBoardingDeniedEvent(), org.matsim.core.config.groups.NetworkConfigGroup.setInputFile(), org.matsim.core.config.groups.PlanCalcScoreConfigGroup.ScoringParameterSet.setLateArrival_utils_hr(), org.matsim.core.config.groups.PlanCalcScoreConfigGroup.ActivityParams.setLatestStartTime(), org.matsim.core.config.groups.PlanCalcScoreConfigGroup.ReflectiveDelegate.setLearningRate(), org.matsim.core.config.groups.VspExperimentalConfigGroup.setLogitScaleParamForPlansRemoval(), org.matsim.core.config.groups.PlanCalcScoreConfigGroup.ModeParams.setMarginalUtilityOfDistance(), org.matsim.core.config.groups.PlanCalcScoreConfigGroup.ScoringParameterSet.setMarginalUtilityOfMoney(), org.matsim.core.config.groups.PlanCalcScoreConfigGroup.ModeParams.setMarginalUtilityOfTraveling(), org.matsim.core.config.groups.PlanCalcScoreConfigGroup.ScoringParameterSet.setMarginalUtlOfWaiting_utils_hr(), org.matsim.pt.config.TransitRouterConfigGroup.setMaxBeelineWalkConnectionDistance(), org.matsim.core.config.groups.PlanCalcScoreConfigGroup.ActivityParams.setMinimalDuration(), org.matsim.core.config.groups.PlansCalcRouteConfigGroup.TeleportedModeParams.setMode(), org.matsim.core.config.groups.PlanCalcScoreConfigGroup.ModeParams.setMode(), org.matsim.core.config.groups.PlanCalcScoreConfigGroup.ModeParams.setMonetaryDistanceRate(), org.matsim.core.config.groups.PlanCalcScoreConfigGroup.ActivityParams.setOpeningTime(), org.matsim.core.config.groups.PlanCalcScoreConfigGroup.ReflectiveDelegate.setPathSizeLogitBeta(), org.matsim.core.config.groups.PlanCalcScoreConfigGroup.ActivityParams.setPriority(), org.matsim.core.config.groups.PlanCalcScoreConfigGroup.ActivityParams.setScoringThisActivityAtAll(), org.matsim.pt.config.TransitRouterConfigGroup.setSearchRadius(), org.matsim.core.config.groups.PlansCalcRouteConfigGroup.TeleportedModeParams.setTeleportedModeFreespeedFactor(), org.matsim.core.config.groups.PlansCalcRouteConfigGroup.setTeleportedModeFreespeedFactor(), org.matsim.core.config.groups.PlansCalcRouteConfigGroup.TeleportedModeParams.setTeleportedModeSpeed(), org.matsim.core.config.groups.PlansCalcRouteConfigGroup.setTeleportedModeSpeed(), org.matsim.core.config.groups.NetworkConfigGroup.setTimeVariantNetwork(), org.matsim.pt.config.TransitConfigGroup.setTransitScheduleFile(), org.matsim.core.config.groups.PlanCalcScoreConfigGroup.ActivityParams.setTypicalDuration(), org.matsim.core.config.groups.PlanCalcScoreConfigGroup.ActivityParams.setTypicalDurationScoreComputation(), org.matsim.pt.config.TransitConfigGroup.setUseTransit(), org.matsim.core.config.groups.PlanCalcScoreConfigGroup.ReflectiveDelegate.setUsingOldScoringBelowZeroUtilityDuration(), org.matsim.core.config.groups.VspExperimentalConfigGroup.setUsingOpportunityCostOfTimeForLocationChoice(), org.matsim.core.config.groups.PlanCalcScoreConfigGroup.ScoringParameterSet.setUtilityOfLineSwitch(), org.matsim.core.config.groups.QSimConfigGroup.setVehiclesSource(), org.matsim.core.config.groups.VspExperimentalConfigGroup.setVspDefaultsCheckingLevel(), org.matsim.core.config.groups.PlanCalcScoreConfigGroup.ReflectiveDelegate.setWriteExperiencedPlans(), and org.matsim.core.config.groups.VspExperimentalConfigGroup.setWritingOutputEvents().

                                      {
        if ( locked ) {
            throw new RuntimeException( "Too late to change this ...") ;
        }
    }

getInputFileURL()

static URL org.matsim.core.config.ConfigGroup.getInputFileURL ( URL  context, String  filename  )

staticinherited

Definition at line 244 of file ConfigGroup.java.

References org.matsim.core.utils.io.IOUtils.extendUrl(), and org.matsim.core.utils.io.IOUtils.getFileUrl().

Referenced by org.matsim.core.config.groups.NetworkConfigGroup.getChangeEventsInputFileUrl(), org.matsim.core.config.groups.CountsConfigGroup.getCountsFileURL(), org.matsim.core.config.groups.HouseholdsConfigGroup.getInputFileURL(), org.matsim.core.config.groups.NetworkConfigGroup.getInputFileURL(), org.matsim.core.config.groups.FacilitiesConfigGroup.getInputFileURL(), org.matsim.core.config.groups.PlansConfigGroup.getInputFileURL(), org.matsim.core.config.groups.PlansConfigGroup.getInputPersonAttributeFileURL(), org.matsim.pt.config.TransitConfigGroup.getTransitScheduleFileURL(), org.matsim.pt.config.TransitConfigGroup.getTransitStopsAttributesFileURL(), and org.matsim.pt.config.TransitConfigGroup.getVehiclesFileURL().

                                                                    {
        if (filename.startsWith("~/")) {
            filename = System.getProperty("user.home") + filename.substring(1);
            return IOUtils.getFileUrl(filename) ;
        }
        if ( filename.startsWith("/") ) {
            // (= filename is absolute)
            // (yyyy this may possibly fail on win systems. kai, sep.18)

            // Absolute filename on Windows, when obtained through URL.toURI().getPath() starts with `/`, like on Unix.
            return IOUtils.getFileUrl(filename) ;
        }
        return IOUtils.extendUrl(context, filename);
    }

Here is the call graph for this function:

Member Data Documentation

GROUP_NAME

final String org.matsim.core.config.groups.StrategyConfigGroup.GROUP_NAME = "strategy"

static

Definition at line 46 of file StrategyConfigGroup.java.

Referenced by org.matsim.core.config.Config.addCoreModules(), org.matsim.core.config.groups.StrategyConfigGroup.ReflectiveDelegate.ReflectiveDelegate(), org.matsim.core.config.Config.strategy(), and org.matsim.core.config.groups.StrategyConfigGroup.StrategyConfigGroup().

MODULE

final String org.matsim.core.config.groups.StrategyConfigGroup.MODULE = "Module_"

staticprivate

Definition at line 51 of file StrategyConfigGroup.java.

Referenced by org.matsim.core.config.groups.StrategyConfigGroup.addParam(), and org.matsim.core.config.groups.StrategyConfigGroup.getValue().

MODULE_PROBABILITY

final String org.matsim.core.config.groups.StrategyConfigGroup.MODULE_PROBABILITY = "ModuleProbability_"

staticprivate

Definition at line 52 of file StrategyConfigGroup.java.

Referenced by org.matsim.core.config.groups.StrategyConfigGroup.addParam(), and org.matsim.core.config.groups.StrategyConfigGroup.getValue().

MODULE_DISABLE_AFTER_ITERATION

final String org.matsim.core.config.groups.StrategyConfigGroup.MODULE_DISABLE_AFTER_ITERATION = "ModuleDisableAfterIteration_"

staticprivate

Definition at line 53 of file StrategyConfigGroup.java.

Referenced by org.matsim.core.config.groups.StrategyConfigGroup.addParam(), and org.matsim.core.config.groups.StrategyConfigGroup.getValue().

MODULE_EXE_PATH

final String org.matsim.core.config.groups.StrategyConfigGroup.MODULE_EXE_PATH = "ModuleExePath_"

staticprivate

Definition at line 54 of file StrategyConfigGroup.java.

Referenced by org.matsim.core.config.groups.StrategyConfigGroup.addParam(), and org.matsim.core.config.groups.StrategyConfigGroup.getValue().

MODULE_SUBPOPULATION

final String org.matsim.core.config.groups.StrategyConfigGroup.MODULE_SUBPOPULATION = "ModuleSubpopulation_"

staticprivate

Definition at line 55 of file StrategyConfigGroup.java.

Referenced by org.matsim.core.config.groups.StrategyConfigGroup.addParam(), and org.matsim.core.config.groups.StrategyConfigGroup.getValue().

delegate

final ReflectiveDelegate org.matsim.core.config.groups.StrategyConfigGroup.delegate = new ReflectiveDelegate()

private

Definition at line 57 of file StrategyConfigGroup.java.

Referenced by org.matsim.core.config.groups.StrategyConfigGroup.addParam(), org.matsim.core.config.groups.StrategyConfigGroup.getExternalExeConfigTemplate(), org.matsim.core.config.groups.StrategyConfigGroup.getExternalExeTimeOut(), org.matsim.core.config.groups.StrategyConfigGroup.getExternalExeTmpFileRootDir(), org.matsim.core.config.groups.StrategyConfigGroup.getFractionOfIterationsToDisableInnovation(), org.matsim.core.config.groups.StrategyConfigGroup.getMaxAgentPlanMemorySize(), org.matsim.core.config.groups.StrategyConfigGroup.getParams(), org.matsim.core.config.groups.StrategyConfigGroup.getPlanSelectorForRemoval(), org.matsim.core.config.groups.StrategyConfigGroup.getValue(), org.matsim.core.config.groups.StrategyConfigGroup.setExternalExeConfigTemplate(), org.matsim.core.config.groups.StrategyConfigGroup.setExternalExeTimeOut(), org.matsim.core.config.groups.StrategyConfigGroup.setExternalExeTmpFileRootDir(), org.matsim.core.config.groups.StrategyConfigGroup.setFractionOfIterationsToDisableInnovation(), org.matsim.core.config.groups.StrategyConfigGroup.setMaxAgentPlanMemorySize(), and org.matsim.core.config.groups.StrategyConfigGroup.setPlanSelectorForRemoval().

---

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

• core/config/groups/StrategyConfigGroup.java