org.opentrafficsim.road.gtu.lane.tactical.following

Class IDMPlusMultiFactory

java.lang.Object

org.opentrafficsim.road.gtu.lane.tactical.following.IDMPlusMultiFactory

All Implemented Interfaces:

CarFollowingModelFactory<IDMPlusMulti>, ModelComponentFactory

public class IDMPlusMultiFactory
extends Object
implements CarFollowingModelFactory<IDMPlusMulti>

Copyright (c) 2013-2018 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

Version:

$Revision$, $LastChangedDate$, by $Author$, initial version Sep 15, 2016

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Constructor Summary

Constructors

Constructor and Description
IDMPlusMultiFactory()

Method Summary

Modifier and Type	Method and Description
IDMPlusMulti	generateCarFollowingModel() Returns a new instance of a car-following model.
org.opentrafficsim.base.parameters.Parameters	getParameters() Returns parameters for the given component.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

IDMPlusMultiFactory

public IDMPlusMultiFactory()

Method Detail

generateCarFollowingModel

public final IDMPlusMulti generateCarFollowingModel()

Returns a new instance of a car-following model.

Specified by:

generateCarFollowingModel in interface CarFollowingModelFactory<IDMPlusMulti>

Returns:

new instance of a car-following model

getParameters

public org.opentrafficsim.base.parameters.Parameters getParameters()

Returns parameters for the given component. These parameters should contain, and possibly overwrite, parameters from sub-components. A parameter factory at the highest level (strategical planner) may overwrite any parameter. This combination allows that for sub-components, default factories can be used, while the parameter factory only overwrites parameters different for specific GTU types. The default implementation returns all default parameter values declared at the class.

Conventional use is:

 Parameters parameters = this.subComponent1Factory.getParameters();
 this.subComponent2Factory.getParameters().setAllIn(parameters);
 parameters.setDefaultParameters(componentClass);
 parameters.setDefaultParameters(staticUtilityClass);
 return parameters;
 

where all parameters used in componentClass are defined or forwarded in componentClass.

 // forwarded
 public static final ParameterTypeAcceleration A = ParameterTypes.A;
 
 // defined
 public static final ParameterTypeDouble FACTOR = new ParameterTypeDouble("factor", "factor on response", 1.0);
 

The same holds for static utilities that are used. Parameters should be defined at the utility class, and parameters of used utilities should be included.

Specified by:

getParameters in interface ModelComponentFactory

Returns:

Parameters; parameters for the given component

toString

public final String toString()

Overrides:

toString in class Object