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

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

All Implemented Interfaces:

GPTool

public class GAGetModelParameter
extends AbstractGPTool

Gets model parameter value from an existing geostatistical model source. The Get Model Parameter tool is contained in the Geostatistical Analyst Tools tool box.

Usage tips:

• This tool is generally used in a model or in scripting.
• The geostatistical model source is either a geostatistical layer or a geostatistical model (XML).
• See for additional information.
• An examplewill return "out_param_value" = 0.345;1127.14

Field Summary

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

vals

Constructor Summary

GAGetModelParameter()
Creates the Get Model Parameter tool with defaults.

GAGetModelParameter(Object inGaModelSource, String modelParamXpath)
Creates the Get Model Parameter tool with the required parameters.

Method Summary

Object	getInGaModelSource() Returns the Geostatistical model source parameter of this tool .
String	getModelParamXpath() Returns the Parameter XML Path parameter of this tool .
String	getOutParamValue() Returns the Parameter value parameter of this tool (Read only).
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	setInGaModelSource(Object inGaModelSource) Sets the Geostatistical model source parameter of this tool .
void	setModelParamXpath(String modelParamXpath) Sets the Parameter XML Path 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

GAGetModelParameter

public GAGetModelParameter()

Creates the Get Model Parameter tool with defaults.

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

GAGetModelParameter

public GAGetModelParameter(Object inGaModelSource,
                           String modelParamXpath)

Creates the Get Model Parameter 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:

inGaModelSource - the geostatistical model source to be analyzed.

modelParamXpath - xML path to the required model parameter.

Method Detail

getInGaModelSource

public Object getInGaModelSource()

Returns the Geostatistical model source parameter of this tool . This parameter is the geostatistical model source to be analyzed. This is a required parameter.

Returns:

the Geostatistical model source

setInGaModelSource

public void setInGaModelSource(Object inGaModelSource)

Sets the Geostatistical model source parameter of this tool . This parameter is the geostatistical model source to be analyzed. This is a required parameter.

Parameters:

inGaModelSource - the geostatistical model source to be analyzed.

getModelParamXpath

public String getModelParamXpath()

Returns the Parameter XML Path parameter of this tool . This parameter is xML path to the required model parameter. This is a required parameter.

Returns:

the Parameter XML Path

setModelParamXpath

public void setModelParamXpath(String modelParamXpath)

Sets the Parameter XML Path parameter of this tool . This parameter is xML path to the required model parameter. This is a required parameter.

Parameters:

modelParamXpath - xML path to the required model parameter.

getOutParamValue

public String getOutParamValue()

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

Returns:

the Parameter 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