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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.coveragetools.ArcS57

All Implemented Interfaces:

GPTool

public class ArcS57
extends AbstractGPTool

Converts ArcC/Info coverages to S-57 object files. The Export To S57 tool is contained in the Coverage Tools tool box.

Usage tips:

• S-57 is a data standard developed by the International Hydrographic Organization (IHO) to be used for the exchange of digital hydrographic data.
• The Output Log File will be created in the process and then holds the report of the export.
• The Input Workspace in which the S-57 files are located must contain coverages or the directory cannot be selected.

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

ArcS57()
Creates the Export To S57 tool with defaults.

ArcS57(Object inWorkspace, Object logFile)
Creates the Export To S57 tool with the required parameters.

Method Summary

Object	getInWorkspace() Returns the Input Workspace parameter of this tool .
Object	getLogFile() Returns the Output Log File parameter of this tool .
Object	getOutWorkspace() Returns the Output Workspace 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	setInWorkspace(Object inWorkspace) Sets the Input Workspace parameter of this tool .
void	setLogFile(Object logFile) Sets the Output Log File parameter of this tool .
void	setOutWorkspace(Object outWorkspace) Sets the Output Workspace 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

ArcS57

public ArcS57()

Creates the Export To S57 tool with defaults.

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

ArcS57

public ArcS57(Object inWorkspace,
              Object logFile)

Creates the Export To S57 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:

inWorkspace - the workspace containing the coverage to be converted (exported).

logFile - contains the report of the export process.

Method Detail

getInWorkspace

public Object getInWorkspace()

Returns the Input Workspace parameter of this tool . This parameter is the workspace containing the coverage to be converted (exported). This is a required parameter.

Returns:

the Input Workspace

setInWorkspace

public void setInWorkspace(Object inWorkspace)

Sets the Input Workspace parameter of this tool . This parameter is the workspace containing the coverage to be converted (exported). This is a required parameter.

Parameters:

inWorkspace - the workspace containing the coverage to be converted (exported).

getLogFile

public Object getLogFile()

Returns the Output Log File parameter of this tool . This parameter is contains the report of the export process. This is a required parameter.

Returns:

the Output Log File

setLogFile

public void setLogFile(Object logFile)

Sets the Output Log File parameter of this tool . This parameter is contains the report of the export process. This is a required parameter.

Parameters:

logFile - contains the report of the export process.

getOutWorkspace

public Object getOutWorkspace()

Returns the Output Workspace parameter of this tool . This parameter is the folder that will contain the S-57 object files. This is an optional parameter.

Returns:

the Output Workspace

setOutWorkspace

public void setOutWorkspace(Object outWorkspace)

Sets the Output Workspace parameter of this tool . This parameter is the folder that will contain the S-57 object files. This is an optional parameter.

Parameters:

outWorkspace - the folder that will contain the S-57 object files.

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