View Javadoc
1   package org.opentrafficsim.road.gtu.lane.tactical.routesystem;
2   
3   import java.util.SortedSet;
4   
5   import org.djunits.value.vdouble.scalar.Length;
6   import org.opentrafficsim.core.gtu.GTUType;
7   import org.opentrafficsim.core.network.route.Route;
8   import org.opentrafficsim.road.network.lane.DirectedLanePosition;
9   
10  /**
11   * A route system supplies information on the number of lane changes and distance within which this has to be performed.
12   * <p>
13   * Copyright (c) 2013-2019 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. <br>
14   * BSD-style license. See <a href="http://opentrafficsim.org/node/13">OpenTrafficSim License</a>.
15   * <p>
16   * @version $Revision$, $LastChangedDate$, by $Author$, initial version 25 okt. 2019 <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 RouteSystem
22  {
23  
24      /**
25       * Returns lane change information from a position over a given length, according to a route and GTU type. The distance
26       * concerns the distance within which the lane change has to be performed. Due to lane markings, the actual split may be
27       * beyond the distance.
28       * @param position DirectedLanePosition; position
29       * @param front Length; distance required for the front (relative to reference position)
30       * @param route Route; route, may be {@code null}
31       * @param gtuType GTUType; GTU type
32       * @param distance Length; distance over which required lane changes are desired to be known
33       * @return SortedSet&lt;LaneChangeInfo&gt;; lane change information
34       */
35      SortedSet<LaneChangeInfo> getLaneChangeInfo(DirectedLanePosition position, Length front, Route route, GTUType gtuType,
36          Length distance);
37  
38      // public void clearCache();
39  }