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

Class ToledoFactory

java.lang.Object

org.opentrafficsim.road.gtu.lane.tactical.toledo.ToledoFactory

All Implemented Interfaces:

LaneBasedTacticalPlannerFactory<Toledo>, ModelComponentFactory

public class ToledoFactory
extends Object
implements LaneBasedTacticalPlannerFactory<Toledo>

Factory for tactical planner using Toledo's model and car-following model.

Copyright (c) 2013-2020 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 Aug 2, 2016

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Constructor Summary

Constructors

Constructor	Description
ToledoFactory()

Method Summary

Modifier and Type	Method	Description
Toledo	create(LaneBasedGTU gtu)	Creates a new tactical planner for the given GTU.
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

Methods inherited from interface org.opentrafficsim.road.gtu.lane.tactical.LaneBasedTacticalPlannerFactory

peekDesiredHeadway, peekDesiredSpeed

Constructor Detail

ToledoFactory

public ToledoFactory()

Method Detail

getParameters

public final 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

create

public final Toledo create(LaneBasedGTU gtu)
                    throws GTUException

Creates a new tactical planner for the given GTU.

Specified by:

create in interface LaneBasedTacticalPlannerFactory<Toledo>

Parameters:

gtu - LaneBasedGTU; GTU

Returns:

tactical planner for the given GTU

Throws:

GTUException - if the gtu is not suitable in any way for the creation of the tactical planner

toString

public final String toString()

Overrides:

toString in class Object