Package org.matsim.contrib.freight

Class FreightConfigGroup

java.lang.Object

org.matsim.core.config.ConfigGroup

org.matsim.core.config.ReflectiveConfigGroup

org.matsim.contrib.freight.FreightConfigGroup

All Implemented Interfaces:

org.matsim.core.api.internal.MatsimExtensionPoint

public class FreightConfigGroup
extends org.matsim.core.config.ReflectiveConfigGroup

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FreightConfigGroup.TimeWindowHandling
static class	FreightConfigGroup.UseDistanceConstraintForTourPlanning

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

org.matsim.core.config.ReflectiveConfigGroup.DoNotConvertNull, org.matsim.core.config.ReflectiveConfigGroup.InconsistentModuleException, org.matsim.core.config.ReflectiveConfigGroup.StringGetter, org.matsim.core.config.ReflectiveConfigGroup.StringSetter

Field Summary

Fields

Modifier and Type	Field	Description
static String	CARRIERSFILEDE
static String	CARRIERSVEHICLETYPED
static String	GROUPNAME
static String	TRAVELTIMESLICEWIDTH
static String	VEHICLEROUTINGALGORITHM

Constructor Summary

Constructors

Constructor	Description
FreightConfigGroup()

Method Summary

Modifier and Type	Method	Description
String	getCarriersFile()
String	getCarriersVehicleTypesFile()
Map<String,String>	getComments()
FreightConfigGroup.TimeWindowHandling	getTimeWindowHandling()
int	getTravelTimeSliceWidth()
FreightConfigGroup.UseDistanceConstraintForTourPlanning	getUseDistanceConstraintForTourPlanning()
String	getVehicleRoutingAlgortihmFile()
void	setCarriersFile(String carriersFile)
void	setCarriersVehicleTypesFile(String carriersVehicleTypesFile)
void	setTimeWindowHandling(FreightConfigGroup.TimeWindowHandling handling)	Physically enforces beginnings of time windows for freight activities, i.e.
void	setTravelTimeSliceWidth(int travelTimeSliceWidth)
void	setUseDistanceConstraintForTourPlanning(FreightConfigGroup.UseDistanceConstraintForTourPlanning useDistanceConstraintForTourPlanning)
void	setVehicleRoutingAlgortihmFileFile(String vehicleRoutingAlgortihmFile)

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

addParam, getParams, getValue

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

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

Methods inherited from class java.lang.Object

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

Field Detail

GROUPNAME

public static final String GROUPNAME

See Also:

Constant Field Values

CARRIERSFILEDE

public static final String CARRIERSFILEDE

See Also:

Constant Field Values

CARRIERSVEHICLETYPED

public static final String CARRIERSVEHICLETYPED

See Also:

Constant Field Values

VEHICLEROUTINGALGORITHM

public static final String VEHICLEROUTINGALGORITHM

See Also:

Constant Field Values

TRAVELTIMESLICEWIDTH

public static final String TRAVELTIMESLICEWIDTH

See Also:

Constant Field Values

Constructor Detail

FreightConfigGroup

public FreightConfigGroup()

Method Detail

getCarriersFile

public String getCarriersFile()

Returns:

-- "Freight Carriers File, according to MATSim freight contrib"

setCarriersFile

public void setCarriersFile(String carriersFile)

getCarriersVehicleTypesFile

public String getCarriersVehicleTypesFile()

Returns:

-- "Carrier Vehicle Types file, according to MATSim freight contrib"

setCarriersVehicleTypesFile

public void setCarriersVehicleTypesFile(String carriersVehicleTypesFile)

getVehicleRoutingAlgortihmFile

public String getVehicleRoutingAlgortihmFile()

Returns:

-- "(Optional) Vehicle Routing Algorithm File, according to jsprit library. Empty value \"\" means an default algorithm is used."

setVehicleRoutingAlgortihmFileFile

public void setVehicleRoutingAlgortihmFileFile(String vehicleRoutingAlgortihmFile)

getTravelTimeSliceWidth

public int getTravelTimeSliceWidth()

Returns:

travelTimeSliceWidth --"time slice width used for calculation of travel times in seconds. The smaller the value, the more precise the calculation of routing costs but the longer the computation time. Default value is 1800 seconds."

setTravelTimeSliceWidth

public void setTravelTimeSliceWidth(int travelTimeSliceWidth)

Parameters:

travelTimeSliceWidth - --"time slice width used for calculation of travel times in seconds. The smaller the value, the more precise the calculation of routing costs but the longer the computation time. Default value is 1800 seconds."

setTimeWindowHandling

public void setTimeWindowHandling(FreightConfigGroup.TimeWindowHandling handling)

Physically enforces beginnings of time windows for freight activities, i.e. freight agents wait before closed doors until they can deliver / pick up their goods, and then take their required duration.

getTimeWindowHandling

public FreightConfigGroup.TimeWindowHandling getTimeWindowHandling()

getUseDistanceConstraintForTourPlanning

@StringGetter("useDistanceConstraintForTourPlanning")
public FreightConfigGroup.UseDistanceConstraintForTourPlanning getUseDistanceConstraintForTourPlanning()

Returns:

useDistanceConstraint

setUseDistanceConstraintForTourPlanning

@StringSetter("useDistanceConstraintForTourPlanning")
public void setUseDistanceConstraintForTourPlanning(FreightConfigGroup.UseDistanceConstraintForTourPlanning useDistanceConstraintForTourPlanning)

Parameters:

useDistanceConstraintForTourPlanning - "Use distant constraint within the tour planning phase. This does NOT ensure that the tours in MATSim will respect this limitation"

getComments

public Map<String,String> getComments()

Overrides:

getComments in class org.matsim.core.config.ReflectiveConfigGroup