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