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

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

All Implemented Interfaces:

GPTool

public class SimplifyBuilding
extends AbstractGPTool

Simplifies the boundary or footprint of building polygons while maintaining their essential shape and size. The Simplify Building tool is contained in the Data Management Tools tool box.
Learn more about how Simplify Building works

Illustration:

Usage tips:

• The output feature class will carry all the input fields.
• The output feature class will contain two new fields: BLD_STATUS and BLD_GROUP. The BLD_STATUS records the following simplification status:
  • Simplified single building, status value = 1
  • A short side found in the resulting building, status value = 3
  • Simplified or partially simplified buildings connected with straight lines, status value = 4
  • Not simplified, status value = 5
  The BLD_GROUP stores a unique positive value for each group of connected buildings. A single building will receive a BLD_GROUP value of 0. A single building with a hole will receive a unique negative value.
• If the checkbox "Check for spatial conflicts" is checked or the CHECK_CONFLICTS option is used, the tool will detect spatial conflicts and add another new field, SimBldFlag, to store conflict flags: a value of 0 for no conflict and 1 for conflict.
• Invalid (self-intersecting) geometry may be created during the simplification process and will be repaired. For example, if a polygon crosses itself, the polygon will be repaired to become a multiple-part polygon such that no part crosses any other part, although the polygon will still look self-crossing.
• If the input features contain Z values, the Z values can be preserved, if specified in the Environmental Settings. Where the output vertices fall on input feature vertices, the input Z values will be carried over to the output vertices; otherwise, a Z value will be derived for a new vertex, taking an existing Z value or through interpolation.
• This tool is not supported in an edit session.
• Learn more about spatial reference and geoprocessing
• The following environment settings affect this tool: XY tolerance, Extent, M domain, Coordinate system, Output has M values, Output has Z values, Default Z value, Output XY domain, workspace, and scratch workspace.

Field Summary

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

vals

Constructor Summary

SimplifyBuilding()
Creates the Simplify Building tool with defaults.

SimplifyBuilding(Object inFeatures, Object outFeatureClass, Object simplificationTolerance)
Creates the Simplify Building tool with the required parameters.

Method Summary

String	getConflictOption() Returns the Check for spatial conflicts parameter of this tool .
Object	getInFeatures() Returns the Input Features parameter of this tool .
Object	getMinimumArea() Returns the Minimum Area parameter of this tool .
Object	getOutFeatureClass() Returns the Output Feature Class parameter of this tool .
Object	getSimplificationTolerance() Returns the Simplification Tolerance 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	setConflictOption(String conflictOption) Sets the Check for spatial conflicts parameter of this tool .
void	setInFeatures(Object inFeatures) Sets the Input Features parameter of this tool .
void	setMinimumArea(Object minimumArea) Sets the Minimum Area parameter of this tool .
void	setOutFeatureClass(Object outFeatureClass) Sets the Output Feature Class parameter of this tool .
void	setSimplificationTolerance(Object simplificationTolerance) Sets the Simplification Tolerance 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

SimplifyBuilding

public SimplifyBuilding()

Creates the Simplify Building tool with defaults.

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

SimplifyBuilding

public SimplifyBuilding(Object inFeatures,
                        Object outFeatureClass,
                        Object simplificationTolerance)

Creates the Simplify Building 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 building polygons to be simplified.

outFeatureClass - Feature Class, the output feature class to be created.

simplificationTolerance - Linear Unit, sets the tolerance for building simplification. A tolerance must be specified, and it must be greater than zero. You can specify a preferred unit; the default is the feature unit.

Method Detail

getInFeatures

public Object getInFeatures()

Returns the Input Features parameter of this tool . This parameter is Feature Layer, the building polygons to be simplified. 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 building polygons to be simplified. This is a required parameter.

Parameters:

inFeatures - Feature Layer, the building polygons to be simplified.

getOutFeatureClass

public Object getOutFeatureClass()

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

Parameters:

outFeatureClass - Feature Class, the output feature class to be created.

getSimplificationTolerance

public Object getSimplificationTolerance()

Returns the Simplification Tolerance parameter of this tool . This parameter is Linear Unit, sets the tolerance for building simplification. A tolerance must be specified, and it must be greater than zero. You can specify a preferred unit; the default is the feature unit. This is a required parameter.

Returns:

the Simplification Tolerance

setSimplificationTolerance

public void setSimplificationTolerance(Object simplificationTolerance)

Sets the Simplification Tolerance parameter of this tool . This parameter is Linear Unit, sets the tolerance for building simplification. A tolerance must be specified, and it must be greater than zero. You can specify a preferred unit; the default is the feature unit. This is a required parameter.

Parameters:

simplificationTolerance - Linear Unit, sets the tolerance for building simplification. A tolerance must be specified, and it must be greater than zero. You can specify a preferred unit; the default is the feature unit.

getMinimumArea

public Object getMinimumArea()

Returns the Minimum Area parameter of this tool . This parameter is Areal Unit, sets the minimum area for a simplified building to be retained in feature units. The default value is zero, that is, to keep all buildings. You can specify a preferred unit; the default is the feature unit. This is an optional parameter.

Returns:

the Minimum Area

setMinimumArea

public void setMinimumArea(Object minimumArea)

Sets the Minimum Area parameter of this tool . This parameter is Areal Unit, sets the minimum area for a simplified building to be retained in feature units. The default value is zero, that is, to keep all buildings. You can specify a preferred unit; the default is the feature unit. This is an optional parameter.

Parameters:

minimumArea - Areal Unit, sets the minimum area for a simplified building to be retained in feature units. The default value is zero, that is, to keep all buildings. You can specify a preferred unit; the default is the feature unit.

getConflictOption

public String getConflictOption()

Returns the Check for spatial conflicts parameter of this tool . This parameter is String, specifies whether or not to check for potential conflicts, that is, overlapping or touching, among buildings. This is an optional parameter.

Returns:

the Check for spatial conflicts

setConflictOption

public void setConflictOption(String conflictOption)

Sets the Check for spatial conflicts parameter of this tool . This parameter is String, specifies whether or not to check for potential conflicts, that is, overlapping or touching, among buildings. This is an optional parameter.

Parameters:

conflictOption - String, specifies whether or not to check for potential conflicts, that is, overlapping or touching, among buildings.

• NO_CHECK—Specifies not to check for potential conflicts; the resulting buildings may overlap. This is the default.
• CHECK_CONFLICTS—Specifies to check for potential conflicts; the conflicting buildings will be flagged.

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