edu.ntnu.ecosim.communication
Class EcoSim

java.lang.Object
  extended by edu.ntnu.ecosim.communication.EcoSim
All Implemented Interfaces:
java.io.Serializable

public class EcoSim
extends java.lang.Object
implements java.io.Serializable

The Class EcoSim. This is the interface toward the simulator, and is used to setup, start, stop and reset the simulation.

See Also:
Serialized Form

Constructor Summary
EcoSim(ResultReceiver rr)
          The Constructor.
EcoSim(ResultReceiver rr, java.lang.String configpath)
          The Constructor to be used by external applications that need to define the file path of the configuration file
 
Method Summary
 void resetSim()
          Reset the simulator.
 void setupSim(org.w3c.dom.Document setup)
          Setup the simulator.
 void startSim()
          Start the simulator.
 void stopSim()
          Stop the simulator.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EcoSim

public EcoSim(ResultReceiver rr)
The Constructor.

Parameters:
rr - the ResultReceiver to respond to

EcoSim

public EcoSim(ResultReceiver rr,
              java.lang.String configpath)
The Constructor to be used by external applications that need to define the file path of the configuration file. - This is the preferred constructor -

Parameters:
rr - the ResultReceiver to respond to
configpath - the file path to the configuration file
Method Detail

setupSim

public void setupSim(org.w3c.dom.Document setup)
Setup the simulator.

Parameters:
setup - the Document containing setup information

startSim

public void startSim()
Start the simulator.


stopSim

public void stopSim()
Stop the simulator.


resetSim

public void resetSim()
Reset the simulator.