View Javadoc

1   /*
2    * Created on Dec 18, 2003
3    * 
4    * Copyright (c) 2003, 2004 Delft University of Technology Jaffalaan 5, 2628 BX
5    * Delft, the Netherlands All rights reserved.
6    * 
7    * This software is proprietary information of Delft University of Technology
8    * The code is published under the General Public License
9    */
10  
11  package nl.tudelft.simulation.traffic.controlpoint.virtual;
12  
13  import nl.tudelft.simulation.event.EventType;
14  import nl.tudelft.simulation.traffic.controlpoint.real.VisibleControlPointInterface;
15  
16  /***
17   * This interface defines the behavior of show classes. A show is a controlPoint
18   * which makes makes the visibleControlPoint associated with this show (the
19   * owner) visible to the vehicle that passes the show. The owner has one and
20   * only one show for each and every path along which it can be reached. <br>
21   * <br>
22   * 
23   * @author J.H. Kwakkel & H.W.G. Phaff
24   */
25  public interface ShowInterface extends VirtualControlPointInterface
26  {
27      /***
28       * This event signals the owner becoming visible. It is fired when a vehicle
29       * passes over this controlPoint.
30       */
31      public static final EventType VISIBLE = new EventType("Show.VISIBLE");
32  
33      /***
34       * Returns the ControlPointInterface to be made visible
35       * 
36       * @return Owner, the visibleControlPoint to
37       */
38      public VisibleControlPointInterface getOwner();
39  }