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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.spatialstatisticstools.DirectionalMean
All Implemented Interfaces:
GPTool

public class DirectionalMean
extends AbstractGPTool

Identifies the general (mean) direction for a set of lines. The Linear Directional Mean tool is contained in the Spatial Statistics Tools tool box.
Learn about how Linear Directional Mean works

Software restrictions: none

Illustration:

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
DirectionalMean()
          Creates the Linear Directional Mean tool with defaults.
DirectionalMean(Object inputFeatureClass, Object outputFeatureClass, String orientationOnly)
          Creates the Linear Directional Mean tool with the required parameters.
 
Method Summary
 Object getCaseField()
          Returns the Case Field parameter of this tool .
 Object getInputFeatureClass()
          Returns the Input Feature Class parameter of this tool .
 String getOrientationOnly()
          Returns the Orientation Only parameter of this tool .
 Object getOutputFeatureClass()
          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 setCaseField(Object caseField)
          Sets the Case Field parameter of this tool .
 void setInputFeatureClass(Object inputFeatureClass)
          Sets the Input Feature Class parameter of this tool .
 void setOrientationOnly(String orientationOnly)
          Sets the Orientation Only parameter of this tool .
 void setOutputFeatureClass(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

DirectionalMean

public DirectionalMean()
Creates the Linear Directional Mean tool with defaults.

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


DirectionalMean

public DirectionalMean(Object inputFeatureClass,
                       Object outputFeatureClass,
                       String orientationOnly)
Creates the Linear Directional Mean 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 vectors for which the mean direction will be calculated.
outputFeatureClass - Feature Class, a line feature class that will contain the features representing the mean directions of the input feature class.
orientationOnly - String, specifies whether to include direction (From and To nodes) information in the analysis.
Method Detail

getInputFeatureClass

public Object getInputFeatureClass()
Returns the Input Feature Class parameter of this tool . This parameter is Feature Layer, the feature class containing vectors for which the mean direction will be calculated. This is a required parameter.

Returns:
the Input Feature Class

setInputFeatureClass

public void setInputFeatureClass(Object inputFeatureClass)
Sets the Input Feature Class parameter of this tool . This parameter is Feature Layer, the feature class containing vectors for which the mean direction will be calculated. This is a required parameter.

Parameters:
inputFeatureClass - Feature Layer, the feature class containing vectors for which the mean direction will be calculated.

getOutputFeatureClass

public Object getOutputFeatureClass()
Returns the Output Feature Class parameter of this tool . This parameter is Feature Class, a line feature class that will contain the features representing the mean directions of the input feature class. This is a required parameter.

Returns:
the Output Feature Class

setOutputFeatureClass

public void setOutputFeatureClass(Object outputFeatureClass)
Sets the Output Feature Class parameter of this tool . This parameter is Feature Class, a line feature class that will contain the features representing the mean directions of the input feature class. This is a required parameter.

Parameters:
outputFeatureClass - Feature Class, a line feature class that will contain the features representing the mean directions of the input feature class.

getOrientationOnly

public String getOrientationOnly()
Returns the Orientation Only parameter of this tool . This parameter is String, specifies whether to include direction (From and To nodes) information in the analysis. This is a required parameter.

Returns:
the Orientation Only

setOrientationOnly

public void setOrientationOnly(String orientationOnly)
Sets the Orientation Only parameter of this tool . This parameter is String, specifies whether to include direction (From and To nodes) information in the analysis. This is a required parameter.

Parameters:
orientationOnly - String, specifies whether to include direction (From and To nodes) information in the analysis.

getCaseField

public Object getCaseField()
Returns the Case Field parameter of this tool . This parameter is Field, field used to group features for separate directional mean calculations. The case field can be of numeric, date, or string type. This is an optional parameter.

Returns:
the Case Field

setCaseField

public void setCaseField(Object caseField)
Sets the Case Field parameter of this tool . This parameter is Field, field used to group features for separate directional mean calculations. The case field can be of numeric, date, or string type. This is an optional parameter.

Parameters:
caseField - Field, field used to group features for separate directional mean calculations. The case field can be of numeric, date, or string type.

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