com.esri.arcgis.geoprocessing.tools.geostatisticalanalysttools
Class GACalculateZValue

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.geostatisticalanalysttools.GACalculateZValue

All Implemented Interfaces:

GPTool

public class GACalculateZValue
extends AbstractGPTool

The Calculate Z-value tool is contained in the Geostatistical Analyst Tools tool box.

Usage tips:

• This tool is generally used in a model or in scripting.

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

GACalculateZValue()
Creates the Calculate Z-value tool with defaults.

GACalculateZValue(Object inGeostatLayer, Object pointCoord)
Creates the Calculate Z-value tool with the required parameters.

Method Summary

Object	getInGeostatLayer() Returns the Input geostatistical layer parameter of this tool .
double	getOutZValue() Returns the Result (z-value) parameter of this tool (Read only).
Object	getPointCoord() Returns the Input point parameter of this tool .
String	getToolboxAlias() Returns the alias of the tool box containing this tool.
String	getToolboxName() Returns the name of the tool box containing this tool.
String	getToolName() Returns the name of this tool.
void	setInGeostatLayer(Object inGeostatLayer) Sets the Input geostatistical layer parameter of this tool .
void	setPointCoord(Object pointCoord) Sets the Input point parameter of this tool .

Methods inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

getParameterValues, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

GACalculateZValue

public GACalculateZValue()

Creates the Calculate Z-value tool with defaults.

Initializes the array of tool parameters with the default values specified when the tool was created.

GACalculateZValue

public GACalculateZValue(Object inGeostatLayer,
                         Object pointCoord)

Creates the Calculate Z-value tool with the required parameters.

Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.

Parameters:

inGeostatLayer - the geostatistical layer to be analyzed.

pointCoord - the x,y coordinate of the point where the Z value is required.

Method Detail

getInGeostatLayer

public Object getInGeostatLayer()

Returns the Input geostatistical layer parameter of this tool . This parameter is the geostatistical layer to be analyzed. This is a required parameter.

Returns:

the Input geostatistical layer

setInGeostatLayer

public void setInGeostatLayer(Object inGeostatLayer)

Sets the Input geostatistical layer parameter of this tool . This parameter is the geostatistical layer to be analyzed. This is a required parameter.

Parameters:

inGeostatLayer - the geostatistical layer to be analyzed.

getPointCoord

public Object getPointCoord()

Returns the Input point parameter of this tool . This parameter is the x,y coordinate of the point where the Z value is required. This is a required parameter.

Returns:

the Input point

setPointCoord

public void setPointCoord(Object pointCoord)

Sets the Input point parameter of this tool . This parameter is the x,y coordinate of the point where the Z value is required. This is a required parameter.

Parameters:

pointCoord - the x,y coordinate of the point where the Z value is required.

getOutZValue

public double getOutZValue()

Returns the Result (z-value) parameter of this tool (Read only). This is an derived parameter.

Returns:

the Result (z-value)

getToolName

public String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias