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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.coveragetools.VPFTile
All Implemented Interfaces:
GPTool

public class VPFTile
extends AbstractGPTool

Creates cross-tile topology for all tiled coverages in a Vector Product Format (VPF) database library, or topology for an individual tile in a VPF library. The VPF Tile Topology 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
VPFTile()
          Creates the VPF Tile Topology tool with defaults.
VPFTile(Object vPFLibrary)
          Creates the VPF Tile Topology tool with the required parameters.
 
Method Summary
 Object getOutVPFLibrary()
          Returns the VPF Library parameter of this tool (Read only).
 int getSigDigits()
          Returns the Significant Digits parameter of this tool .
 String getSpecCover()
          Returns the Specified Coverage 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.
 Object getVPFLibrary()
          Returns the VPF Library parameter of this tool .
 int getVPFStandard()
          Returns the VPF Standard parameter of this tool .
 void setSigDigits(int sigDigits)
          Sets the Significant Digits parameter of this tool .
 void setSpecCover(String specCover)
          Sets the Specified Coverage parameter of this tool .
 void setVPFLibrary(Object vPFLibrary)
          Sets the VPF Library parameter of this tool .
 void setVPFStandard(int vPFStandard)
          Sets the VPF Standard 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

VPFTile

public VPFTile()
Creates the VPF Tile Topology tool with defaults.

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


VPFTile

public VPFTile(Object vPFLibrary)
Creates the VPF Tile Topology 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:
vPFLibrary - location of the VPF database library for which cross-tile topology is to be created.
Method Detail

getVPFLibrary

public Object getVPFLibrary()
Returns the VPF Library parameter of this tool . This parameter is location of the VPF database library for which cross-tile topology is to be created. This is a required parameter.

Returns:
the VPF Library

setVPFLibrary

public void setVPFLibrary(Object vPFLibrary)
Sets the VPF Library parameter of this tool . This parameter is location of the VPF database library for which cross-tile topology is to be created. This is a required parameter.

Parameters:
vPFLibrary - location of the VPF database library for which cross-tile topology is to be created.

getSigDigits

public int getSigDigits()
Returns the Significant Digits parameter of this tool . This parameter is the number of digits the software will use when trying to match node coordinates at tile boundaries. The larger the number, the smaller the search tolerance. The default value is 4. This is an optional parameter.

Returns:
the Significant Digits

setSigDigits

public void setSigDigits(int sigDigits)
Sets the Significant Digits parameter of this tool . This parameter is the number of digits the software will use when trying to match node coordinates at tile boundaries. The larger the number, the smaller the search tolerance. The default value is 4. This is an optional parameter.

Parameters:
sigDigits - the number of digits the software will use when trying to match node coordinates at tile boundaries. The larger the number, the smaller the search tolerance. The default value is 4.

getVPFStandard

public int getVPFStandard()
Returns the VPF Standard parameter of this tool . This parameter is the VPF Standard to be used. The VPF Standard has two ways of defining cross-tile topology. This is an optional parameter.

Returns:
the VPF Standard

setVPFStandard

public void setVPFStandard(int vPFStandard)
Sets the VPF Standard parameter of this tool . This parameter is the VPF Standard to be used. The VPF Standard has two ways of defining cross-tile topology. This is an optional parameter.

Parameters:
vPFStandard - the VPF Standard to be used. The VPF Standard has two ways of defining cross-tile topology.

getSpecCover

public String getSpecCover()
Returns the Specified Coverage parameter of this tool . This parameter is specifies whether to process all the coverages in the VPF library or only the specified coverage. This is an optional parameter.

Returns:
the Specified Coverage

setSpecCover

public void setSpecCover(String specCover)
Sets the Specified Coverage parameter of this tool . This parameter is specifies whether to process all the coverages in the VPF library or only the specified coverage. This is an optional parameter.

Parameters:
specCover - specifies whether to process all the coverages in the VPF library or only the specified coverage.

getOutVPFLibrary

public Object getOutVPFLibrary()
Returns the VPF Library parameter of this tool (Read only). This is an derived parameter.

Returns:
the VPF Library

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