ExperimentRunner (DESMO-J 2.5.1c API)

java.lang.Object
- desmoj.extensions.experimentation.util.ExperimentRunner

All Implemented Interfaces:

Parameterizable, java.lang.Runnable, java.util.Observer
```
public class ExperimentRunner
extends java.lang.Object
implements java.util.Observer, java.lang.Runnable, Parameterizable
```
A thread a DesmoJ-Experiment can run in. The experiment runner can notifiy registered ExperimentListeners when the assigned experiment is (re)started, stopped or temporarily paused and registered SimClockListeners when the simulation clock is set forth.

Version:

DESMO-J, Ver. 2.5.1c copyright (c) 2015 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.

Author:

Nicolas Knaak, edited 6.1.2004 by Gunnar Kiesel (seperate output classes for all output Types)

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ExperimentRunner.ReportProvider
An inner class providing the experiment runner's report.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ExperimentRunner.ReportProvider` An inner class providing the experiment runner's report.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CREATED` Status: model not connected to experiment
`static java.lang.String`	`EXP_D_OUTTYPE` Experiment setting "debugOutputType"
`static java.lang.String`	`EXP_E_OUTTYPE` Experiment setting "errorOutputType"
`static java.lang.String`	`EXP_EPSILON` Experiment setting "referenceTime"
`static java.lang.String`	`EXP_NAME` Experiment setting "name"
`static java.lang.String`	`EXP_OUTPUT_PATH` Experiment setting "outputPath"
`static java.lang.String`	`EXP_R_OUTTYPE` Experiment setting "reportOutputType"
`static java.lang.String`	`EXP_RAND_EVENTS` Experiment setting "randomizeConcurrentEvents"
`static java.lang.String`	`EXP_REF_TIME` Experiment setting "referenceTime"
`static java.lang.String`	`EXP_REF_UNIT` Experiment setting "referenceUnit"
`static java.lang.String`	`EXP_SHOW_PROG_BAR` Experiment setting "showProgressBar"
`static java.lang.String`	`EXP_START_TIME` Experiment setting "startTime"
`static java.lang.String`	`EXP_STOP_TIME` Experiment setting "stopTime"
`static java.lang.String`	`EXP_T_OUTTYPE` Experiment setting "traceOutputType"
`static java.lang.String`	`EXP_TRACE_START` Experiment setting "traceStartTime"
`static java.lang.String`	`EXP_TRACE_STOP` Experiment setting "traceStopTime"
`static int`	`INITIALIZED` Status: Model created an connected but experiment not started yet
`static int`	`PAUSED` Status: Experiment temporarily paused
`static int`	`RUNNING` Status: Experiment currently running
`static int`	`STOPPED` Status: Experiment finally stopped

Constructor Summary

Constructors
Constructor and Description
`ExperimentRunner()` Creates a new experiment runner that is not connected to a model yet.
`ExperimentRunner(Model model)` Creates a new experiment runner for the given model

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addExperimentListener(ExperimentListener l)` Adds a listener to the contained experiment's running status
`void`	`addSimClockListener(SimClockListener l)` Adds a listener to the contained experiment's sim clock
`void`	`addSimRunListener(SimRunListener l)` adds a new SimRunListener.
`java.util.Map<java.lang.String,AccessPoint>`	`createParameters()` Creates a map of parameters
`SimRunListener[]`	`createSimRunListeners(GraphicalObserverContext c)` Should return a new set of listeners to the experiment run represented by the given experiment runner in an array.
`void`	`finishExperiment()` Lets the experiment report (if desired) and closes all output streams by calling `Experiment.finish()`
`long`	`getDelayMillis()` Returns the millisecond part of the delay between each step of the scheduler
`int`	`getDelayNanos()` Returns the nanosecond part of the delay between each step of the scheduler
`Experiment`	`getExperiment()`
`java.util.Map<java.lang.String,AccessPoint>`	`getExperimentSettings()`
`java.lang.Object[][]`	`getExperimentSettingsArray()` Returns an array of experiment settings for this experiment run The first row contains names, the second row contains values.
`Model`	`getModel()`
`java.lang.Object[][]`	`getModelParameterArray()` Returns an array of model parameters for this experiment run The first row contains names, the second row contains values.
`java.util.Map<java.lang.String,AccessPoint>`	`getModelParameters()`
`TimeInstant`	`getStartTime()`
`TimeInstant`	`getStopTime()`
`java.lang.Thread`	`getThread()`
`void`	`init()` Initializes the experiment before it is run in the thread
`void`	`initParameters(java.util.Map<java.lang.String,AccessPoint> expSettingsMap, java.util.Map<java.lang.String,AccessPoint> modelParamMap)` Inits the experiment runner from a map of model and experiment settings
`void`	`registerMessageReceivers()` Registers new message receivers as output channels of the experiment
`void`	`removeExperimentListener(ExperimentListener l)` Removes an experiment listener
`void`	`removeSimClockListener(SimClockListener l)` Removes a SimClock listener
`void`	`run()` Runs the contained experiment by calling it's appropriate start method
`void`	`setDelay(long millis, int nanos)` Sets the delay between each step of the scheduler.
`void`	`setModel(Model model)` Sets the current model
`void`	`setPaused(boolean pause)` (Un)pauses running the assigned experiment by requiring and releasing the semaphore tested in the experiments proceed loop.
`void`	`start()` Starts this thread and the contained experiment with start time 0.0
`void`	`stopExperiment()` Stops the experiment running in this experiment runner (forever).
`void`	`update(java.util.Observable o, java.lang.Object value)` This method is implemented for interface observer.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CREATED
```
public static final int CREATED
```
    Status: model not connected to experiment
    
    See Also:
    
    Constant Field Values
  - INITIALIZED
