All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class parameter.RealParameterType 

java.lang.Object
   |
   +----parameter.ParameterType
           |
           +----parameter.RealParameterType
public class RealParameterType
extends ParameterType
RealParameterType is used to store information describing a real parameter. It contains the default value, the minimum value and the maximum value of a parameter. These values are read from the Module Description File and can not be changed within the framework.

Variable Index

o defaultValue
The default value of a parameter.
o maxValue
The maximum value of a parameter.
o minValue
The minimum value of a parameter.

Constructor Index

o RealParameterType()

Method Index

o getDefaultValue()
o getMaxValue()
o getMinValue()
o getRange()
get the range of this real parameter.
o inRange(String)
Check whether valueString is within the range of the parameter.
o string2Parameter(String[])
Convert the parameter strings of a Module Description File to its real parameter values.

Variables

o defaultValue 
 private double defaultValue
The default value of a parameter.

o minValue 
 private double minValue
The minimum value of a parameter.

o maxValue 
 private double maxValue
The maximum value of a parameter.

Constructors

o RealParameterType 
 public RealParameterType()

Methods

o getDefaultValue 
 String getDefaultValue()
Overrides:
getDefaultValue in class ParameterType
o getMinValue 
 String getMinValue()
Overrides:
getMinValue in class ParameterType
o getMaxValue 
 String getMaxValue()
Overrides:
getMaxValue in class ParameterType
o getRange 
 String getRange()
get the range of this real parameter. If no upper xor lower value is defined in the MDF then the maximum value is considered (either positive or negative.

Overrides:
getRange in class ParameterType
o string2Parameter 
 public void string2Parameter(String cleanLines[])
Convert the parameter strings of a Module Description File to its real parameter values. The parameter name is converted in its super class ParameterType. The other values (default, min. & max.) are converted in this method. All these values are optional but all values must be reals. Errors will occur when the default value is not within range, or when the minimum value is bigger than the maximum value.

Overrides:
string2Parameter in class ParameterType
o inRange 
 boolean inRange(String valueString)
Check whether valueString is within the range of the parameter. If the minimum and/or maximum value of a parameter are specified and the valueString is within the range inRange returns 'true'.

Overrides:
inRange in class ParameterType 
All Packages  Class Hierarchy  This Package  Previous  Next  Index