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

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

All Implemented Interfaces:

GPTool

public class SurfaceAspect
extends AbstractGPTool

This tool extracts aspect information from an input TIN or terrain dataset into an output feature class. It produces a polygon feature class whose polygons are categorized by the input surface triangle aspect values. The Surface Aspect tool is contained in the 3D Analyst Tools tool box.

Usage tips:

• Aspect is expressed in degrees.

Field Summary

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

vals

Constructor Summary

SurfaceAspect()
Creates the Surface Aspect tool with defaults.

SurfaceAspect(Object inSurface, Object outFeatureClass)
Creates the Surface Aspect tool with the required parameters.

Method Summary

String	getAspectField() Returns the Aspect Field parameter of this tool .
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	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	setAspectField(String aspectField) Sets the Aspect Field 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 .

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

SurfaceAspect

public SurfaceAspect()

Creates the Surface Aspect tool with defaults.

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

SurfaceAspect

public SurfaceAspect(Object inSurface,
                     Object outFeatureClass)

Creates the Surface Aspect 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.

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.

getAspectField

public String getAspectField()

Returns the Aspect Field parameter of this tool . This parameter is the field containing aspect values. This is an optional parameter.

Returns:

the Aspect Field

setAspectField

public void setAspectField(String aspectField)

Sets the Aspect Field parameter of this tool . This parameter is the field containing aspect values. This is an optional parameter.

Parameters:

aspectField - the field containing aspect values.

getPyramidLevelResolution

public double getPyramidLevelResolution()

Returns the Pyramid Level Resolution parameter of this tool . This parameter is the resolution of the terrain dataset pyramid level to use for geoprocessing. 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 resolution of the terrain dataset pyramid level to use for geoprocessing. The default is 0, full resolution. This is an optional parameter.

Parameters:

pyramidLevelResolution - the resolution of the terrain dataset pyramid level to use for geoprocessing. 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