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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.geostatisticalanalysttools.GALayerToContour
All Implemented Interfaces:
GPTool

public class GALayerToContour
extends AbstractGPTool

Exports a geostatistical layer to contours. The GA Layer To Contour tool is contained in the Geostatistical Analyst Tools tool box.

Software restrictions: none

Usage tips:


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 - Geostatistical Layer, input geostatistical layer.
contourType - String, type of contour to represent the geostatistical layer by.
outFeatureClass - Feature Class, the name of the output featureclass. It will be either polyline or polygon depending on the out_contour_type.
Method Detail

getInGeostatLayer

public Object getInGeostatLayer()
Returns the Input geostatistical layer parameter of this tool . This parameter is Geostatistical Layer, input geostatistical layer. 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 Geostatistical Layer, input geostatistical layer. This is a required parameter.

Parameters:
inGeostatLayer - Geostatistical Layer, input geostatistical layer.

getContourType

public String getContourType()
Returns the Contour type parameter of this tool . This parameter is String, type of contour to represent the geostatistical layer by. 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 String, type of contour to represent the geostatistical layer by. This is a required parameter.

Parameters:
contourType - String, type of contour to represent the geostatistical layer by.

getOutFeatureClass

public Object getOutFeatureClass()
Returns the Output feature class parameter of this tool . This parameter is Feature Class, the name of the output featureclass. It will be either polyline or polygon depending on the out_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 Feature Class, the name of the output featureclass. It will be either polyline or polygon depending on the out_contour_type. This is a required parameter.

Parameters:
outFeatureClass - Feature Class, the name of the output featureclass. It will be either polyline or polygon depending on the out_contour_type.

getContourQuality

public String getContourQuality()
Returns the Contour quality parameter of this tool . This parameter is string, the Quality options provide control over the smoothness of displayed Contours and Filled Contours. 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 string, the Quality options provide control over the smoothness of displayed Contours and Filled Contours. This is an optional parameter.

Parameters:
contourQuality - string, the Quality options provide control over the smoothness of displayed Contours and Filled Contours.

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