1 package org.opentrafficsim.road.gtu.generator.characteristics;
2
3 import org.opentrafficsim.core.gtu.GtuException;
4 import org.opentrafficsim.core.network.Node;
5 import org.opentrafficsim.road.od.Category;
6
7 import nl.tudelft.simulation.jstats.streams.StreamInterface;
8
9 /**
10 * Interface for classes that generate GTU characteristics based on OD information. Additional to
11 * {@code LaneBasedGtuCharacteristicsGenerator} this class draws based on origin, destination, category, and a random stream.
12 * <p>
13 * Copyright (c) 2013-2024 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. <br>
14 * BSD-style license. See <a href="https://opentrafficsim.org/docs/license.html">OpenTrafficSim License</a>.
15 * </p>
16 * @author <a href="https://github.com/averbraeck">Alexander Verbraeck</a>
17 * @author <a href="https://tudelft.nl/staff/p.knoppers-1">Peter Knoppers</a>
18 * @author <a href="https://github.com/wjschakel">Wouter Schakel</a>
19 */
20 @FunctionalInterface
21 public interface LaneBasedGtuCharacteristicsGeneratorOd
22 {
23
24 /**
25 * Generate new {@code LaneBasedGtuCharacteristics} using given input from OD.
26 * @param origin Node; origin
27 * @param destination Node; destination
28 * @param category Category; category (GTU type, route, or more)
29 * @param randomStream StreamInterface; stream for random numbers
30 * @return LaneBasedGtuCharacteristics
31 * @throws GtuException if characteristics could not be generated for the GTUException
32 */
33 LaneBasedGtuCharacteristics draw(Node origin, Node destination, Category category, StreamInterface randomStream)
34 throws GtuException;
35
36 }