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

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

All Implemented Interfaces:

GPTool

public class TinAspect
extends AbstractGPTool

Extracts aspect information from an input TIN into an output feature class. The TIN 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

TinAspect()
Creates the TIN Aspect tool with defaults.

TinAspect(Object inTin, Object outFeatureClass)
Creates the TIN 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	getInTin() Returns the Input TIN 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	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	setInTin(Object inTin) Sets the Input TIN 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

TinAspect

public TinAspect()

Creates the TIN Aspect tool with defaults.

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

TinAspect

public TinAspect(Object inTin,
                 Object outFeatureClass)

Creates the TIN 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:

inTin - the input TIN.

outFeatureClass - the output feature class.

Method Detail

getInTin

public Object getInTin()

Returns the Input TIN parameter of this tool . This parameter is the input TIN. This is a required parameter.

Returns:

the Input TIN

setInTin

public void setInTin(Object inTin)

Sets the Input TIN parameter of this tool . This parameter is the input TIN. This is a required parameter.

Parameters:

inTin - the input TIN.

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.

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