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

Class ParameterExternalImage

java.lang.Object

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

gov.nih.mipav.model.scripting.parameters.ParameterString

gov.nih.mipav.model.scripting.parameters.ParameterImage

gov.nih.mipav.model.scripting.parameters.ParameterExternalImage

public class ParameterExternalImage
extends ParameterImage

A image placeholder variable parameter used in either the recording or execution of a script action. This type of image parameter indicates that the image is not generated by other script actions; it must be specified externally by whatever is running the script that this parameter is used in.

Field Summary

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

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
ParameterExternalImage(java.lang.String paramLabel)	Creates a new ParameterImage object.
ParameterExternalImage(java.lang.String paramLabel, int paramType, java.lang.String paramValueString)	Creates a new ParameterExternalImage object.
ParameterExternalImage(java.lang.String paramLabel, java.lang.String paramTypeString, java.lang.String paramValueString)	Creates a new ParameterExternalImage object.

Method Summary

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

getFrame, getImage, isSameImageAs

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

getValue, getValueString, setValue

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

Constructor Detail

ParameterExternalImage

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

Creates a new ParameterImage object.

Parameters:

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

Throws:

ParserException - If there is a problem creating the parameter.

ParameterExternalImage

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

Creates a new ParameterExternalImage 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.

Throws:

ParserException - If there is a problem creating the parameter.

ParameterExternalImage

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

Creates a new ParameterExternalImage object.

Parameters:

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

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

paramValueString - The new parameter value.

Throws:

ParserException - If there is a problem creating the parameter.