View Javadoc

    1   /*
    2    * @(#)DESSSimulatorInterface.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 DESS defines the interface of the DESS simulator. DESS stands for the
    18   * Differential Equation System Specification. More information on Modeling &
    19   * Simulation can be found in "Theory of Modeling and Simulation" by Bernard
    20   * Zeigler et. al.
    21   * <p>
    22   * (c) copyright 2003 <a href="http://www.simulation.tudelft.nl">Delft
    23   * University of Technology </a>, the Netherlands. <br>
    24   * See for project information <a href="http://www.simulation.tudelft.nl">
    25   * www.simulation.tudelft.nl </a> <br>
    26   * License of use: <a href="http://www.gnu.org/copyleft/gpl.html">General Public
    27   * License (GPL) </a>, no warranty <br>
    28   *
    29   * @author <a href="http://www.simulation.tudelft.nl/people/jacobs.html">Peter
    30   *         Jacobs </a>
    31   * @version 1.8 2004-03-18
    32   * @since 1.0
    33   */
    34
    35  public interface DESSSimulatorInterface extends SimulatorInterface
    36  {
    37  	/*** TIME_STEP_CHANGED_EVENT is fired when the time step is set */
    38  	EventType TIME_STEP_CHANGED_EVENT = new EventType("TIME_STEP_CHANGED_EVENT");
    39
    40  	/*** DEFAULT_TIME_STEP represents the default timestep for the simulator */
    41  	double DEFAULT_TIME_STEP = 0.1;
    42
    43  	/***
    44  	 * returns the time step of the DESS simulator
    45  	 *
    46  	 * @return the timeStep
    47  	 * @throws RemoteException on network failure
    48  	 */
    49  	double getTimeStep() throws RemoteException;
    50
    51  	/***
    52  	 * Method setTimeStep sets the time step of the simulator
    53  	 *
    54  	 * @param timeStep the new timeStep. Its value should be >0.0
    55  	 * @throws RemoteException on network failure
    56  	 */
    57  	void setTimeStep(double timeStep) throws RemoteException;
    58  }