怎样运行地理处理工具 Geoprocessing & Geoprocessor & IGPProcess

In this topic

How to run a geoprocessing tool（这个地方在仔细整理下！！）

Each geoprocessing tool has a fixed set of parameters that provide the tool with the information it needs for execution. Tools usually have input parameters that define the dataset or datasets that will typically be used to generate new output data. Parameters have the following important properties:

• Name—Each tool parameter has a unique name.
• Type—The type of data expected, such as a feature class, integer, string, and raster.
• Required—Either a value must be provided for a parameter, or it is optional.

Each tool has a documentation page known as a tool reference page.For more information about parameters, see Interpreting a tool reference page.（Interpreting：解释。在这个页面介绍了怎么快速定位“工具”，找到工具名称和工具参数信息，一定要了解这个专题上的信息，你才能很好地使用ArcGIS的工具。其实，你在使用ArcMap的系统工具的时候，在工具的帮助文档里，就能找到那个工具的名称，别名，参数，还有部分的Python代码。）

When a tool is used in a program, its parameter values must be set correctly so it can execute when the program runs. The documentation of each tool clearly defines its parameters and properties. Once a valid set of parameter values is provided, the tool is ready to be executed.

Parameters are specified as strings or objects. Strings are text values that uniquely identify a parameter value, such as a path to a dataset or a keyword. Most tool parameters can be specified as a simple string. However, complex parameters, such as a spatial reference, can be easier to specify with an object. Each tool has its own parameter types.To get complete information on a particular tool, review the tool reference page. Interpreting a tool reference page explains how to read a tool reference page and extract information to use in .NET.

两种方法的区别：Geoprocessing & geoprocessor 

You can run a geoprocessing tool by using the Geoprocessing library methods or by the geoprocessor managed assembly methods. For information about the basic differences between the two approaches, seeExecuting tools. In both cases, the Execute method of the geoprocessor is called.

取消即终止功能通常设为null

The Execute method uses a null reference instead of an ITrackCancel interface. The ITrackCancel interface provides access to properties and methods that determine if a cancellation has been executed by the user and also allows developers to specify what actions constitute a cancellation. Both approaches are elaborated（详细阐述如下） with the following examples.

Using the geoprocessing assembly（是一个COM Interop程序集）

The geoprocessing assembly is the Component Object Model (COM) interop of the Geoprocessing type library（ 什么是COM Interop？COM Interop看上去象是介乎于COM和.Net之间的一条纽带，一座桥梁。 ）. The Execute method of the IGeoProcessor2 interface of the library is used to run a tool.

The following are the generic steps to execute a tool:

1. Add a reference toESRI.ArcGIS.Geoprocessingto your project. This is the only reference you need if you use the geoprocessing assembly.
2. Create thegeoprocessor object（通过IGeoProcessor2接口 ，注意:P大写,且是第2接口）.
3. Add the path to the custom toolbox if you are running a custom tool.
4. Create an IVariantArray and populate（板上组装、填入） it with tool parameter values. The IVariantArray is available through the esriSystem library（参数值通过IVariantArray 设置）.
5. Call the Execute methodon the geoprocessor.

The process is the same if you run a system tool or a custom tool.

确保填入参数有正确的设置顺序：Make sure you maintain the order of parameters as specified in the tool reference page when populating the variant array. Follow the syntax section of the tool reference page (see link at the bottom), it shows the correct ordering of parameters.

如果你想跳过可选参数，你只需要将它们填入一个空字符串，如""：If you want to skip an optional parameter, just add an empty string to the variant array in correct order. For example, if a tool's third, fourth and fifth parameters are optional and you want to pass value only to the fifth parameter, then you have to pass empty strings to the third and fourth parameters to maintain correct ordering.

如果你填入空字符串，处理工具将使用默认值：Passing an empty string instructs the tool to use the default value of that parameter.

正确的参数设置顺序需要参考 tool's Help Page,而不是tool's dialog box,这点很重要：Do not follow the tool's dialog box to get the order of parameters; follow the tool's Help page (browse to Interpreting a tool reference page link at the end). Parameters are arranged on a tool dialog box by "display order" not by the actual order.

Executing a system tool

The following code example shows the execution of the Buffer tool from the Analysis toolbox. The required parameters for the tool are defined. In this case, strings are used to define the input, output, and buffer distance properties, so the call to the tool is easier to read.

