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

Class LmrsFactory

java.lang.Object

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

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

All Implemented Interfaces:

Serializable, LaneBasedTacticalPlannerFactory<Lmrs>, ModelComponentFactory

public class LmrsFactory
extends AbstractLaneBasedTacticalPlannerFactory<Lmrs>
implements Serializable

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

See Also:

• Serialized Form

Constructor Summary

Constructors

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

Method Summary

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

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

LmrsFactory

public LmrsFactory(CarFollowingModelFactory<? extends CarFollowingModel> carFollowingModelFactory,
 PerceptionFactory perceptionFactory)

Constructor using default incentives and passive synchronization.

Parameters:

carFollowingModelFactory - factory of the car-following model

perceptionFactory - perception factory

LmrsFactory

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

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 org.opentrafficsim.base.parameters.Parameters getParameters()
                                                                  throws org.opentrafficsim.base.parameters.ParameterException

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.

Specified by:

getParameters in interface ModelComponentFactory

Returns:

parameters for the given component

Throws:

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

create

public final Lmrs create(LaneBasedGtu gtu)
                  throws GtuException

Description copied from interface: LaneBasedTacticalPlannerFactory

Creates a new tactical planner for the given GTU.

Specified by:

create in interface LaneBasedTacticalPlannerFactory<Lmrs>

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

Overrides:

toString in class Object