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

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

All Implemented Interfaces:

GPTool

public class GALayerToContour
extends AbstractGPTool

Creates a feature class of coutours from a geostatiscal analysis layer. The output feature class can be either a line feature class of contour lines or a polygon feature class of filled contours. The GA Layer To Contour tool is contained in the Geostatistical Analyst Tools tool box.

Usage tips:

• 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

GALayerToContour()
Creates the GA Layer To Contour tool with defaults.

GALayerToContour(Object inGeostatLayer, String contourType, Object outFeatureClass)
Creates the GA Layer To Contour tool with the required parameters.

Method Summary

String	getContourQuality() Returns the Contour quality parameter of this tool .
String	getContourType() Returns the Contour type parameter of this tool .
Object	getInGeostatLayer() Returns the Input geostatistical layer parameter of this tool .
Object	getOutFeatureClass() Returns the Output feature class 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	setContourQuality(String contourQuality) Sets the Contour quality parameter of this tool .
void	setContourType(String contourType) Sets the Contour type parameter of this tool .
void	setInGeostatLayer(Object inGeostatLayer) Sets the Input geostatistical layer parameter of this tool .
void	setOutFeatureClass(Object outFeatureClass) Sets the Output feature class 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

GALayerToContour

public GALayerToContour()

Creates the GA Layer To Contour tool with defaults.

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

GALayerToContour

public GALayerToContour(Object inGeostatLayer,
                        String contourType,
                        Object outFeatureClass)

Creates the GA Layer To Contour 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.

contourType - type of contour to represent the geostatistical layer.

outFeatureClass - the output feature class will either be a polyline or a polygon, depending on the selected Contour type.

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.

getContourType

public String getContourType()

Returns the Contour type parameter of this tool . This parameter is type of contour to represent the geostatistical layer. This is a required parameter.

Returns:

the Contour type

setContourType

public void setContourType(String contourType)

Sets the Contour type parameter of this tool . This parameter is type of contour to represent the geostatistical layer. This is a required parameter.

Parameters:

contourType - type of contour to represent the geostatistical layer.

getOutFeatureClass

public Object getOutFeatureClass()

Returns the Output feature class parameter of this tool . This parameter is the output feature class will either be a polyline or a polygon, depending on the selected Contour type. This is a required parameter.

Returns:

the Output feature class

setOutFeatureClass

public void setOutFeatureClass(Object outFeatureClass)

Sets the Output feature class parameter of this tool . This parameter is the output feature class will either be a polyline or a polygon, depending on the selected Contour type. This is a required parameter.

Parameters:

outFeatureClass - the output feature class will either be a polyline or a polygon, depending on the selected Contour type.

getContourQuality

public String getContourQuality()

Returns the Contour quality parameter of this tool . This parameter is determines the smoothness of contour line representation. This is an optional parameter.

Returns:

the Contour quality

setContourQuality

public void setContourQuality(String contourQuality)

Sets the Contour quality parameter of this tool . This parameter is determines the smoothness of contour line representation. This is an optional parameter.

Parameters:

contourQuality - determines the smoothness of contour line representation.

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