View Javadoc
1   package org.opentrafficsim.road.gtu.lane.tactical.util.lmrs;
2   
3   import org.opentrafficsim.base.parameters.ParameterException;
4   import org.opentrafficsim.base.parameters.Parameters;
5   import org.opentrafficsim.core.gtu.plan.operational.OperationalPlanException;
6   import org.opentrafficsim.road.gtu.lane.perception.LanePerception;
7   import org.opentrafficsim.road.gtu.lane.tactical.following.CarFollowingModel;
8   
9   /**
10   * Interface for voluntary incentives.
11   * <p>
12   * Copyright (c) 2013-2019 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. <br>
13   * BSD-style license. See <a href="http://opentrafficsim.org/docs/current/license.html">OpenTrafficSim License</a>.
14   * <p>
15   * @version $Revision$, $LastChangedDate$, by $Author$, initial version Apr 13, 2016 <br>
16   * @author <a href="http://www.tbm.tudelft.nl/averbraeck">Alexander Verbraeck</a>
17   * @author <a href="http://www.tudelft.nl/pknoppers">Peter Knoppers</a>
18   * @author <a href="http://www.transport.citg.tudelft.nl">Wouter Schakel</a>
19   */
20  public interface VoluntaryIncentive extends Incentive
21  {
22  
23      /**
24       * Determines level of lane change desire for a lane change incentive.
25       * @param parameters Parameters; parameters
26       * @param perception LanePerception; perception
27       * @param carFollowingModel CarFollowingModel; car-following model
28       * @param mandatoryDesire Desire; level of mandatory desire at current time
29       * @param voluntaryDesire Desire; level of voluntary desire at current time, of voluntary incentives calculated before
30       * @return level of lane change desire for this incentive
31       * @throws ParameterException if a parameter is not given or out of bounds
32       * @throws OperationalPlanException in case of a perception exception
33       */
34      Desire determineDesire(Parameters parameters, LanePerception perception, CarFollowingModel carFollowingModel,
35              Desire mandatoryDesire, Desire voluntaryDesire) throws ParameterException, OperationalPlanException;
36  
37  }