```
public static final int INITIALIZED
```
    Status: Model created an connected but experiment not started yet
    
    See Also:
    
    Constant Field Values
  - RUNNING
```
public static final int RUNNING
```
    Status: Experiment currently running
    
    See Also:
    
    Constant Field Values
  - PAUSED
```
public static final int PAUSED
```
    Status: Experiment temporarily paused
    
    See Also:
    
    Constant Field Values
  - STOPPED
```
public static final int STOPPED
```
    Status: Experiment finally stopped
    
    See Also:
    
    Constant Field Values
  - EXP_NAME
```
public static final java.lang.String EXP_NAME
```
    Experiment setting "name"
    
    See Also:
    
    Constant Field Values
  - EXP_OUTPUT_PATH
```
public static final java.lang.String EXP_OUTPUT_PATH
```
    Experiment setting "outputPath"
    
    See Also:
    
    Constant Field Values
  - EXP_EPSILON
```
public static final java.lang.String EXP_EPSILON
```
    Experiment setting "referenceTime"
    
    See Also:
    
    Constant Field Values
  - EXP_REF_TIME
```
public static final java.lang.String EXP_REF_TIME
```
    Experiment setting "referenceTime"
    
    See Also:
    
    Constant Field Values
  - EXP_REF_UNIT
```
public static final java.lang.String EXP_REF_UNIT
```
    Experiment setting "referenceUnit"
    
    See Also:
    
    Constant Field Values
  - EXP_START_TIME
```
public static final java.lang.String EXP_START_TIME
```
    Experiment setting "startTime"
    
    See Also:
    
    Constant Field Values
  - EXP_STOP_TIME
```
public static final java.lang.String EXP_STOP_TIME
```
    Experiment setting "stopTime"
    
    See Also:
    
    Constant Field Values
  - EXP_SHOW_PROG_BAR
```
public static final java.lang.String EXP_SHOW_PROG_BAR
```
    Experiment setting "showProgressBar"
    
    See Also:
    
    Constant Field Values
  - EXP_TRACE_START
```
public static final java.lang.String EXP_TRACE_START
```
    Experiment setting "traceStartTime"
    
    See Also:
    
    Constant Field Values
  - EXP_TRACE_STOP
```
public static final java.lang.String EXP_TRACE_STOP
```
    Experiment setting "traceStopTime"
    
    See Also:
    
    Constant Field Values
  - EXP_RAND_EVENTS
```
public static final java.lang.String EXP_RAND_EVENTS
```
    Experiment setting "randomizeConcurrentEvents"
    
    See Also:
    
    Constant Field Values
  - EXP_R_OUTTYPE
```
public static final java.lang.String EXP_R_OUTTYPE
```
    Experiment setting "reportOutputType"
    
    See Also:
    
    Constant Field Values
  - EXP_T_OUTTYPE
```
public static final java.lang.String EXP_T_OUTTYPE
```
    Experiment setting "traceOutputType"
    
    See Also:
    
    Constant Field Values
  - EXP_E_OUTTYPE
```
public static final java.lang.String EXP_E_OUTTYPE
```
    Experiment setting "errorOutputType"
    
    See Also:
    
    Constant Field Values
  - EXP_D_OUTTYPE
```
public static final java.lang.String EXP_D_OUTTYPE
```
    Experiment setting "debugOutputType"
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ExperimentRunner
```
public ExperimentRunner(Model model)
```
    Creates a new experiment runner for the given model
  - ExperimentRunner
```
public ExperimentRunner()
```
    Creates a new experiment runner that is not connected to a model yet. The model must be set consequently using the setModel() method.
- Method Detail
  - setModel
```
public void setModel(Model model)
```
    Sets the current model
    
    Parameters:
    
    model - a desmoj.Model
  - getModel
```
public Model getModel()
```
    Returns:
    
    model running in this experiment runner
  - init
```
public void init()
```
    Initializes the experiment before it is run in the thread
  - initParameters
```
public void initParameters(java.util.Map<java.lang.String,AccessPoint> expSettingsMap,
                           java.util.Map<java.lang.String,AccessPoint> modelParamMap)
```
    Inits the experiment runner from a map of model and experiment settings
    
    Parameters:
    
    expSettingsMap - map of experiment settings
    
    modelParamMap - map of model parameters
  - getExperiment
```
public Experiment getExperiment()
```
    Returns:
    
    the experiment running in this experiment runner
  - getStartTime
