edu.jhu.ece.iacl.jist.pipeline
Class PipeDestination

java.lang.Object
  edu.jhu.ece.iacl.jist.pipeline.PipeModule
      edu.jhu.ece.iacl.jist.pipeline.PipeDestination

All Implemented Interfaces:

PipePort.PortListener, ParamViewObserver

Direct Known Subclasses:

PipeExternalDestination, PipeParamCopyDestination, PipeParamSummaryDestination

public abstract class PipeDestination
extends PipeModule

Pipe Module for processing destinations.

Author:

Blake Lucas

Nested Class Summary

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

PipeModule.PipeListener

Field Summary

protected ParamModel

selectedParams Parameter to store collection of other parameters.

Fields inherited from class edu.jhu.ece.iacl.jist.pipeline.PipeModule

bounds, cell, currentContext, inputHash, inputParams, inputPorts, label, listeners, name, outputHash, outputParams, outputPorts

Constructor Summary

PipeDestination()
Instantiates a new pipe destination.

Method Summary

protected abstract void	complete() Execute after iterating is complete.
protected abstract ParamCollection	createInputParams() Create input parameters for this destination.
PipeDestinationFactory.DestinationCell	createModuleCell() Create graph cell to render destination.
protected abstract ParamCollection	createOutputParams() Create output parameters for this destination.
PipeLayout	getCurrentLayout() Gets the current layout.
ParamModel	getInputParam() Gets the input param.
PipeModuleCell	init(PipeJGraph graph) Initialize destination and create graph cell.
protected abstract void	iterate(javax.swing.ProgressMonitor monitor) Iterate through destination values.
void	pull(javax.swing.ProgressMonitor monitor) Pull value from layout my forwarding values along connectors and iterate.
void	release()
protected abstract void	reset() Reset destination after iterating through all values.
void	setCurrentLayout(PipeLayout currentLayout) Sets the current layout.

Methods inherited from class edu.jhu.ece.iacl.jist.pipeline.PipeModule

addListener, connectAction, disconnect, disconnectAction, forward, getAncestors, getAncestors, getBounds, getChildren, getCurrentContext, getDescendants, getDescendants, getInputHash, getInputParams, getInputPorts, getLabel, getListeners, getModuleCell, getName, getOutputHash, getOutputParams, getOutputPorts, getParents, isAncestorOf, isDescendantOf, isRoot, push, removeAllListeners, removeListener, setBounds, setCurrentContext, setLabel, setModuleCell, setName, update

Methods inherited from class java.lang.Object

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

Field Detail

selectedParams

protected ParamModel selectedParams

Parameter to store collection of other parameters.

Constructor Detail

PipeDestination

public PipeDestination()

Instantiates a new pipe destination.

Method Detail

getCurrentLayout

public PipeLayout getCurrentLayout()

Gets the current layout.

Returns:

the current layout

setCurrentLayout

public void setCurrentLayout(PipeLayout currentLayout)

Sets the current layout.

Parameters:

currentLayout - the new current layout

complete

protected abstract void complete()

Execute after iterating is complete.

createInputParams

protected abstract ParamCollection createInputParams()

Create input parameters for this destination.

Returns:

input parameters

createModuleCell

public PipeDestinationFactory.DestinationCell createModuleCell()

Create graph cell to render destination.

Specified by:

createModuleCell in class PipeModule

Returns:

the destination cell

createOutputParams

protected abstract ParamCollection createOutputParams()

Create output parameters for this destination.

Returns:

output parameters

init

public PipeModuleCell init(PipeJGraph graph)

Initialize destination and create graph cell.

Specified by:

init in class PipeModule

Parameters:

graph - the graph

Returns:

destination graph cell

getInputParam

public ParamModel getInputParam()

Gets the input param.

Returns:

the input param

iterate

protected abstract void iterate(javax.swing.ProgressMonitor monitor)

Iterate through destination values.

Parameters:

monitor - the monitor

pull

public void pull(javax.swing.ProgressMonitor monitor)

Pull value from layout my forwarding values along connectors and iterate.

Parameters:

monitor - progress monitor for iterator

reset

protected abstract void reset()

Reset destination after iterating through all values.

release

public void release()