desmoj.extensions.experimentation.ui

Interface ExperimentStarterGUI

All Known Implementing Classes:

ExperimentStarterApplet, ExperimentStarterApplication

public interface ExperimentStarterGUI

Interface for graphical user interfaces for the Experiment Starter. This is Interface is used by ExperimentStarter

Version:

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

Author:

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.

Method Summary

Modifier and Type	Method and Description
void	clockAdvanced(java.lang.String currentTime, double timePercent, long startTime) Called by ExperimentStarter when the currently active experiment's SimClock is advanced
java.lang.String	loadDialog(java.lang.String currentFilename) should open a new FileDialog to load a File and return the new filename if no new filename is given currentFilename should be returned
void	loadModel() Called by ExperimentStarter when a new Model shall be loaded
void	resetGUI(java.lang.String filename, boolean runsBatch, AccessPointTableModel modelAccessPoints, AccessPointTableModel expAccessPoints, java.lang.String modelName) should reset the gui to start settings
java.lang.String	saveDialog(java.lang.String currentFilename) should open a new FileDialog to save a File currentFilename should be preselected if no new filename is given null should be returned
void	setPaused() should set all buttons etc. for a paused experiment
void	setRunning() should set all buttons etc. for a running experiment
void	setStopped(java.lang.String currentTime, long startTime, java.lang.String experimentValues, java.lang.String outputPath, java.lang.String[] appendixes) should set all buttons etc. for a stopped experiment

Method Detail

resetGUI

void resetGUI(java.lang.String filename,
              boolean runsBatch,
              AccessPointTableModel modelAccessPoints,
              AccessPointTableModel expAccessPoints,
              java.lang.String modelName)

should reset the gui to start settings

Parameters:

filename - String: the name of the configuration file in use

runsBatch - boolean: true if a batch run is to be made, false for single experiment runs

modelAccessPoints - AccessPointTableModel: the access points for the model settings

expAccessPoints - AccessPointTableModel: the access points for the experiment settings

modelName - Sting: the name of the model in use

clockAdvanced

void clockAdvanced(java.lang.String currentTime,
                   double timePercent,
                   long startTime)

Called by ExperimentStarter when the currently active experiment's SimClock is advanced

Parameters:

currentTime - String: the current simulation time

timePercent - double: percentage of the simulation done

startTime - long: the start time of the simulation

loadModel

void loadModel()

Called by ExperimentStarter when a new Model shall be loaded

loadDialog

java.lang.String loadDialog(java.lang.String currentFilename)

should open a new FileDialog to load a File and return the new filename if no new filename is given currentFilename should be returned

Parameters:

currentFilename - String: the filename of the configuration in use

saveDialog

java.lang.String saveDialog(java.lang.String currentFilename)

should open a new FileDialog to save a File currentFilename should be preselected if no new filename is given null should be returned

Parameters:

currentFilename - String: the filename of the configuration in use

setRunning

void setRunning()

should set all buttons etc. for a running experiment

setStopped

void setStopped(java.lang.String currentTime,
                long startTime,
                java.lang.String experimentValues,
                java.lang.String outputPath,
                java.lang.String[] appendixes)

should set all buttons etc. for a stopped experiment

Parameters:

currentTime - String: the current simulation time

startTime - long: the starting time of the experiment run

experimentValues - String: the current values of the experiment parameters

outputPath - String: the path the experiment output is written to

appendixes - String[]: the file endings of the four output files (.html, .txt, .xml)

setPaused

void setPaused()

should set all buttons etc. for a paused experiment