[C#]

using System;
using System.Threading;
// Add references to esriSystem for licensing and IVariantArray.
using ESRI.ArcGIS.esriSystem;
// Add a reference to the geoprocessing namespace.
using ESRI.ArcGIS.Geoprocessing;

// Call this method from your main.
private static void RunBuffer()
{
    // Create the geoprocessor.
    IGeoProcessor2 gp = new GeoProcessorClass();  //注意左边接口的写法，更要注意右边类的名称后缀带个Class！！

                                                  //这个地方和Geoprocessor不一样！！
    gp.OverwriteOutput = true;
    IGeoProcessorResult result = new GeoProcessorResultClass();
    // Create a variant array to hold the parameter values.
    IVariantArray parameters = new VarArrayClass();
    object sev = null;
    try
    {
        // Populate the variant array with parameter values.
        parameters.Add(@"C:\data\california.gdb\cities");
        parameters.Add(@"C:\data\california.gdb\cities_buff");
        parameters.Add("1000 Meters");
        // Execute the tool."Buffer_analysis" 这个字符串可以在ArcGIS帮助下面的功能项介绍中语法说明中找到，就是那个函数名称！！！！
        result = gp.Execute("Buffer_analysis", parameters, null);
        // Wait until the execution completes.
        while (result.Status == esriJobStatus.esriJobExecuting)
            Thread.Sleep(1000);
        // Wait for 1 second.
        // Print geoprocessring messages.
        Console.WriteLine(gp.GetMessages(ref sev));
    }
    catch (Exception ex)
    {
        // Print a generic exception message.
        Console.WriteLine(ex.Message);
        // Print geoprocessing execution error messages.
        Console.WriteLine(gp.GetMessages(ref sev));
    }
}

Executing a custom tool

In addition to using the existing tools and toolboxes provided by Esri, you can also execute custom tools, such as model tools and script tools, that exist in custom toolboxes. The process is the same for system or custom tools when you use IGeoProcessor2.Execute. As all system toolboxes are readily available to the geoprocessor, you do not need to add the toolbox to the geoprocessor. However, you must add the custom toolbox to the geoprocessor using the AddToolbox method.

The following code example shows how to execute the CalculateBestPath custom tool in the BestPath.tbx toolbox:

The only difference between running a system tool and a custom tool is adding the custom toolbox to the geoprocessor. For more information on system and custom tools, see Essential geoprocessing vocabulary in the ArcGIS Desktop Help system.

[C#]

public void SampleCalculateBestPathToolGping()
{
    // Initialize the geoprocessor.
    IGeoProcessor2 gp = new GeoProcessorClass();
    // Add the BestPath toolbox.
    gp.AddToolbox(@"C:\SanDiego\BestPath.tbx");
    // Generate the array of parameters.
    IVariantArray parameters = new VarArrayClass();
    parameters.Add(@"C:\SanDiego\source.shp");
    parameters.Add(@"C:\SanDiego\destination.shp");
    parameters.Add(@"C:\SanDiego\bestpath.shp");
    object sev = null;
    try
    {
        // Execute the model tool by name.
        gp.Execute("CalculateBestPath", parameters, null);
        Console.WriteLine(gp.GetMessages(ref sev));
    }
    catch (Exception ex)
    {
        // Print geoprocessing execution error messages.
        Console.WriteLine(gp.GetMessages(ref sev));
    }
}

Always surround your code with try-catch blocks, because the Execute method throws an exception if the tool fails to run.

Using the geoprocessor managed assembly（是一个托管程序集）

The following are the general steps to run a tool:

1. Add a reference toESRI.ArcGIS.Geoprocessor.（如果你需要使用工具的执行结果，你也可以引用ESRI.ArcGIS .Geoprocessing：You may also need to add the ESRI.ArcGIS.Geoprocessing assembly if you want to use, for example, the result object or list datasets.)
2. Additionally, add areference to the toolbox assembly to which the tool belongs. If you use more than one tool from different toolboxes, also add managed assemblies for those toolboxes.
3. Create thegeoprocessor object（注意是通过Geoprocessor类,就是我们平常所说的用某个类实例化一个对象。注意：p是小写）.
4. Add the path to the custom toolbox if you are running a custom tool.
5. Create a tool process object and set the parameter values（参数值直接对具体工具设置）.
6. Call the Execute method on the geoprocessor.

Executing a system tool with managed assembly（我发现我平常用的比较多的就是这种情况：Geoprocessor）

In the following code example, the Buffer tool is executed with the same parameter values by using the managed assemblies:

[C#]

// Add the geoprocessor namespace.
using ESRI.ArcGIS.Geoprocessor;
// Add the toolbox assembly.需要哪个就得引用这个工具所在的程序集
using ESRI.ArcGIS.AnalysisTools;

public void SampleBufferTool()
{
    // Create the geoprocessor. 
    Geoprocessor GP = new Geoprocessor();
    // Create the tool process object.
    ESRI.ArcGIS.AnalysisTools.Buffer bufferTool = new
        ESRI.ArcGIS.AnalysisTools.Buffer();
    // Set parameter values.
    bufferTool.in_features = @"D:\St_Johns\data.mdb\roads";
    bufferTool.out_feature_class = @"D:\St_Johns\data.mdb\roads_Buffer";
    bufferTool.buffer_distance_or_field = "distance";
    object sev = null;
    try
    {
        // Execute the tool.
        GP.Execute(bufferTool, null);
        Console.WriteLine(GP.GetMessages(ref sev));
    }
    catch (Exception ex)
    {
        // Print geoprocessing execution error messages.
        Console.WriteLine(GP.GetMessages(ref sev));
    }
}

Executing a custom tool with managed assembly

Custom toolboxes do not have any managed assembly. Therefore, the simplest way to run a custom tool is by using IVariantArray and executing the tool by name. The Execute method of the geoprocessor is overloaded and has an additional argument list that allows you to execute a tool by specifying the tool name, the parameters of the tool, and the ITrackCancel interface. First, add your custom toolbox to the geoprocessor using the AddToolbox method. See the following code example:

[C#]

public void SampleCalculateBestPathTool()
{
    // Initialize the geoprocessor.
    Geoprocessor GP = new Geoprocessor();
    // Add the BestPath toolbox.
    GP.AddToolbox(@"C:\SanDiego\BestPath.tbx");
    // Generate the array of parameters.
    IVariantArray parameters = new VarArrayClass();
    parameters.Add(@"C:\SanDiego\source.shp");
    parameters.Add(@"C:\SanDiego\destination.shp");
    parameters.Add(@"C:\SanDiego\bestpath.shp");
    object sev = null;
    try
    {
        // Execute the model tool by name.
        GP.Execute("CalculateBestPath", parameters, null);
        Console.WriteLine(GP.GetMessages(ref sev));
    }
    catch (Exception ex)
    {
        // Print geoprocessing execution error messages.
        Console.WriteLine(GP.GetMessages(ref sev));
    }
}

The process of executing a custom tool is same whether you use the geoprocessing assembly or the geoprocessor managed assembly. The only difference is in creating the geoprocessor.

You can generate a toolbox assembly for a custom toolboxusing the integrated development environment (IDE) framework in Visual Studio .NET. To do so, use the ArcGIS Toolbox Reference dialog box. For more information, see ArcGIS Toolbox Reference dialog box（推荐使用这种方法对你自定义的工具项进行程序集包装！！）. Once an assembly is created, you can use it in the same way as a system toolbox assembly. To run a tool in the background geoprocessing, use the ExecuteAsync method instead. For more information, see Running a geoprocessing tool using background geoprocessing.

IGPProcess Interface（只是一个接口而已，从单词Process来看IGPProcess是一个动词性的接口）

private static void RunTool(Geoprocessor geoprocessor,IGPProcess process, ITrackCancel TC)
 {         //Geoprocessor 是名词，是主语；IGPProcess是动词接口，是谓语！！！！
            // Set the overwrite output option to true
            geoprocessor.OverwriteOutput = true;
            // Execute the tool            
            try
            {
                geoprocessor.Execute(process, null);
                ReturnMessages(geoprocessor);
            }
            catch (Exception err)
            {
                Console.WriteLine(err.Message);
                ReturnMessages(geoprocessor);
            }
 }

地理处理的环境设置

在Arcmap下面的操作Toolbox里面的工具的时候，有时候会设置一些环境变量，在AE里面会怎么做呢？

（1）如果知道自己操作的相关接口，可以使用IRasterAnalysisEnvironment，如下代码：

       ILocalOp pLocalOp = new RasterLocalOpClass();

       IWorkspaceFactory pEnvWf = new RasterWorkspaceFactoryClass();

       IWorkspace pEnvRws = pEnvWf.OpenFromFile(strTempDir, 0);

       IRasterAnalysisEnvironment pRasAnaEnv = (IRasterAnalysisEnvironment)pLocalOp;
       pRasAnaEnv.OutWorkspace = pEnvRws;

（2）如果是通过GP操作，则

        public static bool RasterZonalStatistics(IFeatureClass pFc,string strZoneField,
            IRaster pRasterValue,  string outRaster,string strStatisticType = "MINIMUM",string ignoreNoData = "DATA")
        {
            try
            {
                Geoprocessor pGeoprocessor = new Geoprocessor();
                ISpatialReference spatialReference = null;
                IGeoDataset pGeoDataset = pFc as IGeoDataset;
                if (pGeoDataset != null) spatialReference = pGeoDataset.SpatialReference;
                ZonalStatistics pZonalStatistics = new ZonalStatistics
                {
                    in_zone_data = pFc,
                    zone_field = strZoneField,
                    in_value_raster = pRasterValue,
                    out_raster = outRaster,
                    statistics_type = strStatisticType,
                    ignore_nodata = ignoreNoData
                };

                pGeoprocessor.OverwriteOutput = true;
                //pGeoprocessor.SetEnvironmentValue("workspace", strTempDir);
                if (spatialReference != null)
                    pGeoprocessor.SetEnvironmentValue("outputCoordinateSystem", spatialReference.FactoryCode);
                object ob = pGeoprocessor.Execute(pZonalStatistics, null);
                return true;
            }
            catch (Exception ex)
            {
                return false;
            }
        }

现在的问题是：SetEnvironmentValue里面的参数怎么设置，我在AO的帮助里面找不到详细的帮助，但是在google里面搜索，找到arcgis的官网帮助连接如下：

http://resources.arcgis.com/en/help/arcobjects-net/conceptualhelp/#/Using_environment_settings/0001000001n5000000/，有Using environment settings栏目，最下方有参数名称，可以自由设置。