org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams Class Reference

Inheritance diagram for org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams:

Public Member Functions
	TeleportedModeParams (final String mode)
	TeleportedModeParams ()
void	checkConsistency (Config config)
Map< String, String >	getComments ()
final Double	getTeleportedModeFreespeedLimit ()
TeleportedModeParams	setTeleportedModeFreespeedLimit (Double teleportedModeFreespeedLimit)
String	getMode ()
TeleportedModeParams	setMode (String mode)
Double	getTeleportedModeSpeed ()
TeleportedModeParams	setTeleportedModeSpeed (Double teleportedModeSpeed)
Double	getTeleportedModeFreespeedFactor ()
TeleportedModeParams	setTeleportedModeFreespeedFactor (Double teleportedModeFreespeedFactor)
TeleportedModeParams	setBeelineDistanceFactor (Double val)
Double	getBeelineDistanceFactor ()
final void	addParam (final String param_name, final String value)
void	handleAddUnknownParam (final String paramName, final String value)
final String	getValue (final String param_name)
String	handleGetUnknownValue (final String paramName)
final String	toString ()
final Map< String, String >	getParams ()
final String	getName ()
ConfigGroup	createParameterSet (final String type)
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	SET_TYPE = "teleportedModeParameters"
static final String	MODE = "mode"
static final String	TELEPORTED_MODE_FREESPEED_FACTOR = "teleportedModeFreespeedFactor"

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

Private Attributes
String	mode = null
Double	teleportedModeSpeed = null
Double	beelineDistanceFactorForMode = null
Double	teleportedModeFreespeedFactor = null
Double	teleportedModeFreespeedLimit = Double.POSITIVE_INFINITY

Static Private Attributes
static final String	TELEPORTED_MODE_FREESPEED_FACTOR_CMT
static final String	TELEPORTED_MODE_FREESPEED_LIMIT_CMT

Detailed Description

Definition at line 144 of file RoutingConfigGroup.java.

Constructor & Destructor Documentation

TeleportedModeParams() [1/2]

org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.TeleportedModeParams

(

final String

mode

)

Definition at line 167 of file RoutingConfigGroup.java.

References org.matsim.core.config.groups.RoutingConfigGroup.ModeRoutingParams.setMode().

                                                         {
            super( SET_TYPE );
            setMode( mode );
        }

Here is the call graph for this function:

TeleportedModeParams() [2/2]

org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.TeleportedModeParams

(

)

Definition at line 172 of file RoutingConfigGroup.java.

Referenced by org.matsim.core.config.groups.RoutingConfigGroup.addParameterSet(), org.matsim.core.config.groups.RoutingConfigGroup.createParameterSet(), org.matsim.core.config.groups.RoutingConfigGroup.getModeRoutingParams(), org.matsim.core.config.groups.RoutingConfigGroup.getOrCreateModeRoutingParams(), org.matsim.core.config.groups.RoutingConfigGroup.removeModeRoutingParams(), org.matsim.core.config.groups.RoutingConfigGroup.RoutingConfigGroup(), org.matsim.core.config.groups.RoutingConfigGroup.setTeleportedModeFreespeedFactor(), and org.matsim.core.config.groups.RoutingConfigGroup.setTeleportedModeSpeed().

                                      {
            super( SET_TYPE );
        }

Member Function Documentation

checkConsistency()

void org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.checkConsistency

(

Config

config

)

Definition at line 177 of file RoutingConfigGroup.java.

                                                    {
            if ( mode == null ) throw new RuntimeException( "mode for parameter set "+this+" is null!" );

            if ( teleportedModeSpeed == null && teleportedModeFreespeedFactor == null ) {
                throw new RuntimeException( "no teleported mode speed nor freespeed factor defined for mode "+mode );
            }

            if ( teleportedModeSpeed != null && teleportedModeFreespeedFactor != null ) {
                // this should not happen anyway as the setters forbid it
                throw new RuntimeException( "both teleported mode speed or freespeed factor are set for mode "+mode );
            }
        }

