|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object edu.jhu.ece.iacl.jist.pipeline.PipePort<T> edu.jhu.ece.iacl.jist.pipeline.parameter.ParamModel<java.lang.Number> edu.jhu.ece.iacl.jist.pipeline.parameter.ParamNumber edu.jhu.ece.iacl.jist.pipeline.parameter.ParamFloat
public class ParamFloat
Float Parameter.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class edu.jhu.ece.iacl.jist.pipeline.PipePort |
---|
PipePort.PortListener, PipePort.type |
Field Summary |
---|
Fields inherited from class edu.jhu.ece.iacl.jist.pipeline.parameter.ParamNumber |
---|
max, MAX_DOUBLE_VALUE, MAX_FLOAT_VALUE, MAX_INT_VALUE, MAX_LONG_VALUE, min, MIN_DOUBLE_VALUE, MIN_FLOAT_VALUE, MIN_INT_VALUE, MIN_LONG_VALUE, value |
Fields inherited from class edu.jhu.ece.iacl.jist.pipeline.parameter.ParamModel |
---|
cliTag, description, factory, hidden, label, loadAndSaveOnValidate, mandatory, shortLabel |
Fields inherited from class edu.jhu.ece.iacl.jist.pipeline.PipePort |
---|
connectible, gport, incomingConnectors, listeners, maxIncoming, maxOutgoing, outgoingConnectors, owner, portType, useWire |
Constructor Summary | |
---|---|
ParamFloat()
Construct float parameter with no restrictions on value. |
|
ParamFloat(float min,
float max)
Construct float parameter with restrictions on min and max value. |
|
ParamFloat(java.lang.String name)
Construct float parameter with no restrictions on value. |
|
ParamFloat(java.lang.String name,
float val)
Construct float parameter with restrictions on min and max value. |
|
ParamFloat(java.lang.String name,
float min,
float max)
Construct float parameter with restrictions on min and max value. |
|
ParamFloat(java.lang.String name,
float min,
float max,
float val)
Construct float parameter with restrictions on min and max value. |
Method Summary | |
---|---|
ParamFloat |
clone()
Clone parameter. |
int |
compareTo(ParamModel model)
Compare the min and max value restrictions of two parameters. |
java.lang.String |
getHumanReadableDataType()
|
java.lang.String |
getXMLValue()
|
void |
init()
Initialize this object. |
void |
setValue(java.lang.Number value)
Set the parameter. |
void |
setValue(java.lang.String str)
Set value from string. |
void |
setXMLValue(java.lang.String arg)
|
java.lang.String |
toString()
Get description. |
void |
validate()
Validate that the number is within the minimum and maximum restrictions. |
Methods inherited from class edu.jhu.ece.iacl.jist.pipeline.parameter.ParamNumber |
---|
equals, getDouble, getFloat, getInt, getLong, getMax, getMin, getValue, isCompatible, probeDefaultValue |
Methods inherited from class edu.jhu.ece.iacl.jist.pipeline.parameter.ParamModel |
---|
clean, createMipavParameter, createTreeNode, dispose, getCliTag, getDescription, getFactory, getInputView, getLabel, getName, getOutputView, getShortLabel, getView, hide, importMipavParameter, importParameter, isConnectible, isHidden, isMandatory, loadResources, loadResources, read, read, replacePath, saveResources, setCliTag, setDescription, setFactory, setHidden, setInputView, setLabel, setLoadAndSaveOnValidate, setMandatory, setName, setOutputView, setShortLabel, toXML, write, write, writeAndFreeNow |
Methods inherited from class edu.jhu.ece.iacl.jist.pipeline.PipePort |
---|
addListener, disconnect, disconnect, disconnect, disconnect, getGraphPort, getIncomingConnector, getIncomingConnectors, getIncomingPorts, getListeners, getMaxIncoming, getMaxOutgoing, getOutgoingConnector, getOutgoingConnectors, getOutgoingPorts, getOwner, getPortType, isConnected, isConnectedTo, isInputPort, isOutputPort, notifyListenersOfConnection, notifyListenersOfDisconnection, removeAllListeners, removeListener, setConnectable, setGraphPort, setMaxIncoming, setMaxOutgoing, setOwner, setPortType, setUseConnector, usingConnector |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public ParamFloat()
public ParamFloat(float min, float max)
min
- minimum value restrictionmax
- maximum value restrictionpublic ParamFloat(java.lang.String name)
name
- parameter namepublic ParamFloat(java.lang.String name, float val)
name
- parameter nameval
- valuepublic ParamFloat(java.lang.String name, float min, float max)
name
- parameter namemin
- minimum value restrictionmax
- maximum value restrictionpublic ParamFloat(java.lang.String name, float min, float max, float val)
name
- parameter namemin
- minimum value restrictionmax
- maximum value restrictionval
- the valMethod Detail |
---|
public ParamFloat clone()
clone
in class ParamNumber
public int compareTo(ParamModel model)
compareTo
in interface java.lang.Comparable<ParamModel>
compareTo
in class ParamModel<java.lang.Number>
model
- the model
public void init()
init
in class PipePort<java.lang.Number>
public void setValue(java.lang.String str)
setValue
in class ParamNumber
str
- the strpublic java.lang.String toString()
toString
in class ParamNumber
public void validate() throws InvalidParameterException
validate
in class ParamModel<java.lang.Number>
InvalidParameterException
- parameter does not meet value restrictionspublic java.lang.String getHumanReadableDataType()
getHumanReadableDataType
in class ParamModel<java.lang.Number>
public java.lang.String getXMLValue()
getXMLValue
in class ParamModel<java.lang.Number>
public void setXMLValue(java.lang.String arg)
setXMLValue
in class ParamModel<java.lang.Number>
public void setValue(java.lang.Number value)
ParamNumber
setValue
in class ParamNumber
value
- number value
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |