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

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

All Implemented Interfaces:

GPTool

public class SurfaceLength
extends AbstractGPTool

Calculates the surface length of each line in a feature class based on a raster or TIN surface. The surface length information is stored as an attribute of the input feature class. The Surface Length tool is contained in the 3D Analyst Tools tool box.
Learn more about how Surface Length (3D Analyst) works

Software restrictions: none

Illustration:

Usage tips:

• Use a smaller sampling distance to increase the accuracy of the surface length calculations.
• Use {out_length_field} to give the length field a custom name.
• The following environment settings affect this tool:

Field Summary

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

vals

Constructor Summary

SurfaceLength()
Creates the Surface Length tool with defaults.

SurfaceLength(Object inSurface, Object inFeatureClass)
Creates the Surface Length tool with the required parameters.

Method Summary

Object	getInFeatureClass() Returns the Input Feature Class parameter of this tool .
Object	getInSurface() Returns the Input Surface parameter of this tool .
String	getOutLengthField() Returns the Surface Length Field parameter of this tool .
Object	getOutputFeatureClass() Returns the Output Feature Class parameter of this tool (Read only).
double	getSampleDistance() Returns the Sampling Distance 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.
double	getZFactor() Returns the Z Factor parameter of this tool .
void	setInFeatureClass(Object inFeatureClass) Sets the Input Feature Class parameter of this tool .
void	setInSurface(Object inSurface) Sets the Input Surface parameter of this tool .
void	setOutLengthField(String outLengthField) Sets the Surface Length Field parameter of this tool .
void	setSampleDistance(double sampleDistance) Sets the Sampling Distance 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

SurfaceLength

public SurfaceLength()

Creates the Surface Length tool with defaults.

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

SurfaceLength

public SurfaceLength(Object inSurface,
                     Object inFeatureClass)

Creates the Surface Length 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 - Tin Layer | Raster Layer, the input raster or TIN surface whose values will be used for interpolation.

inFeatureClass - Feature Layer, the input feature class.

Method Detail

getInSurface

public Object getInSurface()

Returns the Input Surface parameter of this tool . This parameter is Tin Layer | Raster Layer, the input raster or TIN surface whose values will be used for interpolation. 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 Tin Layer | Raster Layer, the input raster or TIN surface whose values will be used for interpolation. This is a required parameter.

Parameters:

inSurface - Tin Layer | Raster Layer, the input raster or TIN surface whose values will be used for interpolation.

getInFeatureClass

public Object getInFeatureClass()

Returns the Input Feature Class parameter of this tool . This parameter is Feature Layer, the input feature class. This is a required parameter.

Returns:

the Input Feature Class

setInFeatureClass

public void setInFeatureClass(Object inFeatureClass)

Sets the Input Feature Class parameter of this tool . This parameter is Feature Layer, the input feature class. This is a required parameter.

Parameters:

inFeatureClass - Feature Layer, the input feature class.

getOutLengthField

public String getOutLengthField()

Returns the Surface Length Field parameter of this tool . This parameter is String, the name of the attribute field to contain the surface length of the feature. This is an optional parameter.

Returns:

the Surface Length Field

setOutLengthField

public void setOutLengthField(String outLengthField)

Sets the Surface Length Field parameter of this tool . This parameter is String, the name of the attribute field to contain the surface length of the feature. This is an optional parameter.

Parameters:

outLengthField - String, the name of the attribute field to contain the surface length of the feature.

getSampleDistance

public double getSampleDistance()

Returns the Sampling Distance parameter of this tool . This parameter is Double, the surface spacing at which the length is calculated. By default, the sampling distance is the natural densification of a TIN or the cell size of a raster. This is an optional parameter.

Returns:

the Sampling Distance

setSampleDistance

public void setSampleDistance(double sampleDistance)

Sets the Sampling Distance parameter of this tool . This parameter is Double, the surface spacing at which the length is calculated. By default, the sampling distance is the natural densification of a TIN or the cell size of a raster. This is an optional parameter.

Parameters:

sampleDistance - Double, the surface spacing at which the length is calculated. By default, the sampling distance is the natural densification of a TIN or the cell size of a raster.

getZFactor

public double getZFactor()

Returns the Z Factor parameter of this tool . This parameter is Double, the factor multiplied by input surface values to store new values in the length field. The z factor is used to convert z units to match x,y units. 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 Double, the factor multiplied by input surface values to store new values in the length field. The z factor is used to convert z units to match x,y units. This is an optional parameter.

Parameters:

zFactor - Double, the factor multiplied by input surface values to store new values in the length field. The z factor is used to convert z units to match x,y units.

getOutputFeatureClass

public Object getOutputFeatureClass()

Returns the Output Feature Class parameter of this tool (Read only). This is an derived parameter.

Returns:

the Output Feature Class

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