getComments()

Map<String, String> org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.getComments

(

)

Definition at line 191 of file RoutingConfigGroup.java.

                                                 {
            final Map<String, String> map = super.getComments();

            map.put( "teleportedModeSpeed" ,
                    "Speed for a teleported mode. " +
                    "Travel time = (<beeline distance> * beelineDistanceFactor) / teleportedModeSpeed. Insert a line like this for every such mode.");
            map.put( TELEPORTED_MODE_FREESPEED_FACTOR, TELEPORTED_MODE_FREESPEED_FACTOR_CMT);

            return map;
        }

getTeleportedModeFreespeedLimit()

final Double org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.getTeleportedModeFreespeedLimit

(

)

Currently not in xml interface.

Returns

teleportedModeFreespeedLimit – { TELEPORTED_MODE_FREESPEED_LIMIT_CMT}

Definition at line 207 of file RoutingConfigGroup.java.

References org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.teleportedModeFreespeedLimit.

                                                              {
            return this.teleportedModeFreespeedLimit;
        }

setTeleportedModeFreespeedLimit()

TeleportedModeParams org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.setTeleportedModeFreespeedLimit

(

Double

teleportedModeFreespeedLimit

)

Currently not in xml interface.

Parameters

teleportedModeFreespeedLimit

– { TELEPORTED_MODE_FREESPEED_LIMIT_CMT}

Definition at line 216 of file RoutingConfigGroup.java.

References org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.teleportedModeFreespeedLimit.

                                                                                                           {
            this.teleportedModeFreespeedLimit = teleportedModeFreespeedLimit;
            return this;
        }

getMode()

String org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.getMode

(

)

Definition at line 222 of file RoutingConfigGroup.java.

References org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.MODE, and org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.mode.

Referenced by org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.setTeleportedModeFreespeedFactor(), and org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.setTeleportedModeSpeed().

                                {
            return mode;
        }

setMode()

TeleportedModeParams org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.setMode

(

String

mode

)

Definition at line 227 of file RoutingConfigGroup.java.

References org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.mode, and org.matsim.core.config.ConfigGroup.testForLocked().

Referenced by org.matsim.core.config.groups.RoutingConfigGroup.getOrCreateModeRoutingParams().

                                                           {
            testForLocked() ;
            this.mode = mode;
            return this ;
        }

Here is the call graph for this function:

getTeleportedModeSpeed()

Double org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.getTeleportedModeSpeed

(

)

Definition at line 234 of file RoutingConfigGroup.java.

References org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.teleportedModeSpeed.

Referenced by org.matsim.core.router.DefaultRoutingModules.createTeleportationRouter(), org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.setTeleportedModeFreespeedFactor(), and org.matsim.pt.router.TransitRouterConfig.TransitRouterConfig().

                                               {
            return teleportedModeSpeed;
        }

setTeleportedModeSpeed()

TeleportedModeParams org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.setTeleportedModeSpeed

(

Double

teleportedModeSpeed

)

Definition at line 239 of file RoutingConfigGroup.java.

References org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.getMode(), org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.getTeleportedModeFreespeedFactor(), org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.TELEPORTED_MODE_FREESPEED_FACTOR, org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.teleportedModeSpeed, and org.matsim.core.config.ConfigGroup.testForLocked().

Referenced by org.matsim.core.config.groups.RoutingConfigGroup.RoutingConfigGroup(), and org.matsim.core.config.groups.RoutingConfigGroup.setTeleportedModeSpeed().

                                                                                         {
            testForLocked() ;
            if ( getTeleportedModeFreespeedFactor() != null && teleportedModeSpeed != null ) {
                throw new IllegalStateException( "cannot set both speed and freespeed factor for "+getMode() );
            }
            this.teleportedModeSpeed = teleportedModeSpeed;
            return this;
        }

Here is the call graph for this function:

