1 package org.opentrafficsim.road.gtu.generator.characteristics;
2
3 import org.opentrafficsim.base.parameters.ParameterException;
4 import org.opentrafficsim.core.gtu.GtuException;
5
6 /**
7 * Interface for objects that can generate a LaneBasedGtuCharacteristics object. This interface adds beyond
8 * {@code Generator<LaneBasedGtuCharacteristics>} that the underlying implementation can throw a {@code GtuException}.
9 * <p>
10 * Copyright (c) 2013-2024 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. <br>
11 * BSD-style license. See <a href="https://opentrafficsim.org/docs/license.html">OpenTrafficSim License</a>.
12 * </p>
13 * @author <a href="https://github.com/averbraeck">Alexander Verbraeck</a>
14 * @author <a href="https://github.com/peter-knoppers">Peter Knoppers</a>
15 */
16 @FunctionalInterface
17 public interface LaneBasedGtuCharacteristicsGenerator
18 {
19
20 /**
21 * Generate a {@code LaneBasedGtuCharacteristics} object.
22 * @return LaneBasedGtuCharacteristics
23 * @throws ParameterException in case of a parameter problem.
24 * @throws GtuException if strategical planner cannot be created
25 */
26 LaneBasedGtuCharacteristics draw() throws ParameterException, GtuException;
27
28 }