Package org.matsim.core.config.groups

Class PlansCalcRouteConfigGroup.ModeRoutingParams

java.lang.Object

org.matsim.core.config.ConfigGroup

org.matsim.core.config.ReflectiveConfigGroup

org.matsim.core.config.groups.PlansCalcRouteConfigGroup.ModeRoutingParams

All Implemented Interfaces:

MatsimExtensionPoint, MatsimParameters

Enclosing class:

PlansCalcRouteConfigGroup

public static class PlansCalcRouteConfigGroup.ModeRoutingParams
extends ReflectiveConfigGroup
implements MatsimParameters

Nested Class Summary

Nested classes/interfaces inherited from class org.matsim.core.config.ReflectiveConfigGroup

ReflectiveConfigGroup.DoNotConvertNull, ReflectiveConfigGroup.InconsistentModuleException, ReflectiveConfigGroup.StringGetter, ReflectiveConfigGroup.StringSetter

Field Summary

Fields

Modifier and Type	Field	Description
static String	MODE
static String	SET_TYPE
static String	TELEPORTED_MODE_FREESPEED_FACTOR

Constructor Summary

Constructors

Constructor	Description
ModeRoutingParams()
ModeRoutingParams(String mode)

Method Summary

Modifier and Type	Method	Description
void	checkConsistency(Config config)	Check if the set values go well together.
Double	getBeelineDistanceFactor()
Map<String,String>	getComments()	Comments for parameters which setter get an enum type are automatically generated, containing a list of possible values.
String	getMode()
Double	getTeleportedModeFreespeedFactor()
Double	getTeleportedModeFreespeedLimit()	Currently not in xml interface.
Double	getTeleportedModeSpeed()
PlansCalcRouteConfigGroup.ModeRoutingParams	setBeelineDistanceFactor(Double val)
PlansCalcRouteConfigGroup.ModeRoutingParams	setMode(String mode)
PlansCalcRouteConfigGroup.ModeRoutingParams	setTeleportedModeFreespeedFactor(Double teleportedModeFreespeedFactor)
PlansCalcRouteConfigGroup.ModeRoutingParams	setTeleportedModeFreespeedLimit(Double teleportedModeFreespeedLimit)	Currently not in xml interface.
PlansCalcRouteConfigGroup.ModeRoutingParams	setTeleportedModeSpeed(Double teleportedModeSpeed)

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

addParam, getParams, getValue

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

addParameterSet, addParameterToMap, checkParameterSet, clearParameterSetsForType, createParameterSet, getInputFileURL, getName, getParameterSets, getParameterSets, isLocked, removeParameterSet, setLocked, testForLocked, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

SET_TYPE

public static final String SET_TYPE

See Also:

Constant Field Values

MODE

public static final String MODE

See Also:

Constant Field Values

TELEPORTED_MODE_FREESPEED_FACTOR

public static final String TELEPORTED_MODE_FREESPEED_FACTOR

See Also:

Constant Field Values

Constructor Detail

ModeRoutingParams

public ModeRoutingParams(String mode)

ModeRoutingParams

public ModeRoutingParams()

Method Detail

checkConsistency

public 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

getComments

public Map<String,String> getComments()

Description copied from class: ReflectiveConfigGroup

Comments for parameters which setter get an enum type are automatically generated, containing a list of possible values. They can be overriden by subclasses without problems.
it is recommended for subclasses to get this map using super.getComments() and fill it with additional comments, rather than generate an empty map.

Overrides:

getComments in class ReflectiveConfigGroup

Returns:

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

getTeleportedModeFreespeedLimit

public final Double getTeleportedModeFreespeedLimit()

Currently not in xml interface.

Returns:

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

setTeleportedModeFreespeedLimit

public final PlansCalcRouteConfigGroup.ModeRoutingParams setTeleportedModeFreespeedLimit(Double teleportedModeFreespeedLimit)

Currently not in xml interface.

Parameters:

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

getMode

@StringGetter("mode")
public String getMode()

setMode

@StringSetter("mode")
public PlansCalcRouteConfigGroup.ModeRoutingParams setMode(String mode)

getTeleportedModeSpeed

@StringGetter("teleportedModeSpeed")
public Double getTeleportedModeSpeed()

setTeleportedModeSpeed

@StringSetter("teleportedModeSpeed")
public PlansCalcRouteConfigGroup.ModeRoutingParams setTeleportedModeSpeed(Double teleportedModeSpeed)

getTeleportedModeFreespeedFactor

@StringGetter("teleportedModeFreespeedFactor")
public Double getTeleportedModeFreespeedFactor()

Returns:

"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."

setTeleportedModeFreespeedFactor

@StringSetter("teleportedModeFreespeedFactor")
public PlansCalcRouteConfigGroup.ModeRoutingParams setTeleportedModeFreespeedFactor(Double teleportedModeFreespeedFactor)

Parameters:

teleportedModeFreespeedFactor - -- "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."

setBeelineDistanceFactor

@StringSetter("beelineDistanceFactor")
public PlansCalcRouteConfigGroup.ModeRoutingParams setBeelineDistanceFactor(Double val)

getBeelineDistanceFactor

@StringGetter("beelineDistanceFactor")
public Double getBeelineDistanceFactor()