View Javadoc
1   package org.opentrafficsim.road.gtu.lane.perception;
2   
3   import org.opentrafficsim.base.parameters.ParameterException;
4   import org.opentrafficsim.core.gtu.GTUException;
5   import org.opentrafficsim.core.gtu.perception.Perception;
6   import org.opentrafficsim.road.gtu.lane.LaneBasedGTU;
7   import org.opentrafficsim.road.gtu.lane.perception.mental.Mental;
8   
9   /**
10   * Interface for perception in a lane-based model. The following information can be perceived:
11   * <p>
12   * Copyright (c) 2013-2018 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. <br>
13   * BSD-style license. See <a href="http://opentrafficsim.org/docs/license.html">OpenTrafficSim License</a>.
14   * </p>
15   * $LastChangedDate: 2015-07-24 02:58:59 +0200 (Fri, 24 Jul 2015) $, @version $Revision: 1147 $, by $Author: averbraeck $,
16   * initial version Jan 30, 2016 <br>
17   * @author <a href="http://www.tbm.tudelft.nl/averbraeck">Alexander Verbraeck</a>
18   * @author <a href="http://www.tudelft.nl/pknoppers">Peter Knoppers</a>
19   * @author <a href="http://www.transport.citg.tudelft.nl">Wouter Schakel</a>
20   */
21  public interface LanePerception extends Perception<LaneBasedGTU>
22  {
23  
24      /** {@inheritDoc} */
25      @Override
26      LaneBasedGTU getGtu() throws GTUException;
27  
28      /**
29       * @return lane structure to perform perception
30       * @throws ParameterException if parameter is not defined
31       */
32      LaneStructure getLaneStructure() throws ParameterException;
33  
34      /**
35       * Returns the mental module of perception.
36       * @return Mental; mental module of perception, may be {@code null} if not used
37       */
38      Mental getMental();
39  
40  }