Package gov.nih.mipav.model.scripting.parameters

Class ParameterDouble

java.lang.Object

gov.nih.mipav.model.scripting.parameters.Parameter

gov.nih.mipav.model.scripting.parameters.ParameterDouble

public class ParameterDouble
extends Parameter

A double parameter used in either the recording or execution of a script action.

Field Summary

Fields

Modifier and Type	Field	Description
private double	value	The parameter's value.

Fields inherited from class gov.nih.mipav.model.scripting.parameters.Parameter

PARAM_BOOLEAN, PARAM_DOUBLE, PARAM_EXTERNAL_IMAGE, PARAM_FILE, PARAM_FLOAT, PARAM_IMAGE, PARAM_INT, PARAM_LIST, PARAM_LONG, PARAM_SHORT, PARAM_STRING, PARAM_USHORT

Constructor Summary

Constructors

Constructor	Description
ParameterDouble(java.lang.String paramLabel)	Creates a new ParameterDouble object without any value.
ParameterDouble(java.lang.String paramLabel, double paramValue)	Creates a new ParameterDouble with a new value.
ParameterDouble(java.lang.String paramLabel, int paramType, double paramValue)	Creates a new ParameterDouble object.
ParameterDouble(java.lang.String paramLabel, int paramType, java.lang.String paramValueString)	Creates a new ParameterDouble object.
ParameterDouble(java.lang.String paramLabel, java.lang.String paramTypeString, double paramValue)	Creates a new ParameterDouble object.
ParameterDouble(java.lang.String paramLabel, java.lang.String paramTypeString, java.lang.String paramValueString)	Creates a new ParameterDouble object.

Method Summary

Modifier and Type	Method	Description
double	getValue()	Returns the parameter value.
java.lang.String	getValueString()	Returns the parameter value as a string.
void	setValue(double paramValue)	Changes the parameter's current value.
void	setValue(java.lang.String paramValueString)	Changes the parameter's current value.

Methods inherited from class gov.nih.mipav.model.scripting.parameters.Parameter

convertToString, getLabel, getParent, getParentConditionValueString, getType, getTypeFromString, getTypeString, getTypeString, isOptional, isParentConditionValueMet, isValueAssigned, setOptional, setParent, setParentCondition, setParentConditionValue, setValueAssigned

Methods inherited from class java.lang.Object

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

Field Detail

value

private double value

The parameter's value.

Constructor Detail

ParameterDouble

public ParameterDouble(java.lang.String paramLabel)
                throws ParserException

Creates a new ParameterDouble object without any value.

Parameters:

paramLabel - The label/name to give to this parameter.

Throws:

ParserException - If there is a problem creating the parameter.

ParameterDouble

public ParameterDouble(java.lang.String paramLabel,
                       double paramValue)
                throws ParserException

Creates a new ParameterDouble with a new value.

Parameters:

paramLabel - The label/name to give to this parameter.

paramValue - The new parameter value.

Throws:

ParserException - If there is a problem creating the parameter.

ParameterDouble

public ParameterDouble(java.lang.String paramLabel,
                       java.lang.String paramTypeString,
                       double paramValue)
                throws ParserException

Creates a new ParameterDouble object.

Parameters:

paramLabel - The label/name to give to this parameter.

paramTypeString - The type of this parameter, in string form.

paramValue - The new parameter value.

Throws:

ParserException - If there is a problem creating the parameter.

ParameterDouble

public ParameterDouble(java.lang.String paramLabel,
                       java.lang.String paramTypeString,
                       java.lang.String paramValueString)
                throws ParserException

Creates a new ParameterDouble object.

Parameters:

paramLabel - The label/name to give to this parameter.

paramTypeString - The type of this parameter, in string form.

paramValueString - The new parameter value in string form.

Throws:

ParserException - If there is a problem creating the parameter.

ParameterDouble

public ParameterDouble(java.lang.String paramLabel,
                       int paramType,
                       double paramValue)
                throws ParserException

Creates a new ParameterDouble object.

Parameters:

paramLabel - The label/name to give to this parameter.

paramType - The type of this parameter (should be PARAM_DOUBLE).

paramValue - The new parameter value.

Throws:

ParserException - If there is a problem creating the parameter.

ParameterDouble

public ParameterDouble(java.lang.String paramLabel,
                       int paramType,
                       java.lang.String paramValueString)
                throws ParserException

Creates a new ParameterDouble object.

Parameters:

paramLabel - The label/name to give to this parameter.

paramType - The type of this parameter (should be PARAM_DOUBLE).

paramValueString - The new parameter value in string form.

Throws:

ParserException - If there is a problem creating the parameter.

Method Detail

getValue

public double getValue()

Returns the parameter value.

Returns:

The parameter value.

getValueString

public java.lang.String getValueString()

Returns the parameter value as a string.

Specified by:

getValueString in class Parameter

Returns:

The parameter value in string form.

setValue

public void setValue(java.lang.String paramValueString)
              throws ParserException

Changes the parameter's current value.

Specified by:

setValue in class Parameter

Parameters:

paramValueString - The new parameter value in String form.

Throws:

ParserException - If there is a problem changing the parameter value.

setValue

public void setValue(double paramValue)
              throws ParserException

Changes the parameter's current value.

Parameters:

paramValue - The new parameter value.

Throws:

ParserException - If there is a problem changing the parameter value.