getTeleportedModeFreespeedFactor()

Double org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.getTeleportedModeFreespeedFactor

(

)

Returns

{ TELEPORTED_MODE_FREESPEED_FACTOR_CMT}

Definition at line 252 of file RoutingConfigGroup.java.

References org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.TELEPORTED_MODE_FREESPEED_FACTOR, and org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.teleportedModeFreespeedFactor.

Referenced by org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.setTeleportedModeSpeed().

                                                         {
            return teleportedModeFreespeedFactor;
        }

setTeleportedModeFreespeedFactor()

TeleportedModeParams org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.setTeleportedModeFreespeedFactor

(

Double

teleportedModeFreespeedFactor

)

Parameters

teleportedModeFreespeedFactor

– { TELEPORTED_MODE_FREESPEED_FACTOR_CMT}

Definition at line 260 of file RoutingConfigGroup.java.

References org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.getMode(), org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.getTeleportedModeSpeed(), org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.teleportedModeFreespeedFactor, and org.matsim.core.config.ConfigGroup.testForLocked().

Referenced by org.matsim.core.config.groups.RoutingConfigGroup.RoutingConfigGroup(), and org.matsim.core.config.groups.RoutingConfigGroup.setTeleportedModeFreespeedFactor().

                                                       {
            testForLocked() ;
            if ( getTeleportedModeSpeed() != null && teleportedModeFreespeedFactor != null ) {
                throw new IllegalStateException( "cannot set both speed and freespeed factor for "+getMode() );
            }
            this.teleportedModeFreespeedFactor = teleportedModeFreespeedFactor;
            return this;
        }

Here is the call graph for this function:

setBeelineDistanceFactor()

TeleportedModeParams org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.setBeelineDistanceFactor

(

Double

val

)

Definition at line 271 of file RoutingConfigGroup.java.

References org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.beelineDistanceFactorForMode, and org.matsim.core.config.ConfigGroup.testForLocked().

Referenced by org.matsim.core.config.groups.RoutingConfigGroup.addParameterSet().

                                                                           {
            testForLocked() ;
            this.beelineDistanceFactorForMode = val ;
            return this ;
        }

Here is the call graph for this function:

getBeelineDistanceFactor()

Double org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.getBeelineDistanceFactor

(

)

Definition at line 277 of file RoutingConfigGroup.java.

References org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.beelineDistanceFactorForMode.

Referenced by org.matsim.core.config.groups.RoutingConfigGroup.addParameterSet(), org.matsim.core.router.DefaultRoutingModules.createTeleportationRouter(), and org.matsim.pt.router.TransitRouterConfig.TransitRouterConfig().

                                                 {
            return this.beelineDistanceFactorForMode ;
        }

addParam()

final void org.matsim.core.config.ReflectiveConfigGroup.addParam ( final String  param_name, final String  value  )

inherited

Definition at line 276 of file ReflectiveConfigGroup.java.

References org.matsim.core.config.ConfigGroup.getName(), org.matsim.core.config.ReflectiveConfigGroup.handleAddUnknownParam(), org.matsim.core.config.ReflectiveConfigGroup.invokeSetter(), and org.matsim.core.config.ReflectiveConfigGroup.setParamField().

Referenced by org.matsim.core.config.groups.ScoringConfigGroup.addParam(), and org.matsim.core.config.groups.ReplanningConfigGroup.addParam().

                                                                            {
        var setter = setters.get(param_name);
        if (setter != null) {
            invokeSetter(setter, value);
            log.trace("value {} successfully set for field {} for group {}", value, param_name, getName());
            return;
        }

        var field = paramFields.get(param_name);
        if (field != null) {
            setParamField(field, value);
            log.trace("value {} successfully set for field {} for group {}", value, param_name, getName());
            return;
        }

        this.handleAddUnknownParam(param_name, value);
    }

Here is the call graph for this function:

handleAddUnknownParam()

