Package org.esa.snap.core.gpf.main

Class CommandLineTool

java.lang.Object

org.esa.snap.core.gpf.main.CommandLineTool

All Implemented Interfaces:

GraphProcessingObserver

public class CommandLineTool
extends Object
implements GraphProcessingObserver

The common command-line tool for the GPF. For usage, see {@link org/esa/snap/core/gpf/main/CommandLineUsage.txt}.

Constructor Summary

Constructors

Constructor	Description
CommandLineTool()	Constructs a new tool.
CommandLineTool(CommandLineContext commandLineContext)	Constructs a new tool with the given context.

Method Summary

Modifier and Type	Method	Description
void	graphProcessingStarted(GraphContext graphContext)	It is invoked when the graph starts its processing.
void	graphProcessingStopped(GraphContext graphContext)	It is invoked when the graph stops its processing.
void	run(String... args)
void	tileProcessingStarted(GraphContext graphContext, Rectangle tileRectangle)	It is invoked when the processing of the rectangle starts.
void	tileProcessingStopped(GraphContext graphContext, Rectangle tileRectangle)	It is invoked when the processing of the rectangle is done.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandLineTool

public CommandLineTool()

Constructs a new tool.

CommandLineTool

public CommandLineTool(CommandLineContext commandLineContext)

Constructs a new tool with the given context.

Parameters:

commandLineContext - The context used to run the tool.

Method Detail

run

public void run(String... args)
         throws Exception

Throws:

Exception

graphProcessingStarted

public void graphProcessingStarted(GraphContext graphContext)

Description copied from interface: GraphProcessingObserver

It is invoked when the graph starts its processing.

Specified by:

graphProcessingStarted in interface GraphProcessingObserver

Parameters:

graphContext - the graph context being processed

graphProcessingStopped

public void graphProcessingStopped(GraphContext graphContext)

Description copied from interface: GraphProcessingObserver

It is invoked when the graph stops its processing.

Specified by:

graphProcessingStopped in interface GraphProcessingObserver

Parameters:

graphContext - the graph context being processed

tileProcessingStarted

public void tileProcessingStarted(GraphContext graphContext,
                                  Rectangle tileRectangle)

Description copied from interface: GraphProcessingObserver

It is invoked when the processing of the rectangle starts.

Specified by:

tileProcessingStarted in interface GraphProcessingObserver

Parameters:

graphContext - the graph context being processed

tileRectangle - the rectangle currently processed

tileProcessingStopped

public void tileProcessingStopped(GraphContext graphContext,
                                  Rectangle tileRectangle)

Description copied from interface: GraphProcessingObserver

It is invoked when the processing of the rectangle is done.

Specified by:

tileProcessingStopped in interface GraphProcessingObserver

Parameters:

graphContext - the graph context being processed

tileRectangle - the rectangle currently processed