1 package org.opentrafficsim.road.gtu.lane.perception;
2
3 import java.util.Optional;
4
5 import org.opentrafficsim.base.parameters.ParameterException;
6 import org.opentrafficsim.core.gtu.perception.Perception;
7 import org.opentrafficsim.road.gtu.lane.LaneBasedGtu;
8 import org.opentrafficsim.road.gtu.lane.perception.mental.Mental;
9 import org.opentrafficsim.road.gtu.lane.perception.structure.LaneStructure;
10
11 /**
12 * Interface for perception in a lane-based model. The following information can be perceived:
13 * <p>
14 * Copyright (c) 2013-2024 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. <br>
15 * BSD-style license. See <a href="https://opentrafficsim.org/docs/license.html">OpenTrafficSim License</a>.
16 * </p>
17 * @author <a href="https://github.com/averbraeck">Alexander Verbraeck</a>
18 * @author <a href="https://github.com/peter-knoppers">Peter Knoppers</a>
19 * @author <a href="https://github.com/wjschakel">Wouter Schakel</a>
20 */
21 public interface LanePerception extends Perception<LaneBasedGtu>
22 {
23
24 /**
25 * Return the lane structure.
26 * @return lane structure.
27 * @throws ParameterException on exception.
28 */
29 LaneStructure getLaneStructure() throws ParameterException;
30
31 /**
32 * Returns the mental module of perception.
33 * @return mental module of perception, may be empty if not used
34 */
35 Optional<Mental> getMental();
36
37 }