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

Class AbstractIdmFactory<T extends AbstractIdm>

java.lang.Object

org.opentrafficsim.road.gtu.lane.tactical.following.AbstractIdmFactory<T>

Type Parameters:

T - IDM class

All Implemented Interfaces:

CarFollowingModelFactory<T>, ModelComponentFactory

Direct Known Subclasses:

IdmFactory, IdmPlusFactory, IdmPlusMultiFactory

public class AbstractIdmFactory<T extends AbstractIdm>
extends Object
implements CarFollowingModelFactory<T>

Factory for IDM types.

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

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Constructor Summary

Constructors

Constructor	Description
AbstractIdmFactory(T idm, nl.tudelft.simulation.jstats.streams.StreamInterface randomStream)	Sets the idm model, which should be state-less.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractIdmFactory

public AbstractIdmFactory(T idm,
 nl.tudelft.simulation.jstats.streams.StreamInterface randomStream)

Sets the idm model, which should be state-less.

Parameters:

idm - T; idm model, which should be state-less

randomStream - StreamInterface; random number stream

Method Details

generateCarFollowingModel

public final T generateCarFollowingModel()

Returns a new instance of a car-following model.

Specified by:

generateCarFollowingModel in interface CarFollowingModelFactory<T extends AbstractIdm>

Returns:

new instance of a car-following model

getParameters

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

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

Throws:

org.opentrafficsim.base.parameters.ParameterException - on parameter exception