com.esri.arcgis.geoprocessing.tools.analyst3dtools
Class SurfaceSlope

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.analyst3dtools.SurfaceSlope

All Implemented Interfaces:

GPTool

public class SurfaceSlope
extends AbstractGPTool

Extracts slope information from an input TIN or terrain dataset into an output feature class. The Surface Slope tool is contained in the 3D Analyst Tools tool box.

Usage tips:

• Use {class_breaks_table} to constrain slope information into specific break intervals of the output feature class.
• Use a comma-delimited TXT or DBF file for a class breaks table. The table requires one column for class break values and, optionally, a second column of class codes. Also, the table needs a header row so that the first row of true data is not skipped. An example is illustrated in the following link:
• Units are only honored when using a class breaks table.

Field Summary

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

vals

Constructor Summary

SurfaceSlope()
Creates the Surface Slope tool with defaults.

SurfaceSlope(Object inSurface, Object outFeatureClass)
Creates the Surface Slope tool with the required parameters.

Method Summary

Object	getClassBreaksTable() Returns the Class Breaks Table parameter of this tool .
Object	getInSurface() Returns the Input Surface parameter of this tool .
Object	getOutFeatureClass() Returns the Output Feature Class parameter of this tool .
double	getPyramidLevelResolution() Returns the Pyramid Level Resolution parameter of this tool .
String	getSlopeField() Returns the Slope Field 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.
String	getUnits() Returns the Slope Units parameter of this tool .
double	getZFactor() Returns the Z Factor parameter of this tool .
void	setClassBreaksTable(Object classBreaksTable) Sets the Class Breaks Table parameter of this tool .
void	setInSurface(Object inSurface) Sets the Input Surface parameter of this tool .
void	setOutFeatureClass(Object outFeatureClass) Sets the Output Feature Class parameter of this tool .
void	setPyramidLevelResolution(double pyramidLevelResolution) Sets the Pyramid Level Resolution parameter of this tool .
void	setSlopeField(String slopeField) Sets the Slope Field parameter of this tool .
void	setUnits(String units) Sets the Slope Units parameter of this tool .
void	setZFactor(double zFactor) Sets the Z Factor 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

SurfaceSlope

public SurfaceSlope()

Creates the Surface Slope tool with defaults.

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

SurfaceSlope

public SurfaceSlope(Object inSurface,
                    Object outFeatureClass)

Creates the Surface Slope 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:

inSurface - the input terrain dataset or TIN surface.

outFeatureClass - the output feature class.

Method Detail

getInSurface

public Object getInSurface()

Returns the Input Surface parameter of this tool . This parameter is the input terrain dataset or TIN surface. This is a required parameter.

Returns:

the Input Surface

setInSurface

public void setInSurface(Object inSurface)

Sets the Input Surface parameter of this tool . This parameter is the input terrain dataset or TIN surface. This is a required parameter.

Parameters:

inSurface - the input terrain dataset or TIN surface.

getOutFeatureClass

public Object getOutFeatureClass()

Returns the Output Feature Class parameter of this tool . This parameter is the output feature class. 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. This is a required parameter.

Parameters:

outFeatureClass - the output feature class.

getUnits

public String getUnits()

Returns the Slope Units parameter of this tool . This parameter is the units of measure for the slope values. Units are honored when a class breaks table is used. This is an optional parameter.

Returns:

the Slope Units

setUnits

public void setUnits(String units)

Sets the Slope Units parameter of this tool . This parameter is the units of measure for the slope values. Units are honored when a class breaks table is used. This is an optional parameter.

Parameters:

units - the units of measure for the slope values. Units are honored when a class breaks table is used.

getClassBreaksTable

public Object getClassBreaksTable()

Returns the Class Breaks Table parameter of this tool . This parameter is an input table containing the classification breaks that will be used to classify the output feature class. This is an optional parameter.

Returns:

the Class Breaks Table

setClassBreaksTable

public void setClassBreaksTable(Object classBreaksTable)

Sets the Class Breaks Table parameter of this tool . This parameter is an input table containing the classification breaks that will be used to classify the output feature class. This is an optional parameter.

Parameters:

classBreaksTable - an input table containing the classification breaks that will be used to classify the output feature class.

getSlopeField

public String getSlopeField()

Returns the Slope Field parameter of this tool . This parameter is the field containing slope values. This is an optional parameter.

Returns:

the Slope Field

setSlopeField

public void setSlopeField(String slopeField)

Sets the Slope Field parameter of this tool . This parameter is the field containing slope values. This is an optional parameter.

Parameters:

slopeField - the field containing slope values.

getZFactor

public double getZFactor()

Returns the Z Factor parameter of this tool . This parameter is the factor applied to the slope calculation to convert the surface's z units to x and y units. By default, the z-factor is 1. This is an optional parameter.

Returns:

the Z Factor

setZFactor

public void setZFactor(double zFactor)

Sets the Z Factor parameter of this tool . This parameter is the factor applied to the slope calculation to convert the surface's z units to x and y units. By default, the z-factor is 1. This is an optional parameter.

Parameters:

zFactor - the factor applied to the slope calculation to convert the surface's z units to x and y units. By default, the z-factor is 1.

getPyramidLevelResolution

public double getPyramidLevelResolution()

Returns the Pyramid Level Resolution parameter of this tool . This parameter is the pyramid level resolution of the terrain dataset to use for interpolation. The default is 0, full resolution. This is an optional parameter.

Returns:

the Pyramid Level Resolution

setPyramidLevelResolution

public void setPyramidLevelResolution(double pyramidLevelResolution)

Sets the Pyramid Level Resolution parameter of this tool . This parameter is the pyramid level resolution of the terrain dataset to use for interpolation. The default is 0, full resolution. This is an optional parameter.

Parameters:

pyramidLevelResolution - the pyramid level resolution of the terrain dataset to use for interpolation. The default is 0, full resolution.

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