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

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

All Implemented Interfaces:

GPTool

public class GACreateGeostatisticalLayer
extends AbstractGPTool

Creates a new geostatistical layer. An existing geostatistical layer or geostatistical model is required to populate the initial values for the new layer. The input to this tool can be created using the Geostatistical Wizard. The Create Geostatistical Layer tool is contained in the Geostatistical Analyst Tools tool box.

Usage tips:

• Geostatistical model source is either a geostatistical layer or a geostatistical model (XML).
• The input to this tool is a geostatistical model source which can be either a geostatistical layer or an XML file. The complete name of the dataset that is used to create the geostatistical layer is stored within the layer. However, the XML file only contains the model parameters and not the dataset information.
• If a NODATA value was specified in the Geostatistical Wizard it will be ignored by this tool.
• If a selection exists on any of the input layers, then those layers should be specified in the Input dataset(s) parameter rather than the full name and path to the dataset on disk.
• All the Geostatistical Analyst geoprocessing tools are functional in ArcGlobe or ArcScene. However, a geostatistical layer can only be displayed using ArcMap or ArcCatalog and it is therefore recommended that geostatistical analysis rather be performed using these products.
• For data formats that support Null values, such as file and personal geodatabase feature classes, a Null value will be used to indicate that a prediction could not be made for that location or that the value showed be ignored when used as input. For data formats that do not support Null values, such as shapefiles, the value of -1.7976931348623158e+308 is used (this is the negative of the C++ defined constant DBL_MAX) to indicate that a prediction could not be made for that location.

Field Summary

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

vals

Constructor Summary

GACreateGeostatisticalLayer()
Creates the Create Geostatistical Layer tool with defaults.

GACreateGeostatisticalLayer(Object inGaModelSource, Object inDatasets, Object outLayer)
Creates the Create Geostatistical Layer tool with the required parameters.

Method Summary

Object	getInDatasets() Returns the Input dataset(s) parameter of this tool .
Object	getInGaModelSource() Returns the Geostatistical model source parameter of this tool .
Object	getOutLayer() Returns the Output geostatistical layer 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	setInDatasets(Object inDatasets) Sets the Input dataset(s) parameter of this tool .
void	setInGaModelSource(Object inGaModelSource) Sets the Geostatistical model source parameter of this tool .
void	setOutLayer(Object outLayer) Sets the Output geostatistical layer 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

GACreateGeostatisticalLayer

public GACreateGeostatisticalLayer()

Creates the Create Geostatistical Layer tool with defaults.

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

GACreateGeostatisticalLayer

public GACreateGeostatisticalLayer(Object inGaModelSource,
                                   Object inDatasets,
                                   Object outLayer)

Creates the Create Geostatistical Layer 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.

inDatasets - input dataset(s) displays two pieces:

outLayer - the geostatistical layer produced by the tool.

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.

getInDatasets

public Object getInDatasets()

Returns the Input dataset(s) parameter of this tool . This parameter is input dataset(s) displays two pieces: This is a required parameter.

Returns:

the Input dataset(s)

setInDatasets

public void setInDatasets(Object inDatasets)

Sets the Input dataset(s) parameter of this tool . This parameter is input dataset(s) displays two pieces: This is a required parameter.

Parameters:

inDatasets - input dataset(s) displays two pieces:

getOutLayer

public Object getOutLayer()

Returns the Output geostatistical layer parameter of this tool . This parameter is the geostatistical layer produced by the tool. This is a required parameter.

Returns:

the Output geostatistical layer

setOutLayer

public void setOutLayer(Object outLayer)

Sets the Output geostatistical layer parameter of this tool . This parameter is the geostatistical layer produced by the tool. This is a required parameter.

Parameters:

outLayer - the geostatistical layer produced by the tool.

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