com.esri.arcgis.geoprocessing.tools.analysistools
Class MultipleRingBuffer

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.analysistools.MultipleRingBuffer

All Implemented Interfaces:

GPTool

public class MultipleRingBuffer
extends AbstractGPTool

Creates a new feature class of buffer features using a set of buffer distances. The new features may be dissolved using the distance values, or as a set of individual features. The Multiple Ring Buffer tool is contained in the Analysis Tools tool box.

Software restrictions: none

Illustration:

Usage tips:

• The tool creates scratch data in the scratch workspace if it is defined in the geoprocessing environment settings; otherwise, it uses the location defined by the TEMP system variable.
• If Field Name is not set, the default name for the field containing the distance value is "distance". The field type is double.
• Buffer Unit is not used, if the Input Features has no defined spatial reference.
• The Buffer; tool is used to create buffered features, with each specified distance being a new invocation of the tool. The Calculate Field; Union; , and Dissolve; tools merge the buffered results to create rings if Dissolve Option is set to ALL. Append; is used to aggregate the buffered results if Dissolve Option is set to NONE.
• The following environments affect this tool: configKeyword; extent; MDomain; outputCoordinateSystem; outputMFlag; outputZFlag; scratchWorkspace; spatialGrid1; spatialGrid2; spatialGrid3; workspace; XYDomain; , and ZDomain;

Field Summary

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

vals

Constructor Summary

MultipleRingBuffer()
Creates the Multiple Ring Buffer tool with defaults.

MultipleRingBuffer(Object inputFeatures, Object outputFeatureClass, Object distances)
Creates the Multiple Ring Buffer tool with the required parameters.

Method Summary

String	getBufferUnit() Returns the Buffer Unit parameter of this tool .
String	getDissolveOption() Returns the Dissolve Option parameter of this tool .
Object	getDistances() Returns the Distances parameter of this tool .
String	getFieldName() Returns the Field Name parameter of this tool .
Object	getInputFeatures() Returns the Input Features parameter of this tool .
Object	getOutputFeatureClass() Returns the Output Feature class parameter of this tool .
String	getOutsidePolygonsOnly() Returns the Outside Polygons Only 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	setBufferUnit(String bufferUnit) Sets the Buffer Unit parameter of this tool .
void	setDissolveOption(String dissolveOption) Sets the Dissolve Option parameter of this tool .
void	setDistances(Object distances) Sets the Distances parameter of this tool .
void	setFieldName(String fieldName) Sets the Field Name parameter of this tool .
void	setInputFeatures(Object inputFeatures) Sets the Input Features parameter of this tool .
void	setOutputFeatureClass(Object outputFeatureClass) Sets the Output Feature class parameter of this tool .
void	setOutsidePolygonsOnly(String outsidePolygonsOnly) Sets the Outside Polygons Only 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

MultipleRingBuffer

public MultipleRingBuffer()

Creates the Multiple Ring Buffer tool with defaults.

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

MultipleRingBuffer

public MultipleRingBuffer(Object inputFeatures,
                          Object outputFeatureClass,
                          Object distances)

Creates the Multiple Ring Buffer 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:

inputFeatures - Feature Layer, the input feature class containing points, lines, or polygons to be buffered.

outputFeatureClass - Feature Class, the new polygon feature class to be created.

distances - Double, the distances, in ascending size, used to create buffer zones around the Input Features.

Method Detail

getInputFeatures

public Object getInputFeatures()

Returns the Input Features parameter of this tool . This parameter is Feature Layer, the input feature class containing points, lines, or polygons to be buffered. This is a required parameter.

Returns:

the Input Features

setInputFeatures

public void setInputFeatures(Object inputFeatures)

Sets the Input Features parameter of this tool . This parameter is Feature Layer, the input feature class containing points, lines, or polygons to be buffered. This is a required parameter.

Parameters:

inputFeatures - Feature Layer, the input feature class containing points, lines, or polygons to be buffered.

getOutputFeatureClass

public Object getOutputFeatureClass()

Returns the Output Feature class parameter of this tool . This parameter is Feature Class, the new polygon feature class to be created. 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, the new polygon feature class to be created. This is a required parameter.

Parameters:

outputFeatureClass - Feature Class, the new polygon feature class to be created.

getDistances

public Object getDistances()

Returns the Distances parameter of this tool . This parameter is Double, the distances, in ascending size, used to create buffer zones around the Input Features. This is a required parameter.

Returns:

the Distances

setDistances

public void setDistances(Object distances)

Sets the Distances parameter of this tool . This parameter is Double, the distances, in ascending size, used to create buffer zones around the Input Features. This is a required parameter.

Parameters:

distances - Double, the distances, in ascending size, used to create buffer zones around the Input Features.

getBufferUnit

public String getBufferUnit()

Returns the Buffer Unit parameter of this tool . This parameter is String, if the units are not specified, or entered as 'Default', the units of the Input Features are used (or if the Output Coordinate System environment has been set, its units will be used). This is an optional parameter.

Returns:

the Buffer Unit

setBufferUnit

public void setBufferUnit(String bufferUnit)

Sets the Buffer Unit parameter of this tool . This parameter is String, if the units are not specified, or entered as 'Default', the units of the Input Features are used (or if the Output Coordinate System environment has been set, its units will be used). This is an optional parameter.

Parameters:

bufferUnit - String, if the units are not specified, or entered as 'Default', the units of the Input Features are used (or if the Output Coordinate System environment has been set, its units will be used).

getFieldName

public String getFieldName()

Returns the Field Name parameter of this tool . This parameter is String, the name of the field in the Output Feature Class that will store the buffer distance used to create each feature. If no value is specified, the name will be "distance". The type of the field is double. This is an optional parameter.

Returns:

the Field Name

setFieldName

public void setFieldName(String fieldName)

Sets the Field Name parameter of this tool . This parameter is String, the name of the field in the Output Feature Class that will store the buffer distance used to create each feature. If no value is specified, the name will be "distance". The type of the field is double. This is an optional parameter.

Parameters:

fieldName - String, the name of the field in the Output Feature Class that will store the buffer distance used to create each feature. If no value is specified, the name will be "distance". The type of the field is double.

getDissolveOption

public String getDissolveOption()

Returns the Dissolve Option parameter of this tool . This is an optional parameter.

Returns:

the Dissolve Option

setDissolveOption

public void setDissolveOption(String dissolveOption)

Sets the Dissolve Option parameter of this tool . This is an optional parameter.

Parameters:

dissolveOption - null

getOutsidePolygonsOnly

public String getOutsidePolygonsOnly()

Returns the Outside Polygons Only parameter of this tool . This is an optional parameter.

Returns:

the Outside Polygons Only

setOutsidePolygonsOnly

public void setOutsidePolygonsOnly(String outsidePolygonsOnly)

Sets the Outside Polygons Only parameter of this tool . This is an optional parameter.

Parameters:

outsidePolygonsOnly - null

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