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

Class LmrsFactoryOld

java.lang.Object

org.opentrafficsim.road.gtu.lane.tactical.AbstractLaneBasedTacticalPlannerFactory<Lmrs>

org.opentrafficsim.road.gtu.lane.tactical.lmrs.LmrsFactoryOld

All Implemented Interfaces:

LaneBasedTacticalPlannerFactory<Lmrs>, ModelComponentFactory

@Deprecated
public class LmrsFactoryOld
extends AbstractLaneBasedTacticalPlannerFactory<Lmrs>

Deprecated.

Factory for a tactical planner using LMRS with any car-following model.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LmrsFactoryOld.Factory	Deprecated.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LmrsFactoryOld(CarFollowingModelFactory<? extends CarFollowingModel> carFollowingModelFactory, PerceptionFactory perceptionFactory, Synchronization synchronization, Cooperation cooperation, GapAcceptance gapAcceptance, Tailgating tailgating, Set<Supplier<? extends MandatoryIncentive>> mandatoryIncentives, Set<Supplier<? extends VoluntaryIncentive>> voluntaryIncentives, Set<Supplier<? extends AccelerationIncentive>> accelerationIncentives)	Deprecated. Constructor with full control over incentives and type of synchronization.

Method Summary

Modifier and Type	Method	Description
final Lmrs	create(LaneBasedGtu gtu)	Deprecated. Creates a new tactical planner for the given GTU.
final Parameters	getParameters(GtuType gtuType)	Deprecated. Returns parameters for the given component.
final String	toString()	Deprecated.

Methods inherited from class org.opentrafficsim.road.gtu.lane.tactical.AbstractLaneBasedTacticalPlannerFactory

getCarFollowingModelFactoryString, getCarFollowingParameters, getPerceptionFactory, nextCarFollowingModel, peekDesiredHeadway, peekDesiredSpeed

Methods inherited from class java.lang.Object

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

Constructor Details

LmrsFactoryOld

protected LmrsFactoryOld(CarFollowingModelFactory<? extends CarFollowingModel> carFollowingModelFactory,
 PerceptionFactory perceptionFactory,
 Synchronization synchronization,
 Cooperation cooperation,
 GapAcceptance gapAcceptance,
 Tailgating tailgating,
 Set<Supplier<? extends MandatoryIncentive>> mandatoryIncentives,
 Set<Supplier<? extends VoluntaryIncentive>> voluntaryIncentives,
 Set<Supplier<? extends AccelerationIncentive>> accelerationIncentives)

Deprecated.

Constructor with full control over incentives and type of synchronization.

Parameters:

carFollowingModelFactory - factory of the car-following model

perceptionFactory - perception factory

synchronization - type of synchronization

cooperation - type of cooperation

gapAcceptance - gap-acceptance

tailgating - tail gating

mandatoryIncentives - note that order may matter

voluntaryIncentives - note that order may matter

accelerationIncentives - acceleration incentives

Method Details

getParameters

public final Parameters getParameters(GtuType gtuType)
                               throws ParameterException

Deprecated.

Description copied from interface: ModelComponentFactory

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.

Because high-level model components might determine what low-level components to use depending on GTU type, and hence which parameters might be required, the GTU type is given as input. Many components will however not need it to return the required parameters.

Parameters:

gtuType - GTU type

Returns:

parameters for the given component

Throws:

ParameterException - on parameter exception

create

public final Lmrs create(LaneBasedGtu gtu)
                  throws GtuException

Deprecated.

Description copied from interface: LaneBasedTacticalPlannerFactory

Creates a new tactical planner for the given GTU.

Parameters:

gtu - 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()

Deprecated.

Overrides:

toString in class Object