void org.matsim.core.config.ReflectiveConfigGroup.handleAddUnknownParam ( final String  paramName, final String  value  )

inherited

This method is designed to be overwritten if a config group wants to provide custom handling for unknown parameters, e.g. for improved backwards compatibility. For example: It allows to convert (old-named) parameter values to different units and store them with the new name (old parameter could be km/h, new parameter could be m/s).

The default implementation in ReflectiveConfigGroup will either store the unknown parameter or throw an exception, depending on the value of storeUnknownParameters.

If the method is overwritten, it might make sense to also overwrite handleGetUnknownValue(String).

Definition at line 305 of file ReflectiveConfigGroup.java.

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

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

                                                                                  {
        Preconditions.checkArgument(this.storeUnknownParameters, "Module %s of type %s doesn't accept unknown parameters."
                + " Parameter %s is not part of the valid parameters: %s", getName(), getClass().getName(), paramName,
            this.registeredParams);

        log.warn(
            "Unknown parameter {} for group {}. Here are the valid parameter names: {}. Only the string value will be remembered.",
            paramName, getName(), this.registeredParams);
        super.addParam(paramName, value);
    }

Here is the call graph for this function:

getValue()

final String org.matsim.core.config.ReflectiveConfigGroup.getValue ( final String  param_name )

inherited

Definition at line 459 of file ReflectiveConfigGroup.java.

References org.matsim.core.config.ReflectiveConfigGroup.getParamField(), org.matsim.core.config.ReflectiveConfigGroup.handleGetUnknownValue(), and org.matsim.core.config.ReflectiveConfigGroup.invokeGetter().

Referenced by org.matsim.core.scoring.functions.ScoringParameters.Builder.Builder(), ch.sbb.matsim.routing.pt.raptor.RaptorUtils.createParameters(), and org.matsim.core.config.groups.ReplanningConfigGroup.getValue().

                                                          {
        var getter = stringGetters.get(param_name);
        if (getter != null) {
            return invokeGetter(getter);
        }

        var field = paramFields.get(param_name);
        if (field != null) {
            return getParamField(field);
        }
        return this.handleGetUnknownValue(param_name);
    }

Here is the call graph for this function:

handleGetUnknownValue()

String org.matsim.core.config.ReflectiveConfigGroup.handleGetUnknownValue ( final String  paramName )

inherited

This method is designed to be overwritten if a config group wants to provide custom handling for unknown parameters, e.g. for improved backwards compatibility.

Also see handleAddUnknownParam(String, String)

Definition at line 478 of file ReflectiveConfigGroup.java.

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

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

                                                                {
        Preconditions.checkArgument(this.storeUnknownParameters, "Module %s of type %s doesn't store unknown parameters."
                        + " Parameter %s is not part of the valid parameters: %s", getName(), getClass().getName(), paramName,
                this.registeredParams);

        log.warn("no getter found for param {}: trying parent method", paramName);
        return super.getValue(paramName);
    }

Here is the call graph for this function:

toString()

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

inherited

Definition at line 127 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.RoutingConfigGroup.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:

getParams()

final Map<String, String> org.matsim.core.config.ReflectiveConfigGroup.getParams ( )

inherited

Definition at line 534 of file ReflectiveConfigGroup.java.

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

