edu.jhu.ece.iacl.jist.pipeline.parameter
Class ParamPerformance

java.lang.Object
  edu.jhu.ece.iacl.jist.pipeline.PipePort<T>
      edu.jhu.ece.iacl.jist.pipeline.parameter.ParamModel<PerformanceSummary>
          edu.jhu.ece.iacl.jist.pipeline.parameter.ParamPerformance

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable<ParamModel>

public class ParamPerformance
extends ParamModel<PerformanceSummary>

Parameter to store algorithm performance information.

Author:

Blake Lucas (bclucas@jhu.edu)

Nested Class Summary

Nested classes/interfaces inherited from class edu.jhu.ece.iacl.jist.pipeline.PipePort

PipePort.PortListener, PipePort.type

Field Summary

protected PerformanceSummary

performance The performance.

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

ParamPerformance(java.lang.String name)
Constructor.

Method Summary

ParamPerformance	clone() Clone object.
int	compareTo(ParamModel o) Unimplemented.
java.lang.String	getHumanReadableDataType()
PerformanceSummary	getValue() Get algorithm performance.
java.lang.String	getXMLValue()
void	init() Initialize parameter.
java.lang.String	probeDefaultValue()
void	setValue(PerformanceSummary value) Set algorithm performance.
void	setXMLValue(java.lang.String arg)
java.lang.String	toString() Get performance description.
void	validate() Unimplemented.

Methods inherited from class edu.jhu.ece.iacl.jist.pipeline.parameter.ParamModel

clean, createMipavParameter, createTreeNode, dispose, equals, getCliTag, getDescription, getFactory, getInputView, getLabel, getName, getOutputView, getShortLabel, getView, hide, importMipavParameter, importParameter, isCompatible, 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

Field Detail

performance

protected PerformanceSummary performance

The performance.

Constructor Detail

ParamPerformance

public ParamPerformance(java.lang.String name)

Constructor.

Parameters:

name - parameter name

Method Detail

clone

public ParamPerformance clone()

Clone object.

Specified by:

clone in class ParamModel<PerformanceSummary>

Returns:

the param performance

compareTo

public int compareTo(ParamModel o)

Unimplemented.

Specified by:

compareTo in interface java.lang.Comparable<ParamModel>

Overrides:

compareTo in class ParamModel<PerformanceSummary>

Parameters:

o - the o

Returns:

the int

getValue

public PerformanceSummary getValue()

Get algorithm performance.

Specified by:

getValue in class ParamModel<PerformanceSummary>

Returns:

the value

init

public void init()

Initialize parameter.

Specified by:

init in class PipePort<PerformanceSummary>

setValue

public void setValue(PerformanceSummary value)
              throws InvalidParameterValueException

Set algorithm performance.

Specified by:

setValue in class ParamModel<PerformanceSummary>

Parameters:

value - the value

Throws:

InvalidParameterValueException - the invalid parameter value exception

toString

public java.lang.String toString()

Get performance description.

Specified by:

toString in class ParamModel<PerformanceSummary>

Returns:

the string

validate

public void validate()
              throws InvalidParameterException

Unimplemented.

Specified by:

validate in class ParamModel<PerformanceSummary>

Throws:

InvalidParameterException - the invalid parameter exception

getHumanReadableDataType

public java.lang.String getHumanReadableDataType()

Specified by:

getHumanReadableDataType in class ParamModel<PerformanceSummary>

getXMLValue

public java.lang.String getXMLValue()

Specified by:

getXMLValue in class ParamModel<PerformanceSummary>

setXMLValue

public void setXMLValue(java.lang.String arg)

Specified by:

setXMLValue in class ParamModel<PerformanceSummary>

probeDefaultValue

public java.lang.String probeDefaultValue()

Specified by:

probeDefaultValue in class ParamModel<PerformanceSummary>