Package org.esa.snap.core.gpf.graph

Class GraphContext

java.lang.Object

org.esa.snap.core.gpf.graph.GraphContext

public class GraphContext
extends Object

The GraphContext holds the context for executing the Graph by the GraphProcessor.

Since:

4.1

See Also:

• Graph
• GraphProcessor

Constructor Summary

Constructors

Constructor	Description
GraphContext(Graph graph)	Creates a GraphContext for the given graph and a logger.
GraphContext(Graph graph, boolean init)
GraphContext(Graph graph, Operator graphOp)	Creates a GraphContext for the given graph and a logger.
GraphContext(Graph graph, Operator graphOp, boolean init)

Method Summary

Modifier and Type	Method	Description
void	dispose()	Disposes this GraphContext.
Graph	getGraph()	Gets the Graph of this context.
Deque<NodeContext>	getInitNodeContextDeque()	Gets the NodeContexts in the reverse order as they were initialized.
Logger	getLogger()	Gets the @link Logger} of this context.
NodeContext	getNodeContext(Node node)	Gets the NodeContext of the given node.
Product[]	getOutputProducts()	Returns an array containing the output products generated by this graph's output nodes, i.e.
void	init(Operator graphOp)
void	setPreferredTileSize(Dimension preferredTileSize)	Sets the preferred tile size.

Methods inherited from class java.lang.Object

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

Constructor Details

GraphContext

public GraphContext(Graph graph)
             throws GraphException

Creates a GraphContext for the given graph and a logger.

Parameters:

graph - the Graph to create the context for

Throws:

GraphException - if the graph context could not be created

GraphContext

public GraphContext(Graph graph,
 boolean init)
             throws GraphException

Throws:

GraphException

GraphContext

public GraphContext(Graph graph,
 Operator graphOp,
 boolean init)
             throws GraphException

Throws:

GraphException

GraphContext

public GraphContext(Graph graph,
 Operator graphOp)
             throws GraphException

Creates a GraphContext for the given graph and a logger.

Parameters:

graph - the Graph to create the context for

Throws:

GraphException - if the graph context could not be created

Method Details

init

public void init(Operator graphOp)
          throws GraphException

Throws:

GraphException

dispose

public void dispose()

Disposes this GraphContext.

getGraph

public Graph getGraph()

Gets the Graph of this context.

Returns:

the Graph

getLogger

public Logger getLogger()

Gets the @link Logger} of this context.

Returns:

the logger

setPreferredTileSize

public void setPreferredTileSize(Dimension preferredTileSize)

Sets the preferred tile size.

Parameters:

preferredTileSize - the preferred tile size

getOutputProducts

public Product[] getOutputProducts()

Returns an array containing the output products generated by this graph's output nodes, i.e. nodes that are not input to other nodes.

Returns:

an array containing the output products of this graph

getInitNodeContextDeque

public Deque<NodeContext> getInitNodeContextDeque()

Gets the NodeContexts in the reverse order as they were initialized.

Returns:

a deque of NodeContexts

getNodeContext

public NodeContext getNodeContext(Node node)

Gets the NodeContext of the given node.

Parameters:

node - the node to get the context for

Returns:

the NodeContext of the given node or null if it's not contained in this context