Referenced by org.matsim.core.config.groups.ScoringConfigGroup.getParams(), and org.matsim.core.config.groups.ReplanningConfigGroup.getParams().

                                                 {
        final Map<String, String> map = super.getParams();
        registeredParams.forEach(f -> addParameterToMap(map, f));
        return map;
    }

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 80 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 110 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.ConfigGroup.addParameterSet(), ch.sbb.matsim.config.SwissRailRaptorConfigGroup.addParameterSet(), org.matsim.core.config.groups.RoutingConfigGroup.addParameterSet(), org.matsim.core.config.groups.ScoringConfigGroup.addParameterSet(), org.matsim.core.replanning.annealing.ReplanningAnnealerConfigGroup.checkParameterSet(), org.matsim.core.config.groups.ReplanningConfigGroup.checkParameterSet(), org.matsim.core.config.groups.RoutingConfigGroup.checkParameterSet(), org.matsim.core.config.groups.ScoringConfigGroup.checkParameterSet(), org.matsim.core.config.groups.ScoringConfigGroup.ScoringParameterSet.checkParameterSet(), org.matsim.core.config.ReflectiveConfigGroup.handleAddUnknownParam(), org.matsim.core.config.ReflectiveConfigGroup.handleGetUnknownValue(), org.matsim.core.config.ConfigGroup.removeParameterSet(), org.matsim.run.OldToNewPlanCalcScoreConfigGroup.ModeParams.setMonetaryDistanceRate(), and org.matsim.core.config.ConfigGroup.toString().

                                  {
        return this.name;
    }

createParameterSet()

ConfigGroup org.matsim.core.config.ConfigGroup.createParameterSet ( final String  type )

inherited

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

Definition at line 149 of file ConfigGroup.java.

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

Referenced by org.matsim.core.config.Config.copyTo(), and org.matsim.core.config.groups.RoutingConfigGroup.getOrCreateModeRoutingParams().

                                                             {
        return new ConfigGroup( type );
    }

Here is the call graph for this function:

addParameterSet()

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

inherited

Definition at line 165 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.RoutingConfigGroup.addParameterSet(), org.matsim.core.config.groups.ReplanningConfigGroup.addStrategySettings(), org.matsim.core.config.groups.RoutingConfigGroup.addTeleportedModeParams(), org.matsim.core.config.Config.copyTo(), org.matsim.core.config.groups.ScoringConfigGroup.ScoringParameterSet.getOrCreateModeParams(), org.matsim.core.config.groups.RoutingConfigGroup.getOrCreateModeRoutingParams(), org.matsim.core.config.groups.RoutingConfigGroup.RoutingConfigGroup(), org.matsim.core.config.groups.RoutingConfigGroup.setTeleportedModeFreespeedFactor(), and org.matsim.core.config.groups.RoutingConfigGroup.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 177 of file ConfigGroup.java.

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

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

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

Here is the call graph for this function:

checkParameterSet()

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

protectedinherited

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.

Parameters

set

Definition at line 191 of file ConfigGroup.java.

Referenced by org.matsim.core.config.ConfigGroup.addParameterSet().

                                                            {
        // empty for inheritance
    }

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 199 of file ConfigGroup.java.

Referenced by org.matsim.core.config.groups.RoutingConfigGroup.addParameterSet(), org.matsim.core.config.groups.RoutingConfigGroup.clearModeRoutingParams(), and org.matsim.core.config.groups.ReplanningConfigGroup.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 203 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 210 of file ConfigGroup.java.

Referenced by org.matsim.core.config.ConfigGroup.checkConsistency(), org.matsim.core.config.groups.ScoringConfigGroup.ScoringParameterSet.getActivityParams(), org.matsim.core.replanning.annealing.ReplanningAnnealerConfigGroup.getAnnealingVariablesPerSubpopulation(), org.matsim.core.config.groups.RoutingConfigGroup.getModeRoutingParams(), org.matsim.core.config.groups.ScoringConfigGroup.ScoringParameterSet.getModes(), org.matsim.core.config.groups.ScoringConfigGroup.getScoringParametersPerSubpopulation(), org.matsim.core.config.groups.ReplanningConfigGroup.getStrategySettings(), and org.matsim.core.config.groups.RoutingConfigGroup.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 223 of file ConfigGroup.java.

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

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

                                    {
        return locked;
    }

setLocked()

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

inherited

Definition at line 227 of file ConfigGroup.java.

Referenced by org.matsim.core.controler.Controler.Controler(), org.matsim.core.config.groups.RoutingConfigGroup.getOrCreateModeRoutingParams(), org.matsim.core.config.groups.ScoringConfigGroup.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 237 of file ConfigGroup.java.

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

