1 package org.opentrafficsim.road.gtu.lane.tactical.util.lmrs;
2
3 import org.opentrafficsim.core.gtu.behavioralcharacteristics.BehavioralCharacteristics;
4 import org.opentrafficsim.core.gtu.behavioralcharacteristics.ParameterException;
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-2016 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
21 {
22
23 /**
24 * Determines level of lane change desire for a lane change incentive.
25 * @param behavioralCharacteristics behavioral characteristics
26 * @param perception perception
27 * @param carFollowingModel car-following model
28 * @param mandatoryDesire level of mandatory desire at current time
29 * @param voluntaryDesire 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(final BehavioralCharacteristics behavioralCharacteristics, final LanePerception perception,
35 final CarFollowingModel carFollowingModel, Desire mandatoryDesire, Desire voluntaryDesire)
36 throws ParameterException, OperationalPlanException;
37
38 }