MandatoryIncentive (OpenTrafficSim road classes 1.6.0 API)

All Superinterfaces:

Incentive

All Known Implementing Classes:

IncentiveBusStop, IncentiveDummy, IncentiveGetInLane, IncentiveRoute
```
public interface MandatoryIncentive
extends Incentive
```
Interface for mandatory incentives.
Copyright (c) 2013-2022 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 Apr 13, 2016

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Desire`	`determineDesire(org.opentrafficsim.base.parameters.Parameters parameters, LanePerception perception, CarFollowingModel carFollowingModel, Desire mandatoryDesire)`	Determines level of lane change desire for a lane change incentive.

- Method Detail
  - determineDesire
```
Desire determineDesire(org.opentrafficsim.base.parameters.Parameters parameters,
                       LanePerception perception,
                       CarFollowingModel carFollowingModel,
                       Desire mandatoryDesire)
                throws org.opentrafficsim.base.parameters.ParameterException,
                       OperationalPlanException
```
    Determines level of lane change desire for a lane change incentive.
    
    Parameters:
    
    parameters - Parameters; parameters
    
    perception - LanePerception; perception
    
    carFollowingModel - CarFollowingModel; car-following model
    
    mandatoryDesire - Desire; level of mandatory desire at current time
    
    Returns:
    
    level of lane change desire for this incentive
    
    Throws:
    
    org.opentrafficsim.base.parameters.ParameterException - if a parameter is not given or out of bounds
    
    OperationalPlanException - in case of a perception exception