View Javadoc

    1   /*
    2    * @(#)AnimatorInterface.java Aug 18, 2003
    3    *
    4    * Copyright (c) 2003 Delft University of Technology Jaffalaan 5, 2628 BX Delft,
    5    * 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  package nl.tudelft.simulation.dsol.simulators;
    11
    12  import java.rmi.RemoteException;
    13
    14  import nl.tudelft.simulation.event.EventType;
    15
    16  /***
    17   * The AnimatorInterface defines a DEVSDESS simulator with wallclock delay
    18   * between the consequtive time steps.
    19   * <p>
    20   * (c) copyright 2003 <a href="http://www.simulation.tudelft.nl">Delft
    21   * University of Technology </a>, the Netherlands. <br>
    22   * See for project information <a href="http://www.simulation.tudelft.nl">
    23   * www.simulation.tudelft.nl </a> <br>
    24   * License of use: <a href="http://www.gnu.org/copyleft/gpl.html">General Public
    25   * License (GPL) </a>, no warranty <br>
    26   *
    27   * @author <a href="http://www.simulation.tudelft.nl/people/jacobs.html">Peter
    28   *         Jacobs </a>
    29   * @version 1.10 2004-03-26
    30   * @since 1.0
    31   */
    32  public interface AnimatorInterface extends DEVDESSSimulatorInterface
    33  {
    34  	/*** DEFAULT_ANIMATION_DELAY of 0 miliseconds used in the animator */
    35  	long DEFAULT_ANIMATION_DELAY = 0L;
    36
    37  	/*** UPDATE_ANIMATION_EVENT is fired to wake up animatable components */
    38  	EventType UPDATE_ANIMATION_EVENT = new EventType("UPDATE_ANIMATION_EVENT");
    39
    40  	/*** ANIMATION_DELAY_CHANGED_EVENT is fired when the time step is set */
    41  	EventType ANIMATION_DELAY_CHANGED_EVENT = new EventType(
    42  			"ANIMATION_DELAY_CHANGED_EVENT");
    43
    44  	/***
    45  	 * returns the animation delay between each consequtive timestep
    46  	 *
    47  	 * @return the animaiton delay in milliseconds wallclock
    48  	 * @throws RemoteException on network failure
    49  	 */
    50  	long getAnimationDelay() throws RemoteException;
    51
    52  	/***
    53  	 * sets the animationDelay
    54  	 *
    55  	 * @param miliseconds the animation delay
    56  	 * @throws RemoteException on network failure
    57  	 */
    58  	void setAnimationDelay(long miliseconds) throws RemoteException;
    59  }