desmoj.extensions.experimentation.ui

Class ExperimentStarter

java.lang.Object

desmoj.extensions.experimentation.ui.ExperimentStarter

All Implemented Interfaces:

ExperimentListener, SimClockListener, SimRunListener, java.util.EventListener

public class ExperimentStarter
extends java.lang.Object
implements SimClockListener, ExperimentListener

A simple DESMO-J experimentation environment to use in connection with a GUI. These GUI's must implement the Interface ExperimentStarterGUI.

Version:

DESMO-J, Ver. 2.5.1c copyright (c) 2015

Author:

Nicolas Knaak, Ruth Meyer, Gunnar Kiesel Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Constructor Summary

Constructors

Constructor and Description
ExperimentStarter(ExperimentStarterGUI gui) Creates a new Launcher with the default title
ExperimentStarter(ExperimentStarterGUI gui, java.lang.Class modelClass, java.lang.Class expRunnerClass) Creates a new Launcher and sets the current ModelFactory
ExperimentStarter(ExperimentStarterGUI gui, java.lang.Class modelClass, java.lang.Class expRunnerClass, java.lang.String[] args) Creates a new Launcher and sets the current ModelFactory such a command line parameters are passed to the model.
ExperimentStarter(ExperimentStarterGUI gui, java.lang.String confFileName) Creates Launcher with an experiment- or batchfile

Method Summary

Modifier and Type	Method and Description
void	clockAdvanced(SimRunEvent e) Called when the currently active experiment's SimClock is advanced
void	experimentPaused(SimRunEvent e) Called when experiment is paused.
void	experimentRunning(SimRunEvent e) Called when experiment is started or resumed.
void	experimentStopped(SimRunEvent e) Called when experiment is stopped.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExperimentStarter

public ExperimentStarter(ExperimentStarterGUI gui)

Creates a new Launcher with the default title

Parameters:

gui - ExperimentStarterGUI: the GUI to be used with the ExperimentStarter

ExperimentStarter

public ExperimentStarter(ExperimentStarterGUI gui,
                         java.lang.Class modelClass,
                         java.lang.Class expRunnerClass)

Creates a new Launcher and sets the current ModelFactory

Parameters:

gui - ExperimentStarterGUI: the GUI to be used with the ExperimentStarter

modelClass - Class: The Class the contains the Model to be run with the ExperimentStarter. Must be a subclass of Model

expRunnerClass - Class: Must refer to the RunnerClass that belongs to modelClass

ExperimentStarter

public ExperimentStarter(ExperimentStarterGUI gui,
                         java.lang.Class modelClass,
                         java.lang.Class expRunnerClass,
                         java.lang.String[] args)

Creates a new Launcher and sets the current ModelFactory such a command line parameters are passed to the model.

Parameters:

gui - ExperimentStarterGUI: the GUI to be used with the ExperimentStarter

modelClass - Class: The Class the contains the Model to be run with the ExperimentStarter. Must be a subclass of Model

expRunnerClass - Class: Must refer to the RunnerClass that belongs to modelClass

args - String[]: Command line parameters to pass to the model; will be made available to the model via its parameter manager as cmdparam

ExperimentStarter

public ExperimentStarter(ExperimentStarterGUI gui,
                         java.lang.String confFileName)

Creates Launcher with an experiment- or batchfile

Parameters:

gui - ExperimentStarterGUI: the GUI to be used with the ExperimentStarter

confFileName - Sring: must refer to an XML-File that contains the information for the batch run.

Method Detail

clockAdvanced

public void clockAdvanced(SimRunEvent e)

Called when the currently active experiment's SimClock is advanced

Specified by:

clockAdvanced in interface SimClockListener

Parameters:

e - SimRunEvent: A SimRunEvent.

experimentRunning

public void experimentRunning(SimRunEvent e)

Called when experiment is started or resumed. Implemented for ExperimentListener

Specified by:

experimentRunning in interface ExperimentListener

experimentStopped

public void experimentStopped(SimRunEvent e)

Called when experiment is stopped. Implemented for ExperimentListener

Specified by:

experimentStopped in interface ExperimentListener

experimentPaused

public void experimentPaused(SimRunEvent e)

Called when experiment is paused. Implemented for ExperimentListener

Specified by:

experimentPaused in interface ExperimentListener