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

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

All Implemented Interfaces:

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

public class ParamPointDouble
extends ParamModel<Point3d>
implements ParamPoint

3D Point parameter for double floating point.

Author:

Blake Lucas

Nested Class Summary

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

PipePort.PortListener, PipePort.type

Field Summary

protected ParamDouble	px The px.
protected ParamDouble	py The py.
protected ParamDouble	pz The pz.

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

ParamPointDouble()
Default constructor.

ParamPointDouble(Point3d p)
Constructor.

ParamPointDouble(java.lang.String name, Point3d p)
Constructor.

Method Summary

ParamPointDouble	clone() Clone object.
int	compareTo(ParamModel model) Compare specificity of parameters.
java.lang.String	getHumanReadableDataType()
ParamDouble	getParamX() Get X coordinate parameter.
ParamDouble	getParamY() Get Y coordinate parameter.
ParamDouble	getParamZ() Get Z coordinate parameter.
Point3d	getValue() Get point value.
java.lang.String	getXMLValue()
void	init() Initialize parameter.
boolean	isCompatible(PipePort model) Check for compatibility between parameters.
java.lang.String	probeDefaultValue()
void	setValue(Point3d value) Set double point value.
void	setValue(Point3f value) Set float point value.
void	setValue(Point3i value) Set integer point value.
void	setXMLValue(java.lang.String arg)
java.lang.String	toString() Get point description.
void	validate() Validate coordinate values.

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, 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

px

protected ParamDouble px

The px.

py

protected ParamDouble py

The py.

pz

protected ParamDouble pz

The pz.

Constructor Detail

ParamPointDouble

public ParamPointDouble()

Default constructor.

ParamPointDouble

public ParamPointDouble(Point3d p)

Constructor.

Parameters:

p - point

ParamPointDouble

public ParamPointDouble(java.lang.String name,
                        Point3d p)

Constructor.

Parameters:

name - parameter name

p - point

Method Detail

clone

public ParamPointDouble clone()

Clone object.

Specified by:

clone in class ParamModel<Point3d>

Returns:

the param point double

compareTo

public int compareTo(ParamModel model)

Description copied from class: ParamModel

Compare specificity of parameters. Zero indicates both parameters have the same level of specificity. Negative one indicates this parameter is less specific than the foreign one. Positive one indicates this parameter is more specific than the foreign one.

Specified by:

compareTo in interface java.lang.Comparable<ParamModel>

Overrides:

compareTo in class ParamModel<Point3d>

Parameters:

model - the mod

Returns:

the int

getParamX

public ParamDouble getParamX()

Get X coordinate parameter.

Specified by:

getParamX in interface ParamPoint

Returns:

X coordinate

getParamY

public ParamDouble getParamY()

Get Y coordinate parameter.

Specified by:

getParamY in interface ParamPoint

Returns:

Y coordinate

getParamZ

public ParamDouble getParamZ()

Get Z coordinate parameter.

Specified by:

getParamZ in interface ParamPoint

Returns:

Z coordinate

getValue

public Point3d getValue()

Get point value.

Specified by:

getValue in class ParamModel<Point3d>

Returns:

the value

init

public void init()

Initialize parameter.

Specified by:

init in class PipePort<Point3d>

isCompatible

public boolean isCompatible(PipePort model)

Description copied from class: ParamModel

Check for compatibility between parameters.

Overrides:

isCompatible in class ParamModel<Point3d>

Parameters:

model - foreign parameter

Returns:

true if compatible

setValue

public void setValue(Point3d value)
              throws InvalidParameterValueException

Set double point value.

Specified by:

setValue in class ParamModel<Point3d>

Parameters:

value - the value

Throws:

InvalidParameterValueException - the invalid parameter value exception

setValue

public void setValue(Point3f value)
              throws InvalidParameterValueException

Set float point value.

Specified by:

setValue in class ParamModel<Point3d>

Parameters:

value - point

Throws:

InvalidParameterValueException - the invalid parameter value exception

setValue

public void setValue(Point3i value)
              throws InvalidParameterValueException

Set integer point value.

Specified by:

setValue in class ParamModel<Point3d>

Parameters:

value - point

Throws:

InvalidParameterValueException - the invalid parameter value exception

toString

public java.lang.String toString()

Get point description.

Specified by:

toString in class ParamModel<Point3d>

Returns:

the string

validate

public void validate()
              throws InvalidParameterException

Validate coordinate values.

Specified by:

validate in class ParamModel<Point3d>

Throws:

InvalidParameterException - the invalid parameter exception

getHumanReadableDataType

public java.lang.String getHumanReadableDataType()

Specified by:

getHumanReadableDataType in class ParamModel<Point3d>

getXMLValue

public java.lang.String getXMLValue()

Specified by:

getXMLValue in class ParamModel<Point3d>

setXMLValue

public void setXMLValue(java.lang.String arg)

Specified by:

setXMLValue in class ParamModel<Point3d>

probeDefaultValue

public java.lang.String probeDefaultValue()

Specified by:

probeDefaultValue in class ParamModel<Point3d>