View Javadoc
1   package org.opentrafficsim.road.gtu.generator;
2   
3   import java.util.Map;
4   
5   import nl.tudelft.simulation.dsol.animation.Locatable;
6   import nl.tudelft.simulation.language.d3.DirectedPoint;
7   
8   /**
9    * Interface for GTU generators. As generators can be quite distinct and function autonomously, this interface only regards
10   * information for animation.
11   * <p>
12   * Copyright (c) 2013-2019 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/node/13">OpenTrafficSim License</a>.
14   * <p>
15   * @version $Revision$, $LastChangedDate$, by $Author$, initial version 11 jan. 2018 <br>
16   * @author <a href="http://www.tbm.tudelft.nl/averbraeck">Alexander Verbraeck</a>
17   * @author <a href="http://www.tudelft.nl/pknoppers">Peter Knoppers</a>
18   * @author <a href="http://www.transport.citg.tudelft.nl">Wouter Schakel</a>
19   */
20  public interface GTUGenerator extends Locatable
21  {
22  
23      /**
24       * Returns the locations and lengths of generation queues. Note that the provided location may differ from the generator
25       * location, as one generator may generate GTU's at different points.
26       * @return Map&lt;DirectedPoint, Integer&gt;; locations and lengths of generation queues
27       */
28      Map<DirectedPoint, Integer> getQueueLengths();
29  
30  }