Parameter (DESMO-J 2.5.1c API)

java.lang.Object
- desmoj.core.simulator.Parameter

```
public class Parameter
extends java.lang.Object
```
Class to Represent a Parameter. This parameter can be an experiment- parameter or a model-parameter. Parameters are variables that are accessible from everywhere in the model. Model-parameters are assignable from model, experiment-parameters from experiment.

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:

ParameterManager, ModelParameterManager, ExperimentParameterManager

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Parameter.ParameterType
Enum to decide, if a parameter is a model-parameter or an experiment- parameter

Nested Classes
Modifier and Type	Class and Description
`static class`	`Parameter.ParameterType` Enum to decide, if a parameter is a model-parameter or an experiment- parameter

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Parameter`	`createExperimentParameter(java.lang.Class<?> type, java.lang.String name)` Factory-method to create an experiment-parameter.
`static Parameter`	`createExperimentParameter(java.lang.Class<?> type, java.lang.String name, java.lang.Object defaultValue)` Factory-method to create an experiment-parameter.
`static Parameter`	`createModelParameter(java.lang.Class<?> type, java.lang.String name)` Factory-method to create a model-parameter.
`static Parameter`	`createModelParameter(java.lang.Class<?> type, java.lang.String name, java.lang.Object value)` Factory-method to create a model-parameter.
`java.lang.String`	`getName()` Returns the parameter's name
`Parameter.ParameterType`	`getParameterType()` Is this parameter a model-parameter or an experiment-parameter?
`java.lang.Class<?>`	`getType()` Returns the parameter's type.
`java.lang.Object`	`getValue()` returns the parameter's value
`boolean`	`hasDefaultValue()` Checks, if this parameter has a default value.
`boolean`	`hasValue()` Checks, if this parameter has a value.
`void`	`setValue(java.lang.Object value)` sets the parameter's value.
`java.lang.String`	`toString()` Returns the parameter as a String

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

- Method Detail
  - getType
```
public java.lang.Class<?> getType()
```
    Returns the parameter's type.
    
    Returns:
    
    the parameter's type
  - getName
```
public java.lang.String getName()
```
    Returns the parameter's name
    
    Returns:
    
    the parameter's name
  - setValue
```
public void setValue(java.lang.Object value)
```
    sets the parameter's value.
    
    Parameters:
    
    value - the parameter's new value
  - getValue
```
public java.lang.Object getValue()
```
    returns the parameter's value
    
    Returns:
    
    the parameter's value
  - hasValue
```
public boolean hasValue()
```
    Checks, if this parameter has a value.
    
    Returns:
    
    if parameter has a value
  - hasDefaultValue
```
public boolean hasDefaultValue()
```
    Checks, if this parameter has a default value.
    
    Returns:
    
    if parameter has a default value
  - getParameterType
```
public Parameter.ParameterType getParameterType()
```
    Is this parameter a model-parameter or an experiment-parameter?
    
    Returns:
    
    ParameterType.MODELPARAMETER if this parameter is a model-parameter, or ParameterType.EXPERIMENTPARAMETER if this parameter is an experiment-parameter
  - toString
```
public java.lang.String toString()
```
    Returns the parameter as a String
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    the parameter as a String
  - createExperimentParameter
```
public static Parameter createExperimentParameter(java.lang.Class<?> type,
                                                  java.lang.String name,
                                                  java.lang.Object defaultValue)
```
    Factory-method to create an experiment-parameter.
    
    Parameters:
    
    type - the parameter's type
    
    name - the parameter's name
    
    defaultValue - the parameter's default value
    
    Returns:
    
    the created instance of Parameter
  - createExperimentParameter
```
public static Parameter createExperimentParameter(java.lang.Class<?> type,
                                                  java.lang.String name)
```
    Factory-method to create an experiment-parameter.
    
    Parameters:
    
    type - the parameter's type
    
    name - the parameter's name
    
    Returns:
    
    the created instance of Parameter
  - createModelParameter
```
public static Parameter createModelParameter(java.lang.Class<?> type,
                                             java.lang.String name,
                                             java.lang.Object value)
```
    Factory-method to create a model-parameter.
    
    Parameters:
    
    type - the parameter's type
    
    name - the parameter's name
    
    value - the parameter's value
    
    Returns:
    
    the created instance of Parameter
  - createModelParameter
```
public static Parameter createModelParameter(java.lang.Class<?> type,
                                             java.lang.String name)
```
    Factory-method to create a model-parameter.
    
    Parameters:
    
    type - the parameter's type
    
    name - the parameter's name
    
    Returns:
    
    the created instance of Parameter

Class Parameter

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getType

getName

setValue

getValue

hasValue

hasDefaultValue

getParameterType

toString

createExperimentParameter

createExperimentParameter

createModelParameter

createModelParameter