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

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

public class Ungenerate
extends AbstractGPTool

Creates a text file of x,y coordinates from the input coverage. The Ungenerate 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
Ungenerate()
          Creates the Ungenerate tool with defaults.
Ungenerate(Object inCover, Object outGenerateFile, String featureType)
          Creates the Ungenerate tool with the required parameters.
 
Method Summary
 String getDuplicateNodes()
          Returns the Duplicate Nodes parameter of this tool .
 String getFeatureType()
          Returns the Feature Type parameter of this tool .
 String getFormat()
          Returns the Numeric Format parameter of this tool .
 Object getInCover()
          Returns the Input Coverage parameter of this tool .
 Object getOutGenerateFile()
          Returns the Output Generate File 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 setDuplicateNodes(String duplicateNodes)
          Sets the Duplicate Nodes parameter of this tool .
 void setFeatureType(String featureType)
          Sets the Feature Type parameter of this tool .
 void setFormat(String format)
          Sets the Numeric Format parameter of this tool .
 void setInCover(Object inCover)
          Sets the Input Coverage parameter of this tool .
 void setOutGenerateFile(Object outGenerateFile)
          Sets the Output Generate File 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

Ungenerate

public Ungenerate()
Creates the Ungenerate tool with defaults.

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


Ungenerate

public Ungenerate(Object inCover,
                  Object outGenerateFile,
                  String featureType)
Creates the Ungenerate 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 coverage from which feature coordinates will be written.
outGenerateFile - the text file to which the x,y coordinates will be written.
featureType - the type of features that will be used in the generation of the output file.
Method Detail

getInCover

public Object getInCover()
Returns the Input Coverage parameter of this tool . This parameter is the coverage from which feature coordinates will be written. 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 coverage from which feature coordinates will be written. This is a required parameter.

Parameters:
inCover - the coverage from which feature coordinates will be written.

getOutGenerateFile

public Object getOutGenerateFile()
Returns the Output Generate File parameter of this tool . This parameter is the text file to which the x,y coordinates will be written. This is a required parameter.

Returns:
the Output Generate File

setOutGenerateFile

public void setOutGenerateFile(Object outGenerateFile)
Sets the Output Generate File parameter of this tool . This parameter is the text file to which the x,y coordinates will be written. This is a required parameter.

Parameters:
outGenerateFile - the text file to which the x,y coordinates will be written.

getFeatureType

public String getFeatureType()
Returns the Feature Type parameter of this tool . This parameter is the type of features that will be used in the generation of the output file. This is a required parameter.

Returns:
the Feature Type

setFeatureType

public void setFeatureType(String featureType)
Sets the Feature Type parameter of this tool . This parameter is the type of features that will be used in the generation of the output file. This is a required parameter.

Parameters:
featureType - the type of features that will be used in the generation of the output file.

getDuplicateNodes

public String getDuplicateNodes()
Returns the Duplicate Nodes parameter of this tool . This parameter is determines whether duplicate node coordinates will be retained or dropped in the Output Generate File. This applies only to the POLY option. This is an optional parameter.

Returns:
the Duplicate Nodes

setDuplicateNodes

public void setDuplicateNodes(String duplicateNodes)
Sets the Duplicate Nodes parameter of this tool . This parameter is determines whether duplicate node coordinates will be retained or dropped in the Output Generate File. This applies only to the POLY option. This is an optional parameter.

Parameters:
duplicateNodes - determines whether duplicate node coordinates will be retained or dropped in the Output Generate File. This applies only to the POLY option.

getFormat

public String getFormat()
Returns the Numeric Format parameter of this tool . This parameter is selects either exponential or fixed representation of floating point numbers in the Output Generate File. This is an optional parameter.

Returns:
the Numeric Format

setFormat

public void setFormat(String format)
Sets the Numeric Format parameter of this tool . This parameter is selects either exponential or fixed representation of floating point numbers in the Output Generate File. This is an optional parameter.

Parameters:
format - selects either exponential or fixed representation of floating point numbers in the Output Generate File.

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