View Javadoc

1   /*
2    * @(#)ModelInterface.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;
11  
12  import java.io.Serializable;
13  import java.rmi.RemoteException;
14  
15  import nl.tudelft.simulation.dsol.simulators.SimulatorInterface;
16  
17  /***
18   * The model interface defines the model object. *
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.4 2004-03-26
30   * @since 1.3
31   */
32  public interface ModelInterface extends Serializable
33  {
34  	/***
35  	 * construct a model on a simulator
36  	 * 
37  	 * @param simulator is the simulator
38  	 * @throws SimRuntimeException on model failure
39  	 * @throws RemoteException on network failure
40  	 */
41  	void constructModel(SimulatorInterface simulator)
42  			throws SimRuntimeException, RemoteException;
43  }