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

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

All Implemented Interfaces:

GPTool

public class MinimumBoundingGeometry
extends AbstractGPTool

Creates a feature class containing polygons which represent a specified minimum bounding geometry enclosing each input feature. The Minimum Bounding Geometry tool is contained in the Data Management Tools tool box.

Usage tips:

• The output polygon features and their attributes will vary depending on the specified geometry type and grouping choices.
• The Group Option parameter on the dialog box (the group_option parameter in scripting) will affect the output polygons and attributes in the following ways:
• Each geometry type can be characterized by one or more unique measurements; these measurements can optionally be added to the output as new fields as described below. The width, length, and diameter values are in feature units; the orientation angles are in decimal degrees clockwise from north. The prefix, MBG_, indicates minimum boulding geometry field.
• There are special cases of input features that would result in invalid (zero-area) output polygons. In these cases, a small value derived from the input feature XY Tolerance will be used as the width, length, or diameter to create output polygons. These polygons serve as 'place holders' for keeping track of features. If the resulting polygons appear 'invisible' in ArcMap using the default polygon outline width, change to a thicker outline line symbol to display them. The examples of these cases include:

Field Summary

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

vals

Constructor Summary

MinimumBoundingGeometry()
Creates the Minimum Bounding Geometry tool with defaults.

MinimumBoundingGeometry(Object inFeatures, Object outFeatureClass)
Creates the Minimum Bounding Geometry tool with the required parameters.

Method Summary

String	getGeometryType() Returns the Geometry Type parameter of this tool .
Object	getGroupField() Returns the Group Field(s) parameter of this tool .
String	getGroupOption() Returns the Group Option parameter of this tool .
Object	getInFeatures() Returns the Input Features parameter of this tool .
String	getMbgFieldsOption() Returns the Add geometry characteristics as attributes to output parameter of this tool .
Object	getOutFeatureClass() 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	setGeometryType(String geometryType) Sets the Geometry Type parameter of this tool .
void	setGroupField(Object groupField) Sets the Group Field(s) parameter of this tool .
void	setGroupOption(String groupOption) Sets the Group Option parameter of this tool .
void	setInFeatures(Object inFeatures) Sets the Input Features parameter of this tool .
void	setMbgFieldsOption(String mbgFieldsOption) Sets the Add geometry characteristics as attributes to output parameter of this tool .
void	setOutFeatureClass(Object outFeatureClass) 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

MinimumBoundingGeometry

public MinimumBoundingGeometry()

Creates the Minimum Bounding Geometry tool with defaults.

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

MinimumBoundingGeometry

public MinimumBoundingGeometry(Object inFeatures,
                               Object outFeatureClass)

Creates the Minimum Bounding Geometry 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 - the input features that can be point, multipoint, line, polygon, or multipatch.

outFeatureClass - the output polygon feature class.

Method Detail

getInFeatures

public Object getInFeatures()

Returns the Input Features parameter of this tool . This parameter is the input features that can be point, multipoint, line, polygon, or multipatch. 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 the input features that can be point, multipoint, line, polygon, or multipatch. This is a required parameter.

Parameters:

inFeatures - the input features that can be point, multipoint, line, polygon, or multipatch.

getOutFeatureClass

public Object getOutFeatureClass()

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

Parameters:

outFeatureClass - the output polygon feature class.

getGeometryType

public String getGeometryType()

Returns the Geometry Type parameter of this tool . This parameter is specifies what type of minimum bounding geometry the output polygons will represent. This is an optional parameter.

Returns:

the Geometry Type

setGeometryType

public void setGeometryType(String geometryType)

Sets the Geometry Type parameter of this tool . This parameter is specifies what type of minimum bounding geometry the output polygons will represent. This is an optional parameter.

Parameters:

geometryType - specifies what type of minimum bounding geometry the output polygons will represent.

getGroupOption

public String getGroupOption()

Returns the Group Option parameter of this tool . This parameter is specifies how the input features will be grouped; each group will be enclosed with one output polygon. This is an optional parameter.

Returns:

the Group Option

setGroupOption

public void setGroupOption(String groupOption)

Sets the Group Option parameter of this tool . This parameter is specifies how the input features will be grouped; each group will be enclosed with one output polygon. This is an optional parameter.

Parameters:

groupOption - specifies how the input features will be grouped; each group will be enclosed with one output polygon.

getGroupField

public Object getGroupField()

Returns the Group Field(s) parameter of this tool . This parameter is the field or fields in the input features that will be used to group features, when LIST is specified as Group Option. All features that have the same value in the specified field or fields will be treated as a group. If no field name is specified, none of the input features will be grouped. This is an optional parameter.

Returns:

the Group Field(s)

setGroupField

public void setGroupField(Object groupField)

Sets the Group Field(s) parameter of this tool . This parameter is the field or fields in the input features that will be used to group features, when LIST is specified as Group Option. All features that have the same value in the specified field or fields will be treated as a group. If no field name is specified, none of the input features will be grouped. This is an optional parameter.

Parameters:

groupField - the field or fields in the input features that will be used to group features, when LIST is specified as Group Option. All features that have the same value in the specified field or fields will be treated as a group. If no field name is specified, none of the input features will be grouped.

getMbgFieldsOption

public String getMbgFieldsOption()

Returns the Add geometry characteristics as attributes to output parameter of this tool . This parameter is specifies whether to add the geometric attributes in the output feature class or omit them in the output feature class. This is an optional parameter.

Returns:

the Add geometry characteristics as attributes to output

setMbgFieldsOption

public void setMbgFieldsOption(String mbgFieldsOption)

Sets the Add geometry characteristics as attributes to output parameter of this tool . This parameter is specifies whether to add the geometric attributes in the output feature class or omit them in the output feature class. This is an optional parameter.

Parameters:

mbgFieldsOption - specifies whether to add the geometric attributes in the output feature class or omit them in 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