desmoj.core.simulator

Interface ModelParameterManager

All Known Implementing Classes:

ParameterManager

public interface ModelParameterManager

Interface to restrict the functionalities of a parameter-manager to manage model-parameters. This Interface should be used as return- type of the Model's methods which return the parameter- manager.

Author:

Tim Janz 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	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.

Method Detail

declareExperimentParameter

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.

Parameters:

type - the experiment-parameter's type

name - the experiment-parameter's name

declareExperimentParameter

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.

Parameters:

type - the experiment-parameter's type

name - the experiment-parameter's name

defaultValue - the experiment-parameter's default value

declareModelParameter

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

Method to declare a model-parameter.

Parameters:

type - the model-parameter's type

name - the model-parameter's name

initializeModelParameter

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

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

Parameters:

type - the model-parameter's type

name - the model-parameter's name

value - the model-parameter's value

assignModelParameter

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

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

Parameters:

name - the model-parameter's name

value - the model-parameter's value

getParameterValue

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.

Parameters:

name - the parameter's name

Returns:

the parameter's value

getParameters

java.util.Collection<Parameter> getParameters()

Returns all declared parameters.

Returns:

the parameters