public class DoubleArrayParameter extends Parameter<double[]>
| Constructor and Description |
|---|
DoubleArrayParameter(String name,
int count)
Constructor.
|
| Modifier and Type | Method and Description |
|---|---|
double[] |
doublesValue(Environment env)
Returns the parameter value as an array of doubles.
|
float[] |
floatsValue(Environment env)
Returns the parameter value as an array of floats.
|
String |
objectToString(Environment env,
double[] dvals)
Takes a typed value of this parameter and formats it as a string
which may be used for presentation to the user.
|
double[] |
stringToObject(Environment env,
String stringval)
Takes a non-blank string, as supplied by the execution environment,
and turns it into a typed value for this parameter.
|
clearValue, getDescription, getName, getPosition, getPreferExplicit, getPrompt, getStringDefault, getUsage, getValueClass, isNullPermitted, objectValue, setDescription, setDescription, setName, setNullPermitted, setPosition, setPreferExplicit, setPrompt, setStringDefault, setUsage, setValue, setValueFromObject, setValueFromString, stringValue, toArray, toStringpublic DoubleArrayParameter(String name, int count)
name - parameter namecount - numeric array lengthpublic double[] doublesValue(Environment env) throws TaskException
env - execution environmentTaskExceptionpublic float[] floatsValue(Environment env) throws TaskException
env - execution environmentTaskExceptionpublic double[] stringToObject(Environment env, String stringval) throws TaskException
ParameterIt is an error to supply a null or empty string value.
If this method fails (throws a ParameterValueException)
and if allowClassnameValue is set, then a subsequent
attempt will be made to interpret the stringVal
as the classname of a suitable class with a no-arg constructor.
stringToObject in class Parameter<double[]>env - execution environment; in most cases this is not required
but for some purposes environment-specific characteristics
may influence the resultstringval - non-null, non-empty string valueTaskExceptionpublic String objectToString(Environment env, double[] dvals) throws TaskException
ParameterstringToObject should be possible,
but that is not in general required/guaranteed.
The default implementation uses the value's toString method, but subclasses can override this for smarter behaviour.
objectToString in class Parameter<double[]>env - execution environmentdvals - typed parameter valueTaskExceptionCopyright © 2024 Central Laboratory of the Research Councils. All Rights Reserved.