desmoj.core.simulator

Class ParameterManager

java.lang.Object

desmoj.core.simulator.ParameterManager

All Implemented Interfaces:

ExperimentParameterManager, ModelParameterManager

public class ParameterManager
extends java.lang.Object
implements ModelParameterManager, ExperimentParameterManager

Class to manage parameters. Parameters are values, which affect a simulation- model or an experiment. Model-parameters are model's constants. Experiment- parameters are experiment-constants which can be used in the experiment's model. This class is accessible from Model through the ModelParameterManager-interface to restrict the accessible methods from a model's view. It is accessible from Experiment through the ExperimentParameterManager-interface to restrict the accessible methods from a experiment's view.

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:

Tim Janz

See Also:

ModelParameterManager, ExperimentParameterManager

Constructor Summary

Constructors

Constructor and Description
ParameterManager() Constructs a ParameterManager

Method Summary

Modifier and Type	Method and Description
void	assignExperimentParameter(java.lang.String name, java.lang.Object value) Method assign a value to an experiment-parameter declared previously by calling the model's parameter-manager method to declare an experiment-parameter
void	assignModelParameter(java.lang.String name, java.lang.Object value) Method to assign a value to a model-parameter declared previously.
void	declareExperimentParameter(java.lang.Class<?> type, java.lang.String name) Method to declare a experiment-parameter.
void	declareExperimentParameter(java.lang.Class<?> type, java.lang.String name, java.lang.Object defaultValue) Method to declare a experiment-parameter.
void	declareModelParameter(java.lang.Class<?> type, java.lang.String name) Method to declare a model-parameter.
java.util.Collection<Parameter>	getParameters() Returns all declared parameters.
java.lang.Object	getParameterValue(java.lang.String name) Returns the value of an experiment- or model-parameter.
void	initializeModelParameter(java.lang.Class<?> type, java.lang.String name, java.lang.Object value) Method to initialize (declare and assign) a model-parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterManager

public ParameterManager()

Constructs a ParameterManager

Method Detail

declareExperimentParameter

public void declareExperimentParameter(java.lang.Class<?> type,
                                       java.lang.String name)

Method to declare a experiment-parameter. The experiment-parameter's declarations are part of the simulation-model. The experiment- parameter's assignments are in contrast part of an experiment.

Specified by:

declareExperimentParameter in interface ModelParameterManager

Parameters:

type - the experiment-parameter's type

name - the experiment-parameter's name

declareExperimentParameter

public void declareExperimentParameter(java.lang.Class<?> type,
                                       java.lang.String name,
                                       java.lang.Object defaultValue)

Method to declare a experiment-parameter. The experiment-parameter's declarations are part of the simulation-model. The experiment- parameter's assignments are in contrast part of an experiment. The default value is used, if an experiment dosen't assign a value to this parameter.

Specified by:

declareExperimentParameter in interface ModelParameterManager

Parameters:

type - the experiment-parameter's type

name - the experiment-parameter's name

defaultValue - the experiment-parameter's default value

declareModelParameter

public void declareModelParameter(java.lang.Class<?> type,
                                  java.lang.String name)

Method to declare a model-parameter.

Specified by:

declareModelParameter in interface ModelParameterManager

Parameters:

type - the model-parameter's type

name - the model-parameter's name

initializeModelParameter

public void initializeModelParameter(java.lang.Class<?> type,
                                     java.lang.String name,
                                     java.lang.Object value)

Method to initialize (declare and assign) a model-parameter.

Specified by:

initializeModelParameter in interface ModelParameterManager

Parameters:

type - the model-parameter's type

name - the model-parameter's name

value - the model-parameter's value

assignModelParameter

public void assignModelParameter(java.lang.String name,
                                 java.lang.Object value)

Method to assign a value to a model-parameter declared previously.

Specified by:

assignModelParameter in interface ModelParameterManager

Parameters:

name - the model-parameter's name

value - the model-parameter's value

assignExperimentParameter

public void assignExperimentParameter(java.lang.String name,
                                      java.lang.Object value)

Method assign a value to an experiment-parameter declared previously by calling the model's parameter-manager method to declare an experiment-parameter

Specified by:

assignExperimentParameter in interface ExperimentParameterManager

Parameters:

name - the parameter's name

value - the parameter's value

getParameterValue

public java.lang.Object getParameterValue(java.lang.String name)

Returns the value of an experiment- or model-parameter. Experiment- and model-parameters are accessible through the model, to be able to use the parameter's values at design-time.

Specified by:

getParameterValue in interface ModelParameterManager

Parameters:

name - the parameter's name

Returns:

the parameter's value

getParameters

public java.util.Collection<Parameter> getParameters()

Returns all declared parameters.

Specified by:

getParameters in interface ModelParameterManager

Returns:

the parameters