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. This interface adds beyond
9 * {@code Generator<LaneBasedGtuCharacteristics>} that the underlying implementation can throw a {@code GtuException}.
10 * <p>
11 * Copyright (c) 2013-2024 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. <br>
12 * BSD-style license. See <a href="https://opentrafficsim.org/docs/license.html">OpenTrafficSim License</a>.
13 * </p>
14 * @author <a href="https://github.com/averbraeck">Alexander Verbraeck</a>
15 * @author <a href="https://tudelft.nl/staff/p.knoppers-1">Peter Knoppers</a>
16 */
17 @FunctionalInterface
18 public interface LaneBasedGtuCharacteristicsGenerator
19 {
20
21 /**
22 * Generate a {@code LaneBasedGtuCharacteristics} object.
23 * @return LaneBasedGtuCharacteristics
24 * @throws ProbabilityException when the generator is improperly configured
25 * @throws ParameterException in case of a parameter problem.
26 * @throws GtuException if strategical planner cannot be created
27 */
28 LaneBasedGtuCharacteristics draw() throws ProbabilityException, ParameterException, GtuException;
29
30 }