Experiment (DESMO-J 2.5.1c API)

java.lang.Object
- desmoj.core.simulator.NamedObject
- - desmoj.core.simulator.Experiment

```
public class Experiment
extends NamedObject
```
Experiment is the class that provides the infrastructure for running the simulation of a model. It contains all data structures necessary to simulate the model and takes care of all necessary output. To actually run an experiment, a new instance of the experiment class and a new instance of the desired model have to be created. To link both instances, call the connectToExperiment(Experiment e) method of the model instance and pass the new experiment as a parameter.

Version:

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

Author:

Tim Lechler, modified by Soenke Claassen, Ruth Meyer, Nicolas Knaak, Gunnar Kiesel,Felix Klueckmann 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., Xiufeng Li

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ABORTED` Status of an Experiment finished and to be cleared.
`static int`	`CONNECTED` Status of an Experiment connected to a Model and ready to be started.
`static java.lang.String`	`DEFAULT_DEBUG_OUTPUT_TYPE` The default debug output
`static java.lang.String`	`DEFAULT_ERROR_OUTPUT_TYPE` The default error output
`static java.lang.String`	`DEFAULT_REPORT_OUTPUT_TYPE` The default report output
`static java.lang.String`	`DEFAULT_TRACE_OUTPUT_TYPE` The default trace output
`static int`	`INITIALIZED` Status of an Experiment instantiated with all needed accessories available.
`static int`	`NOT_INITIALIZED` Status of an Experiment just created without any accessories created yet.
`static int`	`RUNNING` Status of an Experiment currently running the simulation.
`static int`	`STARTED` Status of an Experiment being started.
`static int`	`STOPPED` Status of an Experiment stopped after having run.

Constructor Summary

Constructors
Constructor and Description
`Experiment(java.lang.String name)` Constructs a new Experiment with a given name.
`Experiment(java.lang.String name, boolean output)` Constructs a new Experiment with the given parameters.
`Experiment(java.lang.String name, java.lang.String pathName)` Constructs a new Experiment with the given parameters.
`Experiment(java.lang.String name, java.lang.String outputPath, java.util.ArrayList<java.lang.String> reportOutputs, java.util.ArrayList<java.lang.String> traceOutputs, java.util.ArrayList<java.lang.String> errorOutputs, java.util.ArrayList<java.lang.String> debugOutputs)` Constructs a new Experiment with the given parameters.
`Experiment(java.lang.String name, java.lang.String pathName, java.lang.String reportOutputType, java.lang.String traceOutputType, java.lang.String errorOutputType, java.lang.String debugOutputType)` Constructs a new Experiment with the given parameters.
`Experiment(java.lang.String name, java.lang.String outputPath, TimeFormatter formatter, java.util.ArrayList<java.lang.String> reportOutputs, java.util.ArrayList<java.lang.String> traceOutputs, java.util.ArrayList<java.lang.String> errorOutputs, java.util.ArrayList<java.lang.String> debugOutputs)` Constructs a new Experiment with the given parameters.
`Experiment(java.lang.String name, java.lang.String pathName, TimeFormatter formatter, java.lang.String reportOutputType, java.lang.String traceOutputType, java.lang.String errorOutputType, java.lang.String debugOutputType)` Constructs a new Experiment with the given parameters.
`Experiment(java.lang.String name, TimeFormatter formatter)` Constructs a new Experiment with the given parameters.
`Experiment(java.lang.String name, java.util.concurrent.TimeUnit epsilon, java.util.concurrent.TimeUnit referenceUnit, TimeFormatter formatter)` Deprecated. Please use `Experiment(String name, TimeFormatter formatter)` or other constructors without `TimeUnit`s and set your episilon and reference time unit by calling `setEpsilon(TimeUnit epsilon)` and `setReferenceUnit(java.util.concurrent.TimeUnit referenceUnit)`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDebugReceiver(MessageReceiver trcRec)` Adds a messagereceiver for debugnotes to the experiment.
`void`	`addErrorReceiver(MessageReceiver trcRec)` Adds a messagereceiver for error messages to the experiment.
`void`	`addReceiver(MessageReceiver trcRec, java.lang.Class<?> messageType)` Adds a messagereceiver for the given subtype of message to the experiment.
`void`	`addTraceReceiver(MessageReceiver trcRec)` Adds a messagereceiver for tracenotes to the experiment.
`boolean`	`debugIsOn()` Returns a boolean indicating whether debug notes are forwarded to the debug ouput or not.
`void`	`debugOff(TimeInstant stopTime)` Switches the debug output off at the given point of simulation time.
`void`	`debugOn(TimeInstant startTime)` Switches the debug output on at the given point of simulation time.
`void`	`debugPeriod(TimeInstant startTime, TimeInstant stopTime)` Switches the debug output on for the given period of simulation time.
`void`	`deRegister(FileOutput file)` De-registers a file at the experiment.
`void`	`finish()` Stopps all running simprocesses that might still be scheduled and closes the output files.
`long`	`getDelayInMillis()` Returns the delay between each step of the scheduler
`static java.lang.String`	`getDesmoJLicense(boolean html)` Returns the DESMO-J license
`static java.lang.String`	`getDesmoJVersion()` Returns the current DESMO-J version
`DistributionManager`	`getDistributionManager()` Returns the distributionmanager for this experiment.
`java.util.concurrent.TimeUnit`	`getEpsilonUnit()` Returns the epsilon value representing the granularity of simulation time for this experiment.
`double`	`getExecutionSpeedRate()` Returns the current execution Speed Rate.
`MessageDistributor`	`getMessageManager()` Returns the messagemanager for this experiment.
`Model`	`getModel()` Returns the model that is connected to this experiment or `null` if no model is connected so far.
`java.util.List<java.util.List<java.lang.String>>`	`getOutputAppendixes()`
`java.lang.String`	`getOutputPath()` Returns the name of the path the experiment's report-, trace-, debug- and error-files are written to.
`long`	`getRealTimeStartTime()`
`java.util.concurrent.TimeUnit`	`getReferenceUnit()` Returns the reference unit for this experiment.
`ResourceDB`	`getResourceDB()` Returns the resource database for this experiment.
`Scheduler`	`getScheduler()` Returns the scheduler for this experiment.
`SimClock`	`getSimClock()` Returns the simclock for this experiment.
`java.util.List<ModelCondition>`	`getStopConditions()` Returns the Conditions which can cause an experiment to stop.
`TimeInstant`	`getStopTime()` Returns the TimeInstant when the experiment is expected to stop running.
`boolean`	`hasError()` Determines whether or not an error or warning has yet occurred during this experiment.
`boolean`	`isAborted()` Displays the current state of the simulation run.
`boolean`	`isConnected()` Shows if this experiment has already been connected to a model.
`boolean`	`isPreparing()` Shows if this experiment has not run yet.
`boolean`	`isRandomizingConcurrentEvents()` Returns if the event-list processes concurrent Events in random order or not.
`boolean`	`isRunning()` Displays the current state of the simulation run.
`boolean`	`isShowProgressBar()` Returns if a progress bar should be displayed for this experiment or not.
`boolean`	`isShowProgressBarAutoclose()` Returns if the progress bar windows should be automatically closed after the experiment or not.
`boolean`	`isStopped()` Displays the current state of the simulation run.
`void`	`proceed()` Proceeds with a stopped experiment.
`void`	`randomizeConcurrentEvents(boolean randomizing)` Determines if the event-list processes concurrent Events in random order or not.
`void`	`register(OutputType file)` Registers a file output (Report, Trace, Error, Debug) in specific formats (e.g.
`void`	`registerFileOutput(FileOutput file)` Registers a custom file output at the experiment, e.g.
`void`	`removeDebugReceiver(MessageReceiver msgRec)` Removes a messagereceiver for debugnotes from the experiment's messagedistributor.
`void`	`removeErrorReceiver(MessageReceiver msgRec)` Removes a messagereceiver for errormessages from the experiment's messagedistributor.
`void`	`removeReceiver(MessageReceiver msgRec)` Removes a messagereceiver from the experiment's messagedistributor.
`void`	`removeReceiver(MessageReceiver msgRec, java.lang.Class<?> messageType)` Removes a messagereceiver for the given subtype of message from the Experiment's messagedistributor.
`void`	`removeStopConditions()` Removes all conditions set to stop the experiment.
`void`	`removeTraceReceiver(MessageReceiver msgRec)` Removes a messagereceiver for tracenotes from the experiment's messagedistributor.
`void`	`rename(java.lang.String newName)` Overrides inherited `NamedObjectImp.rename(String newName)` method to prevent the user from changing the experiment's name during an experiment.
`void`	`report()` Writes a report about the model connected top this experiment, its reportable components and all related submodels into the report output.
`void`	`report(Model m)` Writes a report about the given model which has to be connected to this experiment as main model or as a submodel.
`static void`	`setCoroutineModel(CoroutineModel model)` Sets the coroutine model.
`void`	`setDelayInMillis(long delay)` Sets the delay between each step of the scheduler.
`static void`	`setEpsilon(java.util.concurrent.TimeUnit epsilon)` Sets the epsilon value representing the granularity of simulation time to the given TimeUnit parameter.
`void`	`setExecutionSpeedRate(double rate)` Sets the speed rate for an execution that is proportional to wall-clock time (real time).
`void`	`setRandomNumberGenerator(java.lang.Class<? extends UniformRandomGenerator> randomNumberGenerator)` Sets the underlying pseudo random number generator to be used by all distributions created from now on.
`static void`	`setReferenceUnit(java.util.concurrent.TimeUnit referenceUnit)` Sets the reference time unit specifying what is meant by the simulation time step of 1 in statements without an explicit declaration of a time unit like in `new TimeSpan(5)`.
`void`	`setSeedGenerator(long seed)` Sets the seed of the SeedGenerator to the given value.
`void`	`setShowProgressBar(boolean newShowProgressBar)` Sets the new value for showing the progress bar for this experiment or not.
`void`	`setShowProgressBarAutoclose(boolean autoclose)` Sets the new value for automatically dismissing the progress bar for this experiment after completion.
`void`	`setSilent(boolean silent)` Sets the new value for displaying basic experiment notifications like 'experiment started', 'experiment stopped' oder 'experiment resumed' at the system output.
`static void`	`setTimeFormatter(TimeFormatter format)` Sets the `TimeFormatter` to be used for output of time strings.
`void`	`start()` Starts the simulation with default start time 0.
`void`	`start(TimeInstant initTime)` Starts the experiment with the given simulation time as starting time.
`void`	`stop()` Stops the simulation at the current simulation time (immediately).
`void`	`stop(ModelCondition stopCond)` Specifies a ModelCondition to stop the simulation.
`void`	`stop(TimeInstant stopTime)` Stops the simulation at the given point of simulation time.
`boolean`	`traceIsOn()` Returns a boolean indicating whether trace notes are forwarded to the trace ouput or not.
`void`	`traceOff(TimeInstant stopTime)` Switches the trace output off at the given point of simulation time.
`void`	`traceOn(TimeInstant startTime)` Switches the trace output on at the given point of simulation time.
`void`	`tracePeriod(TimeInstant startTime, TimeInstant stopTime)` Switches the trace output on for the given period of simulation time.
`void`	`writeReport(Model m, java.lang.String suffix)` Triggers the reporters of the given model or submodel to write their report data into the report output registered at the experiment's messagemanager.
`void`	`writeReport(java.lang.String suffix)` Triggers the reporters to write their data into the report output registered at the experiment's messagemanager.

Methods inherited from class desmoj.core.simulator.NamedObject
getName, getQuotedName, toString

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

- Field Detail
  - DEFAULT_REPORT_OUTPUT_TYPE
```
public static final java.lang.String DEFAULT_REPORT_OUTPUT_TYPE
```
    The default report output
    
    See Also:
    
    Constant Field Values
  - DEFAULT_TRACE_OUTPUT_TYPE
```
public static final java.lang.String DEFAULT_TRACE_OUTPUT_TYPE
```
    The default trace output
    
    See Also:
    
    Constant Field Values
  - DEFAULT_ERROR_OUTPUT_TYPE
```
public static final java.lang.String DEFAULT_ERROR_OUTPUT_TYPE
```
    The default error output
    
    See Also:
    
    Constant Field Values
  - DEFAULT_DEBUG_OUTPUT_TYPE
```
public static final java.lang.String DEFAULT_DEBUG_OUTPUT_TYPE
```
    The default debug output
    
    See Also:
    
    Constant Field Values
  - NOT_INITIALIZED
```
public static final int NOT_INITIALIZED
```
    Status of an Experiment just created without any accessories created yet.
    
    See Also:
    
    Constant Field Values
  - INITIALIZED
```
public static final int INITIALIZED
```
    Status of an Experiment instantiated with all needed accessories available.
    
    See Also:
    
    Constant Field Values
  - CONNECTED
```
public static final int CONNECTED
```
    Status of an Experiment connected to a Model and ready to be started.
    
    See Also:
    
    Constant Field Values
  - STARTED
```
public static final int STARTED
```
    Status of an Experiment being started. Only if an Experiment is
    
    See Also:
    
    Constant Field Values
  - STOPPED
```
public static final int STOPPED
```
    Status of an Experiment stopped after having run.
    
    See Also:
    
    Constant Field Values
  - RUNNING
```
public static final int RUNNING
```
    Status of an Experiment currently running the simulation.
    
    See Also:
    
    Constant Field Values
  - ABORTED
```
public static final int ABORTED
```
    Status of an Experiment finished and to be cleared.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Experiment
```
public Experiment(java.lang.String name)
```
    Constructs a new Experiment with a given name. Data channel output (report, error, debug, trace) will either be written to HTML files in the current directory.
    
    Parameters:
    
    name - String : The name of the experiment determining the outputfile's names, too. So please avoid characters that your local filesystem does not support in filenames.
  - Experiment
```
public Experiment(java.lang.String name,
                  boolean output)
```
    Constructs a new Experiment with the given parameters. Experiment name can be specified. Data channel output (report, error, debug, trace) will either be suppressed or written to HTML files in the current directory.
    
    Parameters:
    
    name - String : The name of the experiment determining the outputfile's names, too. So please avoid characters that your local filesystem does not support in filenames.
    
    output - boolean : This flag indicates if the experiment should write output files in the default format (HTML) or no output files at all.
  - Experiment
```
public Experiment(java.lang.String name,
                  java.lang.String pathName)
```
    Constructs a new Experiment with the given parameters. Experiment name and output path can be specified. Data channel output (report, error, debug, trace) will either be written to HTML files, epsilon (granularity of simulation) defaults to a microsecond, reference time (default time unit) to a second.
    
    Parameters:
    
    name - String : The name of the experiment determining the outputfile's names, too. So please avoid characters that your local filesystem does not support in filenames.
    
    pathName - java.lang.String : The output path for report files
  - Experiment
```
public Experiment(java.lang.String name,
                  TimeFormatter formatter)
```
    Constructs a new Experiment with the given parameters. This is a shortcut constructor. A parameter for the name and a time formatter are needed. All other possible settings are set to default values.
    
    Parameters:
    
    name - String : The name of the experiment determining the outputfile's names, too. So please avoid characters that your local filesystem does not support in filenames.
    
    formatter - desmoj.core.simulator.TimeFormatter: Defines how time values will be formatted in the output files.
    
    See Also:
    
    TimeUnit
  - Experiment
```
public Experiment(java.lang.String name,
                  java.lang.String pathName,
                  java.lang.String reportOutputType,
                  java.lang.String traceOutputType,
                  java.lang.String errorOutputType,
                  java.lang.String debugOutputType)
```
    Constructs a new Experiment with the given parameters. Experiment name, output path and a single file type per output channel can be specified.
    
    Parameters:
    
    name - String : The name of the experiment determining the outputfile's names, too. So please avoid characters that your local filesystem does not support in filenames.
    
    pathName - java.lang.String : The output path for report files
    
    reportOutputType -
    
    traceOutputType -
    
    errorOutputType -
    
    debugOutputType -
  - Experiment
```
public Experiment(java.lang.String name,
                  java.lang.String pathName,
                  TimeFormatter formatter,
                  java.lang.String reportOutputType,
                  java.lang.String traceOutputType,
                  java.lang.String errorOutputType,
                  java.lang.String debugOutputType)
```
    Constructs a new Experiment with the given parameters. Experiment name, output path, time format, can be specified. Same holds for file output channels, though this constructor assumes a single file type per output channel.
    
    Parameters:
    
    name - String : The name of the experiment determining the outputfile's names, too. So please avoid characters that your local filesystem does not support in filenames.
    
    pathName - java.lang.String : The output path for report files
    
    formatter - desmoj.core.simulator.TimeFormatter: Defines how time values will be formatted in the output files.
  - Experiment
```
public Experiment(java.lang.String name,
                  java.lang.String outputPath,
                  TimeFormatter formatter,
                  java.util.ArrayList<java.lang.String> reportOutputs,
                  java.util.ArrayList<java.lang.String> traceOutputs,
                  java.util.ArrayList<java.lang.String> errorOutputs,
                  java.util.ArrayList<java.lang.String> debugOutputs)
```
    Constructs a new Experiment with the given parameters. This is the most flexible constructor. Experiment name, output path, epsilon, reference time unit, time format, and multiple file types per output channel can be specified.
    
    Parameters:
    
    name - String : The name of the experiment determining the outputfile's names, too. So please avoid characters that your local filesystem does not support in filenames.
    
    outputPath - java.lang.String : The output path for report files
    
    formatter - desmoj.core.simulator.TimeFormatter: Defines how time values will be formatted in the output files.
    
    See Also:
    
    TimeUnit
  - Experiment
```
public Experiment(java.lang.String name,
                  java.lang.String outputPath,
                  java.util.ArrayList<java.lang.String> reportOutputs,
                  java.util.ArrayList<java.lang.String> traceOutputs,
                  java.util.ArrayList<java.lang.String> errorOutputs,
                  java.util.ArrayList<java.lang.String> debugOutputs)
```
    Constructs a new Experiment with the given parameters. Experiment name, output path and a multiple file type per output channel can be specified. Epsilon (granularity of simulation) defaults to a microsecond, reference time (default time unit) to a second.
    
    Parameters:
    
    name - String : The name of the experiment determining the outputfile's names, too. So please avoid characters that your local filesystem does not support in filenames.
    
    outputPath - java.lang.String : The output path for report files
  - Experiment
```
@Deprecated
public Experiment(java.lang.String name,
                               java.util.concurrent.TimeUnit epsilon,
                               java.util.concurrent.TimeUnit referenceUnit,
                               TimeFormatter formatter)
```
    Deprecated. Please use Experiment(String name, TimeFormatter formatter) or other constructors without TimeUnits and set your episilon and reference time unit by calling setEpsilon(TimeUnit epsilon) and setReferenceUnit(java.util.concurrent.TimeUnit referenceUnit).
    
    Legacy constructor.
    
    Parameters:
    
    name - String : The name of the experiment determining the outputfile's names, too. So please avoid characters that your local filesystem does not support in filenames.
    
    epsilon - java.util.concurrent.TimeUnit: Ignored.
    
    referenceUnit - java.util.concurrent.TimeUnit: Ignored.
    
    formatter - desmoj.core.simulator.TimeFormatter: Defines how time values will be formatted in the output files.
- Method Detail
  - addDebugReceiver
```
public void addDebugReceiver(MessageReceiver trcRec)
```
    Adds a messagereceiver for debugnotes to the experiment. Whenever a model produces a message of that type, it will also be sent to the given messagereceiver for further processing. Note that the given receiver must be capable of handling debugnotes.
    
    Parameters:
    
    trcRec - desmoj.report.MessageReceiver : The new messagereceiver for the given type of messages
  - addErrorReceiver
```
public void addErrorReceiver(MessageReceiver trcRec)
```
    Adds a messagereceiver for error messages to the experiment. Whenever a model produces a message of that type, it will also be sent to the given messagereceiver for further processing. Note that the given receiver must be capable of handling messagereceiver.
    
    Parameters:
    
    trcRec - desmoj.report.MessageReceiver : The new messagereceiver for the given type of messages
  - addReceiver
```
public void addReceiver(MessageReceiver trcRec,
                        java.lang.Class<?> messageType)
```
    Adds a messagereceiver for the given subtype of message to the experiment. Whenever a model produces a message of that type, it will also be sent to the given messagereceiver for further processing.
    
    Parameters:
    
    trcRec - desmoj.report.MessageReceiver : The new messagereceiver for the given type of messages
    
    messageType - Class : The type of message to be sent to the given messagereceiver
  - addTraceReceiver
```
public void addTraceReceiver(MessageReceiver trcRec)
```
    Adds a messagereceiver for tracenotes to the experiment. Whenever a model produces a message of that type, it will also be sent to the given messagereceiver for further processing. Note that the given Receiver must be capable of handling tracenotes.
    
    Parameters:
    
    trcRec - desmoj.report.MessageReceiver : The new messagereceiver for the given type of messages
  - debugIsOn
```
public boolean debugIsOn()
```
    Returns a boolean indicating whether debug notes are forwarded to the debug ouput or not. Debug ouput can be switched on and off using the methods debugOn(TimeInstant startTime) or debugOff(TimeInstant stopTime)
    
    Returns:
    
    boolean
  - debugOff
```
public void debugOff(TimeInstant stopTime)
```
    Switches the debug output off at the given point of simulation time.
    
    Parameters:
    
    stopTime - TimeInstant : The point in simulation time to switch off debug
  - debugOn
```
public void debugOn(TimeInstant startTime)
```
    Switches the debug output on at the given point of simulation time.
    
    Parameters:
    
    startTime - TimeInstant : The point in simulation time to switch on debug
  - debugPeriod
```
public void debugPeriod(TimeInstant startTime,
                        TimeInstant stopTime)
```
    Switches the debug output on for the given period of simulation time. If the second parameter (off) is "sooner" then the first parameter (on), they will be swapped automatically. Same parameters will result in no debug output at all!
    
    Parameters:
    
    startTime - TimeInstant : The point in simulation time to switch debug on
    
    stopTime - TimeInstant : The point in simulation time to switch debug off
  - deRegister
```
public void deRegister(FileOutput file)
```
    De-registers a file at the experiment. Registered files will be flushed and closed after the experiment has finished. If the file is manually closed by the user and has been registered at the Experiment, deRegister it
    
    Parameters:
    
    file - desmoj.report.FileOutput : The file to be closed with the end of an Experiment
  - finish
```
public void finish()
```
    Stopps all running simprocesses that might still be scheduled and closes the output files.
  - getDistributionManager
```
public DistributionManager getDistributionManager()
```
    Returns the distributionmanager for this experiment. Distributions need access to the distributionmanager for handling antithetic modes, resetting and their initial seeds.
    
    Returns:
    
    desmoj.dist.DistributionManager : The distributionmanager for this experiment
  - getEpsilonUnit
```
public java.util.concurrent.TimeUnit getEpsilonUnit()
```
    Returns the epsilon value representing the granularity of simulation time for this experiment. So far, Hour, Minute, Second and Millisecond are supported. Default (unless set explicitly) is TimeUnit.MICROSECONDS.
    
    Returns:
    
    TimeUnit : The Granularity of the simulation time
  - getExecutionSpeedRate
```
public double getExecutionSpeedRate()
```
    Returns the current execution Speed Rate.
    
    Returns:
    
    double : The current execution speed rate.
  - getMessageManager
```
public MessageDistributor getMessageManager()
```
    Returns the messagemanager for this experiment. Messages need access to the MessageManager for distributing the messages to one or more specified output streams.
    
    Returns:
    
    desmoj.dist.MessageManager : The messagemanager for this experiment
  - getModel
```
public Model getModel()
```
    Returns the model that is connected to this experiment or null if no model is connected so far.
    
    Returns:
    
    Model : The model that this experiment is connected to or null if no connection is established.
  - getOutputPath
```
public java.lang.String getOutputPath()
```
    Returns the name of the path the experiment's report-, trace-, debug- and error-files are written to.
    
    Returns:
    
    String the experiment's output path
  - getOutputAppendixes
```
public java.util.List<java.util.List<java.lang.String>> getOutputAppendixes()
```
  - getRealTimeStartTime
```
public long getRealTimeStartTime()
```
  - getReferenceUnit
```
public java.util.concurrent.TimeUnit getReferenceUnit()
```
    Returns the reference unit for this experiment. This is the time unit mapped to a time step of 1.0 in simulation time. So far, Hour, Minute, Second and Millisecond are supported. Default (unless set explicitly) is TimeUnit.SECONDS.
    
    Returns:
    
    TimeUnit : The reference unit.
  - getResourceDB
```
public ResourceDB getResourceDB()
```
    Returns the resource database for this experiment. The Res objects need access to the resource database to note their resource allocations and requests and for deadlock detection.
    
    Returns:
    
    desmoj.ResourceDB : the resource database storing all resource allocations and requests.
  - getScheduler
```
public Scheduler getScheduler()
```
    Returns the scheduler for this experiment. ModelComponents need access to the scheduler for identifying the current active entity or process and to schedule themselves or other schedulables to activate at a given time in the future.
    
    Returns:
    
    Scheduler : The scheduler for this experiment
  - getSimClock
```
public SimClock getSimClock()
```
    Returns the simclock for this experiment. ModelComponents need access to the simclock for retrieveing the current simulation time.
    
    Returns:
    
    SimCLock : The simclock for this experiment
  - getStopTime
```
public TimeInstant getStopTime()
```
    Returns the TimeInstant when the experiment is expected to stop running.
    
    Returns:
    
    TimeInstant : The time at which the experiment is expected to stop running.
  - getStopConditions
```
public java.util.List<ModelCondition> getStopConditions()
```
    Returns the Conditions which can cause an experiment to stop. May be empty if there are no such Conditions.
    
    Returns:
    
    Condition
  - removeStopConditions
```
public void removeStopConditions()
```
    Removes all conditions set to stop the experiment.
  - isAborted
```
public boolean isAborted()
```
    Displays the current state of the simulation run. If an experiment is aborted, it can not be proceeded. All SimThreads still active are stopped, the main routine can finish.
    
    Returns:
    
    boolean : Is true if the simulation is aborted, false if it has not started yet or is still running
  - isConnected
```
public boolean isConnected()
```
    Shows if this experiment has already been connected to a model.
    
    Returns:
    
    boolean : Is true, if experiment is connected to a model, false otherwise
  - isPreparing
```
public boolean isPreparing()
```
    Shows if this experiment has not run yet.
    
    Returns:
    
    boolean : Is true, if experiment is not running yet, false otherwise
  - isRandomizingConcurrentEvents
```
public boolean isRandomizingConcurrentEvents()
```
    Returns if the event-list processes concurrent Events in random order or not. Default is not.
    
    Returns:
    
    boolean: true if concurrent Events are randomized, false otherwise
  - isRunning
```
public boolean isRunning()
```
    Displays the current state of the simulation run.
    
    Returns:
    
    boolean : Is true if the simulation is running, false if it has not started yet or has already finished
  - isShowProgressBar
```
public boolean isShowProgressBar()
```
    Returns if a progress bar should be displayed for this experiment or not.
    
    Returns:
    
    boolean :true if a progress bar should be displayed for this experiment, false otherwise.
  - isStopped
```
public boolean isStopped()
```
    Displays the current state of the simulation run. If an experient is stopped, it can be proceeded by calling proceed().
    
    Returns:
    
    boolean : Is true, if experiment is stopped, false otherwise
  - hasError
```
public boolean hasError()
```
    Determines whether or not an error or warning has yet occurred during this experiment.
    
    Returns:
    
    boolean : True if at least one error has occurred in the model connected to this experiment or one of its submodels, false otherwise
  - proceed
```
public void proceed()
```
    Proceeds with a stopped experiment. An experiment can be stopped, if either its status is changed from RUNNING to some other state, the scheduler runs out of scheduled events or if the check() method of the given stop Condition returns true after an event has been processed.
  - setDelayInMillis
```
public void setDelayInMillis(long delay)
```
    Sets the delay between each step of the scheduler.
    
    Parameters:
    
    delay - : Delay time in milliseconds as a long value
  - getDelayInMillis
```
public long getDelayInMillis()
```
    Returns the delay between each step of the scheduler
    
    Returns:
    
    A long value representing the delay time in milliseconds
  - register
```
public void register(OutputType file)
```
    Registers a file output (Report, Trace, Error, Debug) in specific formats (e.g. HTML, ASCII, XML) at the experiment. Registered files will be flushed and closed after the experiment has finished. This is handy for modellers producing their own output who want their files to be closed at the end of the experiment.
    
    Parameters:
    
    file - desmoj.report.FileOutput : The file to be closed with the end of an experiment
  - registerFileOutput
```
public void registerFileOutput(FileOutput file)
```
    Registers a custom file output at the experiment, e.g. TimeSeries plotting data to a file. Registered files will be flushed and closed after the experiment has finished. This is handy for modellers producing their own output who want their files to be closed at the end of the experiment.
    
    Parameters:
    
    file - desmoj.report.FileOutput : The file to be closed with the end of an experiment
  - removeDebugReceiver
```
public void removeDebugReceiver(MessageReceiver msgRec)
```
    Removes a messagereceiver for debugnotes from the experiment's messagedistributor. Whenever a model produces a message of that type, it will not be sent to the given messagereceiver anymore. Note that if the messagereceiver is also registered for other types of messages, these will not be affected. Use method removeReceiverAll(MessageReceiver msgRec) to remove a messagereceiver from all types of messages.
    
    Parameters:
    
    msgRec - desmoj.report.MessageReceiver : The new messagereceiver to be removed from the messagedistributor's list for the given messagetype
  - removeErrorReceiver
```
public void removeErrorReceiver(MessageReceiver msgRec)
```
    Removes a messagereceiver for errormessages from the experiment's messagedistributor. Whenever a model produces a message of that type, it will not be sent to the given messagereceiver anymore. Note that if the messagereceiver is also registered for other types of messages, these will not be affected. Use method removeReceiverAll(MessageReceiver msgRec) to remove a messagereceiver from all types of messages.
    
    Parameters:
    
    msgRec - desmoj.report.MessageReceiver : The new messagereceiver to be removed from the vessagedistributor's list for the given messagetype
  - removeReceiver
```
public void removeReceiver(MessageReceiver msgRec)
```
    Removes a messagereceiver from the experiment's messagedistributor. The given messagereceiver will not receive messages of any type any more Use method removeReceiver(MessageReceiver msgRec, Class messageType) to remove the messagereceiver from one type of messages only.
    
    Parameters:
    
    msgRec - desmoj.report.MessageReceiver : The new messagereceiver to be removed from the messagedistributor's list for the given messagetype
  - removeReceiver
```
public void removeReceiver(MessageReceiver msgRec,
                           java.lang.Class<?> messageType)
```
    Removes a messagereceiver for the given subtype of message from the Experiment's messagedistributor. Whenever a model produces a message of that type, it will not be sent to the given messagereceiver anymore. Note that if the messagereceiver is also registered for other types of messages, these will not be affected. Use method removeReceiverAll(MessageReceiver msgRec) to remove a messagereceiver from all types of messages.
    
    Parameters:
    
    msgRec - desmoj.report.MessageReceiver : The new messagereceiver to be removed from the messagedistributor's list for the given messagetype
    
    messageType - Class : The type of message not to be sent to the given messagereceiver
  - removeTraceReceiver
```
public void removeTraceReceiver(MessageReceiver msgRec)
```
    Removes a messagereceiver for tracenotes from the experiment's messagedistributor. Whenever a model produces a message of that type, it will not be sent to the given messagereceiver anymore. Note that if the messagereceiver is also registered for other types of messages, these will not be affected. Use method removeReceiverAll(MessageReceiver msgRec) to remove a messagereceiver from all types of messages.
    
    Parameters:
    
    msgRec - desmoj.report.MessageReceiver : The new messagereceiver to be removed from the messagedistributor's list for the given messagetype
  - rename
```
public void rename(java.lang.String newName)
```
    Overrides inherited NamedObjectImp.rename(String newName) method to prevent the user from changing the experiment's name during an experiment. Renaming is not allowed with experiments, since it would not allow the user to identify the reports produced by an experiment. The method simply returns without changing the experiment's name, ignoring the given parameter.
    
    Parameters:
    
    newName - java.lang.String : The parameter given is not taken as the new name, method simply returns
  - report
```
public void report()
```
    Writes a report about the model connected top this experiment, its reportable components and all related submodels into the report output. Note that a report can only be produced, if a valid main model is already connected to the experiment.
  - report
```
public void report(Model m)
```
    Writes a report about the given model which has to be connected to this experiment as main model or as a submodel. Note that this will report about a branch of the tree of submodels constructed. A report will only be produced, if the model given is connected to this experiment. All reportable components of this model and all related submodels will be sent to the report output configured at the experiment's messagedistributor. Note that a report can only be produced, if a valid main model is already connected to the experiment.
  - setTimeFormatter
```
public static void setTimeFormatter(TimeFormatter format)
```
    Sets the TimeFormatter to be used for output of time strings. Observe that if this method is called before creating an Experiment object, a non-null TimeFormatter passed to the Experiment's constructor will overwrite the setting of this method-
    
    Parameters:
    
    format - TimeFormatter : the formatter to be used for formatting time Strings.
  - randomizeConcurrentEvents
```
public void randomizeConcurrentEvents(boolean randomizing)
```
    Determines if the event-list processes concurrent Events in random order or not. Default is not, i.e. when a new experiment is constructed, the event-list is set to "linear" order. Note: If you want the event-list to randomize concurrent Events you should call this method BEFORE scheduling any events. Otherwise any connections between events established via scheduleBefore() or scheduleAfter() are lost. So it's a good idea to call this method only once and right after constructing the experiment.
    
    Parameters:
    
    randomizing - boolean :true forces random order, false forces "linear" order
  - setExecutionSpeedRate
```
public void setExecutionSpeedRate(double rate)
```
    Sets the speed rate for an execution that is proportional to wall-clock time (real time). Set the speed rate to a value bigger than zero for a simulation that will progress proportional to wall-clock time. The following equation applies for speed rates >0 : rate*simulation time = wallclock-time. If the speed rate is 0 or less the simulation will be executed as fast as possible. Default is 0 (as-fast-as-possible).
    
    Parameters:
    
    rate - double : The execution speed rate
  - setSeedGenerator
```
public void setSeedGenerator(long seed)
```
    Sets the seed of the SeedGenerator to the given value. If the seed is not set here, its default is 979, unless specified different in the ExperimentOptions.
    
    Parameters:
    
    seed - long : The seed for the SeedGenerator
  - setRandomNumberGenerator
```
public void setRandomNumberGenerator(java.lang.Class<? extends UniformRandomGenerator> randomNumberGenerator)
```
    Sets the underlying pseudo random number generator to be used by all distributions created from now on. The default generator is LinearCongruentialRandomGenerator; any other generator to be used must implement the interface UniformRandomGenerator.
    
    Parameters:
    
    randomNumberGenerator - Class : The random number generator class to be used
    
    See Also:
    
    LinearCongruentialRandomGenerator, UniformRandomGenerator
  - setShowProgressBar
```
public void setShowProgressBar(boolean newShowProgressBar)
```
    Sets the new value for showing the progress bar for this experiment or not. Must be called before the experiment is started.
    
    Parameters:
    
    newShowProgressBar - boolean : set it to true if a progress bar should be displayed; for not showing the progress bar of this experiment set it to false.
  - setShowProgressBarAutoclose
```
public void setShowProgressBarAutoclose(boolean autoclose)
```
    Sets the new value for automatically dismissing the progress bar for this experiment after completion.
    Not that a call to this method has no impact if the progress bar is suppessed by invoking setShowProgressBar(false). Must be called before the experiment is started.
    
    Parameters:
    
    autoclose - boolean : if set to true, the progress bar will be automaticalled closed one the experiment terminates. If set to false (default), the progress bar window persists after the experiment terminates until closed by the user.
  - isShowProgressBarAutoclose
```
public boolean isShowProgressBarAutoclose()
```
    Returns if the progress bar windows should be automatically closed after the experiment or not. Note that the result of this method is meaningless if displaying the progress bar has been suppessed by invoking setShowProgressBar(false).
    
    Returns:
    
    boolean :true if a progress bar should be automatically closed after this experiment, while false (default) indicates that the progress bar window persists after the experiment terminates until closed by the user..
  - setEpsilon
```
public static void setEpsilon(java.util.concurrent.TimeUnit epsilon)
```
    Sets the epsilon value representing the granularity of simulation time to the given TimeUnit parameter. Should not be called after time objects (TimeInstant, TimeSpan) have been created as existing TimeSpan and TimeInstant objects will point to wrong spans/durations. Default is TimeUnit.MICROSECONDS.
    
    Parameters:
    
    epsilon - TimeUnit : The granularity of simulation time, i.e. the smallest distinguishable span of simulation time.
  - setReferenceUnit
```
public static void setReferenceUnit(java.util.concurrent.TimeUnit referenceUnit)
```
    Sets the reference time unit specifying what is meant by the simulation time step of 1 in statements without an explicit declaration of a time unit like in new TimeSpan(5). Default is TimeUnit.SECONDS.
    
    Parameters:
    
    referenceUnit - TimeUnit : the reference time unit
  - setSilent
```
public void setSilent(boolean silent)
```
    Sets the new value for displaying basic experiment notifications like 'experiment started', 'experiment stopped' oder 'experiment resumed' at the system output.
    
    Parameters:
    
    silent - boolean : set it to true to suppress notifications or false to print them.
  - start
```
public void start()
```
    Starts the simulation with default start time 0. This method can only be used once on an experiment. it initializes the connected model and starts the simulation. Note that in order to stop the simulation, the stop(TimeInstant stopTime) method has to be called first!
  - start
```
public void start(TimeInstant initTime)
```
    Starts the experiment with the given simulation time as starting time. The experiment will not start unless a valid model has been connected to it before. Note that in order to stop the simulation at some point of time, the stop method has to be called first. StopCondition s can be given alternatively.
    
    Parameters:
    
    initTime - TimeInstant : The starting time instant
  - stop
```
public void stop(ModelCondition stopCond)
```
    Specifies a ModelCondition to stop the simulation. Note that this methode can be called muliple times, defining alternative conditions to terminate the simulation. Once at least one of the conditions passed using this method returns true, the experiment will stop. Beware that the simulation will run endlessly if none of the conditions are met; thus it is recommended to additionally always use a time limit if none of the conditions in question can be proven to be met during the run of the simulation!
    
    Parameters:
    
    stopCond - ModelCondition : A condition to stop the simulation once it's check() methode returns true.
  - stop
```
public void stop(TimeInstant stopTime)
```
    Stops the simulation at the given point of simulation time. If no valid simulation time is given, the default is 0 which would not let the simulation run past that time. Repeatedly calling this method will override stop times specified before.
    
    Parameters:
    
    stopTime - desmoj.TimeInstant : The point of simulation time to stop the simulation
  - stop
```
public void stop()
```
    Stops the simulation at the current simulation time (immediately). A stopped Simulation run can be resumed by calling proceed().
  - traceIsOn
```
public boolean traceIsOn()
```
    Returns a boolean indicating whether trace notes are forwarded to the trace ouput or not. Trace ouput can be switched on and off using the methods traceOn(TimeInstant startTime) and traceOff(TimeInstant stopTime)
    
    Returns:
    
    boolean : Is true
  - traceOff
```
public void traceOff(TimeInstant stopTime)
```
    Switches the trace output off at the given point of simulation time.
    
    Parameters:
    
    stopTime - TimeInstant : The point in simulation time to switch trace off
  - traceOn
```
public void traceOn(TimeInstant startTime)
```
    Switches the trace output on at the given point of simulation time.
    
    Parameters:
    
    startTime - TimeInstant : The point in simulation time to switch trace on
  - tracePeriod
```
public void tracePeriod(TimeInstant startTime,
                        TimeInstant stopTime)
```
    Switches the trace output on for the given period of simulation time. If the second parameter (off) is "sooner" then the first parameter (on), they will be swapped automatically. Same parameters will result in no trace output at all.
    
    Parameters:
    
    startTime - TimeInstant : The point in simulation time to switch trace on
    
    stopTime - TimeInstant : The point in simulation time to switch trace off
  - writeReport
```
public void writeReport(Model m,
                        java.lang.String suffix)
```
    Triggers the reporters of the given model or submodel to write their report data into the report output registered at the experiment's messagemanager. The string given will be added as a suffix to the report filename to help identify teh report when more than one report is produced by one Experiment at differnet points of simulation time.
    
    Parameters:
    
    m - desmoj.Model
    
    suffix - java.lang.String : Suffix for report filename if multiple reports are drawn
  - writeReport
```
public void writeReport(java.lang.String suffix)
```
    Triggers the reporters to write their data into the report output registered at the experiment's messagemanager. The string given will be added as a suffix to the report filename to help identification when more than one report is produced by one Experiment at differnet points of simulation time.
    
    Parameters:
    
    suffix - java.lang.String : Suffix for report filename if multiple reports are drawn
  - getDesmoJVersion
```
public static java.lang.String getDesmoJVersion()
```
    Returns the current DESMO-J version
    
    Returns:
    
    The string "2.5.1c".
  - getDesmoJLicense
```
public static java.lang.String getDesmoJLicense(boolean html)
```
    Returns the DESMO-J license
    
    Parameters:
    
    html - boolean: Include link (HTML, true) or not (plain text, false)
    
    Returns:
    
    The string "Apache License, Version 2.0", embedded in a HTML link tag (currently http://www.apache.org/licenses/LICENSE-2.0) if html is set true.
  - setCoroutineModel
```
public static void setCoroutineModel(CoroutineModel model)
```
    Sets the coroutine model. This has to be done before the experiment is created. DESMO-J currently supports two models: Threads (classic) and Fibers. Fibers can have performance benefits, but demand the use of bytecode manipulation. To use fibers, the Quasar agent has to be activated at the JVM command line. See http://docs.paralleluniverse.co/quasar/#instrumentation for further details.

Class Experiment

Field Summary

Constructor Summary

Method Summary

Methods inherited from class desmoj.core.simulator.NamedObject

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_REPORT_OUTPUT_TYPE

DEFAULT_TRACE_OUTPUT_TYPE

DEFAULT_ERROR_OUTPUT_TYPE

DEFAULT_DEBUG_OUTPUT_TYPE

NOT_INITIALIZED

INITIALIZED

CONNECTED

STARTED

STOPPED

RUNNING

ABORTED

Constructor Detail

Experiment

Experiment

Experiment

Experiment

Experiment

Experiment

Experiment

Experiment

Experiment

Method Detail

addDebugReceiver

addErrorReceiver

addReceiver

addTraceReceiver

debugIsOn

debugOff

debugOn

debugPeriod

deRegister

finish

getDistributionManager

getEpsilonUnit

getExecutionSpeedRate

getMessageManager

getModel

getOutputPath

getOutputAppendixes

getRealTimeStartTime

getReferenceUnit

getResourceDB

getScheduler

getSimClock

getStopTime

getStopConditions

removeStopConditions

isAborted

isConnected

isPreparing

isRandomizingConcurrentEvents

isRunning

isShowProgressBar

isStopped

hasError

proceed

setDelayInMillis

getDelayInMillis

register

registerFileOutput

removeDebugReceiver

removeErrorReceiver

removeReceiver

removeReceiver

removeTraceReceiver

rename

report

report

setTimeFormatter

randomizeConcurrentEvents

setExecutionSpeedRate

setSeedGenerator

setRandomNumberGenerator