com.esri.arcgis.geoprocessing.tools.datamanagementtools
Class FeatureEnvelopeToPolygon

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.datamanagementtools.FeatureEnvelopeToPolygon

All Implemented Interfaces:

GPTool

public class FeatureEnvelopeToPolygon
extends AbstractGPTool

Creates a feature class containing polygons generated from the envelopes of each feature in the input feature class. An envelope is a rectangular polygon that completely covers a feature from its minimum x and y coordinates to its maximum x and y coordinates. The Feature Envelope to Polygon tool is contained in the Data Management Tools tool box.
Learn more about how Feature envelopes to polygons works

Software restrictions: ArcInfo only

Illustration:

Usage tips:

• Valid inputs are line, polygon, multipoint, and annotation feature classes.
• The ORIG_FID field will be added to the Output Feature Class and will be set to the Input Feature's FID.
• When the envelope of a feature is an invalid polygon (height or width is zero), no polygon will not be written to the output.
• The multipart parameter will have no effect on the result when the input is a singlepart feature.
• Learn more about spatial reference and geoprocessing;
• The following environment settings affect this tool: Coordinate system; Extent; XY Tolerance; Z Tolerance; M Tolerance; XY Resolution; Z Resolution; M Resolution; Output XY domain; Output Z domain; Output M domain; Output has M values; Output has Z values; Default Z value; Configuration keyword; Output Spatial Grid;

Field Summary

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

vals

Constructor Summary

FeatureEnvelopeToPolygon()
Creates the Feature Envelope to Polygon tool with defaults.

FeatureEnvelopeToPolygon(Object inFeatures, Object outFeatureClass)
Creates the Feature Envelope to Polygon tool with the required parameters.

Method Summary

Object	getInFeatures() Returns the Input Features parameter of this tool .
Object	getOutFeatureClass() Returns the Output Feature Class parameter of this tool .
String	getSingleEnvelope() Returns the Create multipart features 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	setInFeatures(Object inFeatures) Sets the Input Features parameter of this tool .
void	setOutFeatureClass(Object outFeatureClass) Sets the Output Feature Class parameter of this tool .
void	setSingleEnvelope(String singleEnvelope) Sets the Create multipart features 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

FeatureEnvelopeToPolygon

public FeatureEnvelopeToPolygon()

Creates the Feature Envelope to Polygon tool with defaults.

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

FeatureEnvelopeToPolygon

public FeatureEnvelopeToPolygon(Object inFeatures,
                                Object outFeatureClass)

Creates the Feature Envelope to Polygon 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:

inFeatures - Feature Layer, the features whose envelopes will be converted to polygon features.

outFeatureClass - Feature Class, the feature class that will contain the polygons.

Method Detail

getInFeatures

public Object getInFeatures()

Returns the Input Features parameter of this tool . This parameter is Feature Layer, the features whose envelopes will be converted to polygon features. This is a required parameter.

Returns:

the Input Features

setInFeatures

public void setInFeatures(Object inFeatures)

Sets the Input Features parameter of this tool . This parameter is Feature Layer, the features whose envelopes will be converted to polygon features. This is a required parameter.

Parameters:

inFeatures - Feature Layer, the features whose envelopes will be converted to polygon features.

getOutFeatureClass

public Object getOutFeatureClass()

Returns the Output Feature Class parameter of this tool . This parameter is Feature Class, the feature class that will contain the polygons. 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 Feature Class, the feature class that will contain the polygons. This is a required parameter.

Parameters:

outFeatureClass - Feature Class, the feature class that will contain the polygons.

getSingleEnvelope

public String getSingleEnvelope()

Returns the Create multipart features parameter of this tool . This parameter is String, choose what multipart input features will produce. This is an optional parameter.

Returns:

the Create multipart features

setSingleEnvelope

public void setSingleEnvelope(String singleEnvelope)

Sets the Create multipart features parameter of this tool . This parameter is String, choose what multipart input features will produce. This is an optional parameter.

Parameters:

singleEnvelope - String, choose what multipart input features will produce.

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