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

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

public class DLGArc
extends AbstractGPTool

This tool only works with an ArcInfo license and will only be available in ArcToolbox if you have installed ArcInfo Workstation. Converts a Standard or Optional formatted The Import From DLG tool is contained in the Coverage Tools tool box.
Learn more about how Import From DLG works

Software restrictions: ArcInfo only

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
DLGArc()
          Creates the Import From DLG tool with defaults.
DLGArc(Object inDlgFile, Object outCover)
          Creates the Import From DLG tool with the required parameters.
 
Method Summary
 String getAreaCalculation()
          Returns the Area Calculation Method parameter of this tool .
 String getCategory()
          Returns the DLG Category Name parameter of this tool .
 Object getInDlgFile()
          Returns the Input DLG File parameter of this tool .
 Object getOutCover()
          Returns the Output Coverage parameter of this tool .
 Object getOutPointCover()
          Returns the Output Point Coverage parameter of this tool .
 Object getOutWorkspace()
          Returns the Output Workspace parameter of this tool (Read only).
 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.
 double getXShift()
          Returns the X Shift parameter of this tool .
 double getYShift()
          Returns the Y Shift parameter of this tool .
 void setAreaCalculation(String areaCalculation)
          Sets the Area Calculation Method parameter of this tool .
 void setCategory(String category)
          Sets the DLG Category Name parameter of this tool .
 void setInDlgFile(Object inDlgFile)
          Sets the Input DLG File parameter of this tool .
 void setOutCover(Object outCover)
          Sets the Output Coverage parameter of this tool .
 void setOutPointCover(Object outPointCover)
          Sets the Output Point Coverage parameter of this tool .
 void setXShift(double xShift)
          Sets the X Shift parameter of this tool .
 void setYShift(double yShift)
          Sets the Y Shift 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

DLGArc

public DLGArc()
Creates the Import From DLG tool with defaults.

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


DLGArc

public DLGArc(Object inDlgFile,
              Object outCover)
Creates the Import From DLG 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:
inDlgFile - File, the DLG file to be converted to a coverage.
outCover - Coverage, similarly, an INFO table named Output Coverage.PCODE will store the major/minor codes for area (A) records.
Method Detail

getInDlgFile

public Object getInDlgFile()
Returns the Input DLG File parameter of this tool . This parameter is File, the DLG file to be converted to a coverage. This is a required parameter.

Returns:
the Input DLG File

setInDlgFile

public void setInDlgFile(Object inDlgFile)
Sets the Input DLG File parameter of this tool . This parameter is File, the DLG file to be converted to a coverage. This is a required parameter.

Parameters:
inDlgFile - File, the DLG file to be converted to a coverage.

getOutCover

public Object getOutCover()
Returns the Output Coverage parameter of this tool . This parameter is Coverage, similarly, an INFO table named Output Coverage.PCODE will store the major/minor codes for area (A) records. 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 Coverage, similarly, an INFO table named Output Coverage.PCODE will store the major/minor codes for area (A) records. This is a required parameter.

Parameters:
outCover - Coverage, similarly, an INFO table named Output Coverage.PCODE will store the major/minor codes for area (A) records.

getOutPointCover

public Object getOutPointCover()
Returns the Output Point Coverage parameter of this tool . This parameter is Coverage, no coverage will be created from degenerate line records unless an Output Point Coverage is specified. This is an optional parameter.

Returns:
the Output Point Coverage

setOutPointCover

public void setOutPointCover(Object outPointCover)
Sets the Output Point Coverage parameter of this tool . This parameter is Coverage, no coverage will be created from degenerate line records unless an Output Point Coverage is specified. This is an optional parameter.

Parameters:
outPointCover - Coverage, no coverage will be created from degenerate line records unless an Output Point Coverage is specified.

getAreaCalculation

public String getAreaCalculation()
Returns the Area Calculation Method parameter of this tool . This parameter is String, determines how the area (A) records are written to the output coverage. This is an optional parameter.

Returns:
the Area Calculation Method

setAreaCalculation

public void setAreaCalculation(String areaCalculation)
Sets the Area Calculation Method parameter of this tool . This parameter is String, determines how the area (A) records are written to the output coverage. This is an optional parameter.

Parameters:
areaCalculation - String, determines how the area (A) records are written to the output coverage.

getXShift

public double getXShift()
Returns the X Shift parameter of this tool . This parameter is Double, a constant value to be added to all x coordinates during DLG conversion. The default X Shift value is zero. This is an optional parameter.

Returns:
the X Shift

setXShift

public void setXShift(double xShift)
Sets the X Shift parameter of this tool . This parameter is Double, a constant value to be added to all x coordinates during DLG conversion. The default X Shift value is zero. This is an optional parameter.

Parameters:
xShift - Double, a constant value to be added to all x coordinates during DLG conversion. The default X Shift value is zero.

getYShift

public double getYShift()
Returns the Y Shift parameter of this tool . This parameter is Double, a constant value to be added to all y coordinates during DLG conversion. The default Y Shift value is zero. This is an optional parameter.

Returns:
the Y Shift

setYShift

public void setYShift(double yShift)
Sets the Y Shift parameter of this tool . This parameter is Double, a constant value to be added to all y coordinates during DLG conversion. The default Y Shift value is zero. This is an optional parameter.

Parameters:
yShift - Double, a constant value to be added to all y coordinates during DLG conversion. The default Y Shift value is zero.

getCategory

public String getCategory()
Returns the DLG Category Name parameter of this tool . This parameter is String, the optional name of a specific DLG category to be converted from the DLG file. Only the specified category will be converted if one is given. Otherwise, only the first category in the DLG will be written to the output coverages: output coverage, point coverage. This is an optional parameter.

Returns:
the DLG Category Name

setCategory

public void setCategory(String category)
Sets the DLG Category Name parameter of this tool . This parameter is String, the optional name of a specific DLG category to be converted from the DLG file. Only the specified category will be converted if one is given. Otherwise, only the first category in the DLG will be written to the output coverages: output coverage, point coverage. This is an optional parameter.

Parameters:
category - String, the optional name of a specific DLG category to be converted from the DLG file. Only the specified category will be converted if one is given. Otherwise, only the first category in the DLG will be written to the output coverages: output coverage, point coverage.

getOutWorkspace

public Object getOutWorkspace()
Returns the Output Workspace parameter of this tool (Read only). This is an derived parameter.

Returns:
the Output Workspace

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