com.esri.arcgis.geoprocessing
Interface IGeoProcessorSettings

All Superinterfaces:
Serializable
All Known Subinterfaces:
IGeoProcessorSettings2
All Known Implementing Classes:
GPEnvironmentManager, IGeoProcessorSettings2Proxy, IGeoProcessorSettingsProxy

public interface IGeoProcessorSettings
extends Serializable

Provides access to the properties/methods of the GeoProcessor settings.

Superseded By

IGeoProcessorSettings2

Remarks

The IGeoProcessorSettings interface provides access to the properties of the various GeoProcessor settings. Example settings are LogHistory and OverwriteOutput. Note: the latter is being accessed from the Environment Manager.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows


Method Summary
 boolean isAddOutputsToMap()
          Indicates whether resulting output datasets should be added to the application display.
 boolean isLogHistory()
          Indicates whether or not to log the execution of geoprocessing tools.
 boolean isOverwriteOutput()
          Indicates whether output datasets should be overwritten when executing geoprocessing tools.
 boolean isShowModelBuilderPrompts()
          Indicates whether to prompt the user when connecting elements in ModelBuilder if there is more than one possible connection.
 boolean isTemporaryMapLayers()
          Indicates whether new map layers are temporary by default.
 void setAddOutputsToMap(boolean addToMap)
          Indicates whether resulting output datasets should be added to the application display.
 void setLogHistory(boolean logHistory)
          Indicates whether or not to log the execution of geoprocessing tools.
 void setOverwriteOutput(boolean overwriteOutput)
          Indicates whether output datasets should be overwritten when executing geoprocessing tools.
 void setShowModelBuilderPrompts(boolean showPrompts)
          Indicates whether to prompt the user when connecting elements in ModelBuilder if there is more than one possible connection.
 void setTemporaryMapLayers(boolean temporaryMapLayers)
          Indicates whether new map layers are temporary by default.
 

Method Detail

setAddOutputsToMap

void setAddOutputsToMap(boolean addToMap)
                        throws IOException,
                               AutomationException
Indicates whether resulting output datasets should be added to the application display.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows

Parameters:
addToMap - The addToMap (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAddOutputsToMap

boolean isAddOutputsToMap()
                          throws IOException,
                                 AutomationException
Indicates whether resulting output datasets should be added to the application display.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows

Returns:
The addToMap
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOverwriteOutput

void setOverwriteOutput(boolean overwriteOutput)
                        throws IOException,
                               AutomationException
Indicates whether output datasets should be overwritten when executing geoprocessing tools.

Remarks

When creating a custom tool that writes output data, it is necessary to check the GeoProcessor setting OberwriteOutput. A code sample is included below on how to do this.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows

Parameters:
overwriteOutput - The overwriteOutput (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isOverwriteOutput

boolean isOverwriteOutput()
                          throws IOException,
                                 AutomationException
Indicates whether output datasets should be overwritten when executing geoprocessing tools.

Remarks

The OutputOverwrite property determines if output created by a function execution will be overwritten by subsequent function executions. A code sample to check the OutputOverwrite setting is included below.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows

Returns:
The overwriteOutput
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTemporaryMapLayers

void setTemporaryMapLayers(boolean temporaryMapLayers)
                           throws IOException,
                                  AutomationException
Indicates whether new map layers are temporary by default.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows

Parameters:
temporaryMapLayers - The temporaryMapLayers (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isTemporaryMapLayers

boolean isTemporaryMapLayers()
                             throws IOException,
                                    AutomationException
Indicates whether new map layers are temporary by default.

Remarks

The TemporaryMapLayer property indicates if a new map layer is by default temporary data or not.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows

Returns:
The temporaryMapLayers
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShowModelBuilderPrompts

void setShowModelBuilderPrompts(boolean showPrompts)
                                throws IOException,
                                       AutomationException
Indicates whether to prompt the user when connecting elements in ModelBuilder if there is more than one possible connection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows

Parameters:
showPrompts - The showPrompts (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isShowModelBuilderPrompts

boolean isShowModelBuilderPrompts()
                                  throws IOException,
                                         AutomationException
Indicates whether to prompt the user when connecting elements in ModelBuilder if there is more than one possible connection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows

Returns:
The showPrompts
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLogHistory

void setLogHistory(boolean logHistory)
                   throws IOException,
                          AutomationException
Indicates whether or not to log the execution of geoprocessing tools.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows

Parameters:
logHistory - The logHistory (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isLogHistory

boolean isLogHistory()
                     throws IOException,
                            AutomationException
Indicates whether or not to log the execution of geoprocessing tools.

Remarks

Having a log of function executions can be useful. The LogHistory porperty checks if the setting is on or off.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows

Returns:
The logHistory
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.