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

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

All Implemented Interfaces:

GPTool

public class GASetModelParameter
extends AbstractGPTool

Sets parameter value(s) in an existing geostatistical model source. The Set 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).
• The examples below can be used in the Parameter XML Path to specify which parameter will be set to a new value.
• The code snippet below sets multiple parameters via a single call to the tool.

Field Summary

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

vals

Constructor Summary

GASetModelParameter()
Creates the Set Model Parameter tool with defaults.

GASetModelParameter(Object inGaModelSource, String modelParamXpath, String inParamValue, Object outGaModel)
Creates the Set Model Parameter tool with the required parameters.

Method Summary

Object	getInGaModelSource() Returns the Geostatistical model source parameter of this tool .
String	getInParamValue() Returns the Parameter value parameter of this tool .
String	getModelParamXpath() Returns the Parameter XML Path parameter of this tool .
Object	getOutGaModel() Returns the Output model 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	setInGaModelSource(Object inGaModelSource) Sets the Geostatistical model source parameter of this tool .
void	setInParamValue(String inParamValue) Sets the Parameter value parameter of this tool .
void	setModelParamXpath(String modelParamXpath) Sets the Parameter XML Path parameter of this tool .
void	setOutGaModel(Object outGaModel) Sets the Output model 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

GASetModelParameter

public GASetModelParameter()

Creates the Set Model Parameter tool with defaults.

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

GASetModelParameter

public GASetModelParameter(Object inGaModelSource,
                           String modelParamXpath,
                           String inParamValue,
                           Object outGaModel)

Creates the Set 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.

inParamValue - value for the parameter defined by the XML path.

outGaModel - geostatistical model created with the parameter value defined in the XML path.

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.

getInParamValue

public String getInParamValue()

Returns the Parameter value parameter of this tool . This parameter is value for the parameter defined by the XML path. This is a required parameter.

Returns:

the Parameter value

setInParamValue

public void setInParamValue(String inParamValue)

Sets the Parameter value parameter of this tool . This parameter is value for the parameter defined by the XML path. This is a required parameter.

Parameters:

inParamValue - value for the parameter defined by the XML path.

getOutGaModel

public Object getOutGaModel()

Returns the Output model parameter of this tool . This parameter is geostatistical model created with the parameter value defined in the XML path. This is a required parameter.

Returns:

the Output model

setOutGaModel

public void setOutGaModel(Object outGaModel)

Sets the Output model parameter of this tool . This parameter is geostatistical model created with the parameter value defined in the XML path. This is a required parameter.

Parameters:

outGaModel - geostatistical model created with the parameter value defined in the XML path.

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