View Javadoc
1   package org.opentrafficsim.road.gtu.generator.characteristics;
2   
3   import org.opentrafficsim.base.parameters.ParameterException;
4   import org.opentrafficsim.core.distributions.ProbabilityException;
5   import org.opentrafficsim.core.gtu.GTUException;
6   
7   /**
8    * Interface for objects that can generate a LaneBasedGTUCharacteristics object.
9    * <p>
10   * Copyright (c) 2013-2019 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. <br>
11   * BSD-style license. See <a href="http://opentrafficsim.org/docs/current/license.html">OpenTrafficSim License</a>.
12   * <p>
13   * @version $Revision$, $LastChangedDate$, by $Author$, initial version Mar 9, 2016 <br>
14   * @author <a href="http://www.tbm.tudelft.nl/averbraeck">Alexander Verbraeck</a>
15   * @author <a href="http://www.tudelft.nl/pknoppers">Peter Knoppers</a>
16   */
17  public interface LaneBasedGTUCharacteristicsGenerator
18  {
19      /**
20       * Generate a LaneBasedGTUCharacteristics object.
21       * @return LaneBasedGTUCharacteristics
22       * @throws ProbabilityException when the generator is improperly configured
23       * @throws ParameterException in case of a parameter problem.
24       * @throws GTUException if strategical planner cannot be created
25       */
26      LaneBasedGTUCharacteristics draw() throws ProbabilityException, ParameterException, GTUException;
27  
28  }