View Javadoc
1   package org.opentrafficsim.road.gtu.lane.tactical.following;
2   
3   import org.djunits.value.vdouble.scalar.Speed;
4   import org.opentrafficsim.base.parameters.ParameterException;
5   import org.opentrafficsim.base.parameters.Parameters;
6   import org.opentrafficsim.road.network.speed.SpeedLimitInfo;
7   
8   /**
9    * Desired speed model.
10   * <p>
11   * Copyright (c) 2013-2019 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. <br>
12   * BSD-style license. See <a href="http://opentrafficsim.org/node/13">OpenTrafficSim License</a>.
13   * <p>
14   * @version $Revision$, $LastChangedDate$, by $Author$, initial version 1 nov. 2017 <br>
15   * @author <a href="http://www.tbm.tudelft.nl/averbraeck">Alexander Verbraeck</a>
16   * @author <a href="http://www.tudelft.nl/pknoppers">Peter Knoppers</a>
17   * @author <a href="http://www.transport.citg.tudelft.nl">Wouter Schakel</a>
18   */
19  public interface DesiredSpeedModel
20  {
21  
22      /**
23       * Determines the desired speed.
24       * @param parameters Parameters; parameters
25       * @param speedInfo SpeedLimitInfo; info regarding the desired speed for car-following
26       * @throws ParameterException if parameter exception occurs
27       * @return desired speed
28       */
29      Speed desiredSpeed(Parameters parameters, SpeedLimitInfo speedInfo) throws ParameterException;
30  
31  }