```
public TimeInstant getStartTime()
```
    Returns:
    
    the SimTime the current experiment starts at
  - getStopTime
```
public TimeInstant getStopTime()
```
    Returns:
    
    the time the current experiment will finally stop
  - start
```
public void start()
```
    Starts this thread and the contained experiment with start time 0.0
  - stopExperiment
```
public void stopExperiment()
```
    Stops the experiment running in this experiment runner (forever).
  - run
```
public void run()
```
    Runs the contained experiment by calling it's appropriate start method
    
    Specified by:
    
    run in interface java.lang.Runnable
  - finishExperiment
```
public void finishExperiment()
```
    Lets the experiment report (if desired) and closes all output streams by calling Experiment.finish()
  - update
```
public void update(java.util.Observable o,
                   java.lang.Object value)
```
    This method is implemented for interface observer. It is called by the assigned experiment's SimClock every time it's value is increased. The methods tests and waits for the runners semaphore. If a delay time is set, the runner sleeps for the given delay time afterwards.
    
    Specified by:
    
    update in interface java.util.Observer
    
    Parameters:
    
    o - an observable object
    
    value - the updated value
  - setPaused
```
public void setPaused(boolean pause)
```
    (Un)pauses running the assigned experiment by requiring and releasing the semaphore tested in the experiments proceed loop.
    
    Parameters:
    
    pause - boolean value indicating pause (true) or restart (false).
  - getDelayMillis
```
public long getDelayMillis()
```
    Returns the millisecond part of the delay between each step of the scheduler
    
    Returns:
    
    A long value representing the delay time in milliseconds
  - getDelayNanos
```
public int getDelayNanos()
```
    Returns the nanosecond part of the delay between each step of the scheduler
    
    Returns:
    
    A long value representing the delay time in milliseconds
  - setDelay
```
public void setDelay(long millis,
                     int nanos)
```
    Sets the delay between each step of the scheduler.
    
    Parameters:
    
    delay: - Delay time in milliseconds as a long value
  - addExperimentListener
```
public void addExperimentListener(ExperimentListener l)
```
    Adds a listener to the contained experiment's running status
  - removeExperimentListener
```
public void removeExperimentListener(ExperimentListener l)
```
    Removes an experiment listener
  - addSimClockListener
```
public void addSimClockListener(SimClockListener l)
```
    Adds a listener to the contained experiment's sim clock
  - removeSimClockListener
```
public void removeSimClockListener(SimClockListener l)
```
    Removes a SimClock listener
  - addSimRunListener
```
public void addSimRunListener(SimRunListener l)
```
    adds a new SimRunListener. Reacts only on SimClockListener and ExperimentListener objects. This method is called from ExperimentRunner.setListeners().
  - getModelParameterArray
```
public java.lang.Object[][] getModelParameterArray()
```
    Returns an array of model parameters for this experiment run The first row contains names, the second row contains values.
  - getExperimentSettingsArray
```
public java.lang.Object[][] getExperimentSettingsArray()
```
    Returns an array of experiment settings for this experiment run The first row contains names, the second row contains values.
  - getModelParameters
```
public java.util.Map<java.lang.String,AccessPoint> getModelParameters()
```
  - getExperimentSettings
```
public java.util.Map<java.lang.String,AccessPoint> getExperimentSettings()
```
  - getThread
```
public java.lang.Thread getThread()
```
  - createParameters
```
public java.util.Map<java.lang.String,AccessPoint> createParameters()
```
    Description copied from interface: Parameterizable
    
    Creates a map of parameters
    
    Specified by:
    
    createParameters in interface Parameterizable
    
    Returns:
    
    a map of experiment parameters
  - registerMessageReceivers
```
public void registerMessageReceivers()
```
    Registers new message receivers as output channels of the experiment
  - createSimRunListeners
```
public SimRunListener[] createSimRunListeners(GraphicalObserverContext c)
```
    Should return a new set of listeners to the experiment run represented by the given experiment runner in an array. Returns an array of size 0 by default.

Class ExperimentRunner

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CREATED

INITIALIZED

RUNNING

PAUSED

STOPPED

EXP_NAME

EXP_OUTPUT_PATH

EXP_EPSILON

EXP_REF_TIME

EXP_REF_UNIT

EXP_START_TIME

EXP_STOP_TIME

EXP_SHOW_PROG_BAR

EXP_TRACE_START

EXP_TRACE_STOP

EXP_RAND_EVENTS

EXP_R_OUTTYPE

EXP_T_OUTTYPE

EXP_E_OUTTYPE

EXP_D_OUTTYPE

Constructor Detail

ExperimentRunner

ExperimentRunner

Method Detail

setModel

getModel

init

initParameters

getExperiment

getStartTime

getStopTime

start

stopExperiment

run

finishExperiment

update

setPaused

getDelayMillis

getDelayNanos

setDelay

addExperimentListener

removeExperimentListener

addSimClockListener

removeSimClockListener

addSimRunListener

getModelParameterArray

getExperimentSettingsArray

getModelParameters

getExperimentSettings

getThread

createParameters

registerMessageReceivers

createSimRunListeners