com.esri.arcgis.geoprocessing.tools.schematicstools
Class ConvertDiagram

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

public class ConvertDiagram
extends AbstractGPTool

The Convert Diagram To Features tool is contained in the Schematics Tools tool box.


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
ConvertDiagram()
          Creates the Convert Diagram To Features tool with defaults.
ConvertDiagram(Object inDiagram, Object outLocation)
          Creates the Convert Diagram To Features tool with the required parameters.
 
Method Summary
 String getConfigKeyword()
          Returns the Configuration Keyword parameter of this tool .
 String getContainerGeometry()
          Returns the Container Geometry parameter of this tool .
 String getExportRelatedAttributes()
          Returns the Export All Related Features Attributes parameter of this tool .
 Object getInDiagram()
          Returns the Input Schematic Diagram parameter of this tool .
 Object getOutDataset()
          Returns the Output Dataset parameter of this tool (Read only).
 Object getOutLocation()
          Returns the Output Location parameter of this tool .
 String getReuseFc()
          Returns the Reuse Existing Structure 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 setConfigKeyword(String configKeyword)
          Sets the Configuration Keyword parameter of this tool .
 void setContainerGeometry(String containerGeometry)
          Sets the Container Geometry parameter of this tool .
 void setExportRelatedAttributes(String exportRelatedAttributes)
          Sets the Export All Related Features Attributes parameter of this tool .
 void setInDiagram(Object inDiagram)
          Sets the Input Schematic Diagram parameter of this tool .
 void setOutLocation(Object outLocation)
          Sets the Output Location parameter of this tool .
 void setReuseFc(String reuseFc)
          Sets the Reuse Existing Structure 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

ConvertDiagram

public ConvertDiagram()
Creates the Convert Diagram To Features tool with defaults.

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


ConvertDiagram

public ConvertDiagram(Object inDiagram,
                      Object outLocation)
Creates the Convert Diagram To Features 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:
inDiagram - null
outLocation - null
Method Detail

getInDiagram

public Object getInDiagram()
Returns the Input Schematic Diagram parameter of this tool . This is a required parameter.

Returns:
the Input Schematic Diagram

setInDiagram

public void setInDiagram(Object inDiagram)
Sets the Input Schematic Diagram parameter of this tool . This is a required parameter.

Parameters:
inDiagram - null

getOutLocation

public Object getOutLocation()
Returns the Output Location parameter of this tool . This is a required parameter.

Returns:
the Output Location

setOutLocation

public void setOutLocation(Object outLocation)
Sets the Output Location parameter of this tool . This is a required parameter.

Parameters:
outLocation - null

getReuseFc

public String getReuseFc()
Returns the Reuse Existing Structure parameter of this tool . This is an optional parameter.

Returns:
the Reuse Existing Structure

setReuseFc

public void setReuseFc(String reuseFc)
Sets the Reuse Existing Structure parameter of this tool . This is an optional parameter.

Parameters:
reuseFc - null

getExportRelatedAttributes

public String getExportRelatedAttributes()
Returns the Export All Related Features Attributes parameter of this tool . This is an optional parameter.

Returns:
the Export All Related Features Attributes

setExportRelatedAttributes

public void setExportRelatedAttributes(String exportRelatedAttributes)
Sets the Export All Related Features Attributes parameter of this tool . This is an optional parameter.

Parameters:
exportRelatedAttributes - null

getContainerGeometry

public String getContainerGeometry()
Returns the Container Geometry parameter of this tool . This is an optional parameter.

Returns:
the Container Geometry

setContainerGeometry

public void setContainerGeometry(String containerGeometry)
Sets the Container Geometry parameter of this tool . This is an optional parameter.

Parameters:
containerGeometry - null

getConfigKeyword

public String getConfigKeyword()
Returns the Configuration Keyword parameter of this tool . This is an optional parameter.

Returns:
the Configuration Keyword

setConfigKeyword

public void setConfigKeyword(String configKeyword)
Sets the Configuration Keyword parameter of this tool . This is an optional parameter.

Parameters:
configKeyword - null

getOutDataset

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

Returns:
the Output Dataset

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