SET_TYPE

final String org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.SET_TYPE = "teleportedModeParameters"

static

Definition at line 145 of file RoutingConfigGroup.java.

Referenced by org.matsim.core.config.groups.RoutingConfigGroup.addParameterSet(), org.matsim.core.config.groups.RoutingConfigGroup.checkParameterSet(), org.matsim.core.config.groups.RoutingConfigGroup.clearModeRoutingParams(), org.matsim.core.config.groups.RoutingConfigGroup.createParameterSet(), org.matsim.core.config.groups.RoutingConfigGroup.getModeRoutingParams(), org.matsim.core.config.groups.RoutingConfigGroup.getOrCreateModeRoutingParams(), and org.matsim.core.config.groups.RoutingConfigGroup.removeModeRoutingParams().

MODE

final String org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.MODE = "mode"

static

Definition at line 146 of file RoutingConfigGroup.java.

Referenced by org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.getMode().

TELEPORTED_MODE_FREESPEED_FACTOR

final String org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.TELEPORTED_MODE_FREESPEED_FACTOR = "teleportedModeFreespeedFactor"

static

Definition at line 147 of file RoutingConfigGroup.java.

Referenced by org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.getTeleportedModeFreespeedFactor(), and org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.setTeleportedModeSpeed().

mode

String org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.mode = null

private

Definition at line 149 of file RoutingConfigGroup.java.

Referenced by org.matsim.core.config.groups.RoutingConfigGroup.checkConsistency(), org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.getMode(), org.matsim.core.config.groups.RoutingConfigGroup.getModeRoutingParams(), org.matsim.core.config.groups.RoutingConfigGroup.removeModeRoutingParams(), and org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.setMode().

teleportedModeSpeed

Double org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.teleportedModeSpeed = null

private

Definition at line 152 of file RoutingConfigGroup.java.

Referenced by org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.getTeleportedModeSpeed(), and org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.setTeleportedModeSpeed().

beelineDistanceFactorForMode

Double org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.beelineDistanceFactorForMode = null

private

Definition at line 153 of file RoutingConfigGroup.java.

Referenced by org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.getBeelineDistanceFactor(), and org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.setBeelineDistanceFactor().

teleportedModeFreespeedFactor

Double org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.teleportedModeFreespeedFactor = null

private

Definition at line 156 of file RoutingConfigGroup.java.

Referenced by org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.getTeleportedModeFreespeedFactor(), and org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.setTeleportedModeFreespeedFactor().

teleportedModeFreespeedLimit

Double org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.teleportedModeFreespeedLimit = Double.POSITIVE_INFINITY

private

Definition at line 157 of file RoutingConfigGroup.java.

Referenced by org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.getTeleportedModeFreespeedLimit(), and org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.setTeleportedModeFreespeedLimit().

TELEPORTED_MODE_FREESPEED_FACTOR_CMT

final String org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.TELEPORTED_MODE_FREESPEED_FACTOR_CMT

staticprivate

Initial value:

= "Free-speed factor for a teleported mode. " +
        "Travel time = teleportedModeFreespeedFactor * <freespeed car travel time>. Insert a line like this for every such mode. " +
        "Please do not set teleportedModeFreespeedFactor as well as teleportedModeSpeed for the same mode, but if you do, +" +
        "teleportedModeFreespeedFactor wins over teleportedModeSpeed."

Definition at line 159 of file RoutingConfigGroup.java.

TELEPORTED_MODE_FREESPEED_LIMIT_CMT

final String org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams.TELEPORTED_MODE_FREESPEED_LIMIT_CMT

staticprivate

Initial value:

= "When using freespeed factor, a speed limit on the free speed. "
                + "Link travel time will be $= factor * [ min( link_freespeed, freespeed_limit) ]"

Definition at line 164 of file RoutingConfigGroup.java.

---

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

• core/config/groups/RoutingConfigGroup.java