desmoj.extensions.experimentation.util

Class Run

java.lang.Object

desmoj.extensions.experimentation.util.Run

public class Run
extends java.lang.Object

A class representing a parametrized simulation run. The parameters can be read from an XML file. The XML file must start with a tag. This tag contains model and experiment parameter specifications (tags and ). Each parameter specification is stated in the form .

Version:

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

Author:

Nicolas Knaak 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.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	UNDEFINED

Constructor Summary

Constructors

Constructor and Description
Run() Creates a new empty run.
Run(Model m, ExperimentRunner exp) Creates a new run without changing model and experiment parameter settings.
Run(Model defaultModel, ExperimentRunner defaultExpRunner, java.util.Map defaultExpSettings, java.util.Map defaultModelParams, int number) Creates a new run.

Method Summary

Modifier and Type	Method and Description
ExperimentRunner	getExperimentRunner()
Model	getModel()
static void	main(java.lang.String[] args)
void	readFromNode(org.w3c.dom.Element e) Reads a run from a DOM node representing an XML parameter file.
static void	readParamList(org.w3c.dom.Node src, java.util.Map dst) Reads a parameter list from a DOM node to a java.util.Map.

Methods inherited from class java.lang.Object

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

Field Detail

UNDEFINED

public static final java.lang.String UNDEFINED

See Also:

Constant Field Values

Constructor Detail

Run

public Run(Model defaultModel,
           ExperimentRunner defaultExpRunner,
           java.util.Map defaultExpSettings,
           java.util.Map defaultModelParams,
           int number)

Creates a new run. This constructor is mainly called from the class BatchRunner.

Parameters:

defaultModel - the model to run an experiment with

defaultExpRunner - the experiment runner used for running the experiment

defaultExpSettings - the experiment parameter settings

defaultModelParams - the model parameter settings

number - internal number of the run (only important if used with batches)

Run

public Run(Model m,
           ExperimentRunner exp)

Creates a new run without changing model and experiment parameter settings.

Parameters:

m - the model to run an experiment with

exp - the experiment runner used for running the experiment.

Run

public Run()

Creates a new empty run.

Method Detail

getModel

public Model getModel()

Returns:

the model an experiment is run with

readFromNode

public void readFromNode(org.w3c.dom.Element e)

Reads a run from a DOM node representing an XML parameter file.

Parameters:

n - the DOM node to read the run from

getExperimentRunner

public ExperimentRunner getExperimentRunner()

Returns:

the experiment runner used to run this experiment

readParamList

public static void readParamList(org.w3c.dom.Node src,
                                 java.util.Map dst)

Reads a parameter list from a DOM node to a java.util.Map. In the map each setting is stored as a key (name of the parameter) and value pair.

Parameters:

src - a DOM node containing XML based parameter settings

dst - a java.uztil.Map to copy the parameter settings to.

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

Throws:

java.lang.Exception