Package org.esa.snap.core.gpf.operators.tooladapter

Class ToolAdapterOp

java.lang.Object

org.esa.snap.core.gpf.Operator

org.esa.snap.core.gpf.operators.tooladapter.ToolAdapterOp

@OperatorMetadata(alias="ToolAdapterOp",
                  category="Tools",
                  version="1.0",
                  description="Tool Adapter Operator")
public class ToolAdapterOp
extends Operator

Tool Adapter operator

Constructor Summary

Constructors

Constructor	Description
ToolAdapterOp()	Constructor.

Method Summary

Modifier and Type	Method	Description
List<String>	getErrors()	Gets the list of errors that have been produced during external tool execution
List<String>	getExecutionOutput()
Product	getResult()
void	initialize()	Initialise and run the defined tool.
void	setAdapterFolder(File folder)
void	setConsumer(ProcessOutputConsumer consumer)	Registers a consumer for the tool's output.
void	setProgressMonitor(ProgressMonitor monitor)
void	stop()	Command to isStopped the tool.

Methods inherited from class org.esa.snap.core.gpf.Operator

canComputeTile, canComputeTileStack, checkForCancellation, computeTile, computeTileStack, dispose, doExecute, ensureSceneGeoCoding, ensureSingleRasterSize, ensureSingleRasterSize, execute, finalize, getId, getLogger, getParameter, getParameter, getProductManager, getSourceProduct, getSourceProduct, getSourceProductId, getSourceProducts, getSourceTile, getSourceTile, getSpi, getTargetProduct, getTargetProperty, setLogger, setParameter, setParameterDefaultValues, setRequiresAllBands, setSourceProduct, setSourceProduct, setSourceProducts, setSpi, setTargetProduct, stopTileComputationObservation, update

Methods inherited from class java.lang.Object

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

Constructor Detail

ToolAdapterOp

public ToolAdapterOp()

Constructor.

Method Detail

setConsumer

public void setConsumer(ProcessOutputConsumer consumer)

Registers a consumer for the tool's output.

Parameters:

consumer - the output consumer.

setProgressMonitor

public void setProgressMonitor(ProgressMonitor monitor)

stop

public void stop()

Command to isStopped the tool.

This method is synchronized.

setAdapterFolder

public void setAdapterFolder(File folder)

getErrors

public List<String> getErrors()

Gets the list of errors that have been produced during external tool execution

Returns:

A list of error messages. The list is empty if no error has occured.

initialize

public void initialize()
                throws OperatorException

Initialise and run the defined tool.

This method will block until the tool finishes its execution.

Specified by:

initialize in class Operator

Throws:

OperatorException

See Also:

Operator.getTargetProduct()

getExecutionOutput

public List<String> getExecutionOutput()

getResult

public Product getResult()