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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.coveragetools.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 Coverage Tools tool box.

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
SimplifyBuilding()
          Creates the Simplify Building tool with defaults.
SimplifyBuilding(Object inCover, Object outCover, double simplificationTolerance)
          Creates the Simplify Building tool with the required parameters.
 
Method Summary
 String getCheckConflict()
          Returns the Check for spatial conflicts parameter of this tool .
 Object getInCover()
          Returns the Input Coverage parameter of this tool .
 double getMinimumArea()
          Returns the Minimum Area parameter of this tool .
 Object getOutCover()
          Returns the Output Coverage parameter of this tool .
 Object getSelectionFile()
          Returns the Input Selection File parameter of this tool .
 double 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 setCheckConflict(String checkConflict)
          Sets the Check for spatial conflicts parameter of this tool .
 void setInCover(Object inCover)
          Sets the Input Coverage parameter of this tool .
 void setMinimumArea(double minimumArea)
          Sets the Minimum Area parameter of this tool .
 void setOutCover(Object outCover)
          Sets the Output Coverage parameter of this tool .
 void setSelectionFile(Object selectionFile)
          Sets the Input Selection File parameter of this tool .
 void setSimplificationTolerance(double 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 inCover,
                        Object outCover,
                        double 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:
inCover - the input coverage containing building polygons.
outCover - the output coverage containing simplified buildings as preliminary regions with a subclass BLDGSIM. The output coverage name must be different from the input coverage name.
simplificationTolerance - sets the simplification tolerance in coverage units. A tolerance must be specified and must be greater than zero.
Method Detail

getInCover

public Object getInCover()
Returns the Input Coverage parameter of this tool . This parameter is the input coverage containing building polygons. This is a required parameter.

Returns:
the Input Coverage

setInCover

public void setInCover(Object inCover)
Sets the Input Coverage parameter of this tool . This parameter is the input coverage containing building polygons. This is a required parameter.

Parameters:
inCover - the input coverage containing building polygons.

getOutCover

public Object getOutCover()
Returns the Output Coverage parameter of this tool . This parameter is the output coverage containing simplified buildings as preliminary regions with a subclass BLDGSIM. The output coverage name must be different from the input coverage name. This is a required parameter.

Returns:
the Output Coverage

setOutCover

public void setOutCover(Object outCover)
Sets the Output Coverage parameter of this tool . This parameter is the output coverage containing simplified buildings as preliminary regions with a subclass BLDGSIM. The output coverage name must be different from the input coverage name. This is a required parameter.

Parameters:
outCover - the output coverage containing simplified buildings as preliminary regions with a subclass BLDGSIM. The output coverage name must be different from the input coverage name.

getSimplificationTolerance

public double getSimplificationTolerance()
Returns the Simplification Tolerance parameter of this tool . This parameter is sets the simplification tolerance in coverage units. A tolerance must be specified and must be greater than zero. This is a required parameter.

Returns:
the Simplification Tolerance

setSimplificationTolerance

public void setSimplificationTolerance(double simplificationTolerance)
Sets the Simplification Tolerance parameter of this tool . This parameter is sets the simplification tolerance in coverage units. A tolerance must be specified and must be greater than zero. This is a required parameter.

Parameters:
simplificationTolerance - sets the simplification tolerance in coverage units. A tolerance must be specified and must be greater than zero.

getMinimumArea

public double getMinimumArea()
Returns the Minimum Area parameter of this tool . This parameter is sets the minimum area to be retained in coverage units. The default is the square of the simplification tolerance. Enter 0 to include all buildings. This is an optional parameter.

Returns:
the Minimum Area

setMinimumArea

public void setMinimumArea(double minimumArea)
Sets the Minimum Area parameter of this tool . This parameter is sets the minimum area to be retained in coverage units. The default is the square of the simplification tolerance. Enter 0 to include all buildings. This is an optional parameter.

Parameters:
minimumArea - sets the minimum area to be retained in coverage units. The default is the square of the simplification tolerance. Enter 0 to include all buildings.

getSelectionFile

public Object getSelectionFile()
Returns the Input Selection File parameter of this tool . This parameter is a special file created using the ArcPlot command WRITESELECT (see ArcInfo Workstation Help for command reference). It identifies coverage features selected in ArcPlot. This option allows you to simplify selected buildings in the input coverage. This is an optional parameter.

Returns:
the Input Selection File

setSelectionFile

public void setSelectionFile(Object selectionFile)
Sets the Input Selection File parameter of this tool . This parameter is a special file created using the ArcPlot command WRITESELECT (see ArcInfo Workstation Help for command reference). It identifies coverage features selected in ArcPlot. This option allows you to simplify selected buildings in the input coverage. This is an optional parameter.

Parameters:
selectionFile - a special file created using the ArcPlot command WRITESELECT (see ArcInfo Workstation Help for command reference). It identifies coverage features selected in ArcPlot. This option allows you to simplify selected buildings in the input coverage.

getCheckConflict

public String getCheckConflict()
Returns the Check for spatial conflicts parameter of this tool . This parameter is 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

setCheckConflict

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

Parameters:
checkConflict - specifies whether or not to check for potential conflicts, that is, overlapping or touching, among buildings.

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