com.esri.arcgis.geoprocessing.tools.spatialstatisticstools
Class CalculateAreas

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.spatialstatisticstools.CalculateAreas

All Implemented Interfaces:

GPTool

public class CalculateAreas

extends AbstractGPTool

Calculates Area values for each feature in a polygon feature class. The Calculate Areas tool is contained in the Spatial Statistics Tools tool box.

Software restrictions: none

Usage tips:

• This tool is useful in determining a weight for intrazonal interaction.
• Learn more about Modeling Spatial Relationships - Self-potential;
• This tool can be used to calculate an Area value for a study area polygon.
• The field F_AREA is created in the output feature class to store calculated Area values. If a field of this name already exists in the input feature class, it will be overwritten in the output feature class.
• The F_AREA field will be populated with values representing the area of the polygon in square units of the input feature class' coordinate system's units. There is one exception to this rule. When the Output Coordinate System environment variable is set, then the units of the distance band will be the units of the coordinate system set in that environment.
• The following environment settings affect this tool: Extent; M Domain; Configuration Keyword; Coordinate System; Output has M Values; Output Spatial Grid; Output has Z Values; Default Z Value; Output XY Domain; , and Output Z Domain;

Field Summary

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

vals

Constructor Summary

CalculateAreas()
Creates the Calculate Areas tool with defaults.

CalculateAreas(java.lang.Object inputFeatureClass, java.lang.Object outputFeatureClass)
Creates the Calculate Areas tool with the required parameters.

Method Summary

java.lang.Object	getInputFeatureClass() Returns the Input Feature Class parameter of this tool .
java.lang.Object	getOutputFeatureClass() Returns the Output Feature Class parameter of this tool .
java.lang.String	getToolboxAlias() Returns the alias of the tool box containing this tool.
java.lang.String	getToolboxName() Returns the name of the tool box containing this tool.
java.lang.String	getToolName() Returns the name of this tool.
void	setInputFeatureClass(java.lang.Object inputFeatureClass) Sets the Input Feature Class parameter of this tool .
void	setOutputFeatureClass(java.lang.Object outputFeatureClass) 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

CalculateAreas

public CalculateAreas()

Creates the Calculate Areas tool with defaults.

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

CalculateAreas

public CalculateAreas(java.lang.Object inputFeatureClass,
                      java.lang.Object outputFeatureClass)

Creates the Calculate Areas 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:

inputFeatureClass - Feature Layer, the feature class containing polygon features from which to calculate Area values.

outputFeatureClass - Feature Class, the feature class to contain the calculated Area values.

Method Detail

getInputFeatureClass

public java.lang.Object getInputFeatureClass()

Returns the Input Feature Class parameter of this tool . This parameter is Feature Layer, the feature class containing polygon features from which to calculate Area values. This is a required parameter.

Returns:

the Input Feature Class

setInputFeatureClass

public void setInputFeatureClass(java.lang.Object inputFeatureClass)

Sets the Input Feature Class parameter of this tool . This parameter is Feature Layer, the feature class containing polygon features from which to calculate Area values. This is a required parameter.

Parameters:

inputFeatureClass - Feature Layer, the feature class containing polygon features from which to calculate Area values.

getOutputFeatureClass

public java.lang.Object getOutputFeatureClass()

Returns the Output Feature Class parameter of this tool . This parameter is Feature Class, the feature class to contain the calculated Area values. This is a required parameter.

Returns:

the Output Feature Class

setOutputFeatureClass

public void setOutputFeatureClass(java.lang.Object outputFeatureClass)

Sets the Output Feature Class parameter of this tool . This parameter is Feature Class, the feature class to contain the calculated Area values. This is a required parameter.

Parameters:

outputFeatureClass - Feature Class, the feature class to contain the calculated Area values.

getToolName

public java.lang.String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public java.lang.String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public java.lang.String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias