Consuming a geoprocessing model tool in .NET

Click here to get the sample associated with this walkthrough.

In this topic

• Project description
• Creating the custom model tool
  • Running  the custom model tool in ArcMap
• Consuming the custom model tool
  • Creating a console application using the ArcGIS template IDE features
  • Adding code to the Visual Studio project
  • Testing the code

Project description

• Creating the custom model tool—A custom model tool is created in ModelBuilder. This custom tool performs a common geoprocessing function that demonstrates a moderate level of complexity. The model finds all golf courses within a radius of airports and creates a dataset.
• Consuming the custom model tool—Once the model tool is tested, create a Visual Studio project to run the model in a console application.

Creating the custom model tool

• airportgolf.mxd—Use this map document to test the model.
• Find Golf Courses.tbx—Custom toolbox containing the custom model tool and a script tool (Validate Input), which is embedded in the model.
• validateinput.py—Source Python script for the Validate Input script tool.
• golf.gdb—Geodatabase containing the input data.

Running the custom model tool in ArcMap

1. Double-click Golf Finder on the Catalog tree to open the tool. On the Golf Finder dialog box, specify the parameters as follows:
   1. Airports parameter—Select the Airports layer from the drop-down list.
   2. Buffer distance—Type 8 in the Linear Unit text box and select Miles from the Linear Unit drop-down list.
   3. Golf courses—Select the Golf layer from the drop-down list.
   4. Golf courses near airports—Type C:\AirportsAndGolf\data\golf.gdb\nearbygolfcourses.
      
   See the following screen shot:
   
   
2. Click OK to run the tool. When the tool executes successfully, a new layer (nearbygolfcourses) is added to the table of contents (TOC) in ArcMap.

Consuming the custom model tool

Creating a console application using the ArcGIS template IDE features

1. Start Visual Studio.
2. Click File and click New Project. The New Project dialog box appears.
3. On the New Project dialog box, click to expand the ArcGIS node in the Project types pane.
4. Click the Extending ArcObjects node.
5. Click Console Application (Desktop) or Console Application (Engine) under the Templates pane.

6. On the New Project dialog box, type GeoprocessingInDotNet in the Name text field. See the following screen shot:
   
   
7. Click OK. The ArcGIS Project Wizard appears.
8. On the ArcGIS Project Wizard, add the following ArcGIS assemblies:
   
   ESRI.ArcGIS.Geoprocessing
   ESRI.ArcGIS.System
   ESRI.ArcGIS.Version
   
   See the following screen shot :
   
   
   
9. Depending on the template you chose, you might see different groupings for the ArcGIS assemblies when the Add Reference sections show on the ArcGIS Project Wizard. Use the Filter by icon (on the preceding screen shot) to change to Products to view all of the ArcGIS assemblies.
10. Click Next.
11. Select the check box for the product for which you have a license.
12. Click Finish to complete the wizard.

Adding code to the Visual Studio project

using System;
using ESRI.ArcGIS.esriSystem;
using ESRI.ArcGIS.Geoprocessing;


namespace GeoprocessingInDotNet
{
    class Program
    {
        private static LicenseInitializer m_AOLicenseInitializer=new
            GeoprocessingInDotNet.LicenseInitializer();
        [STAThread()] static void Main(string[] args)
        {
            //ESRI License Initializer generated code.
            m_AOLicenseInitializer.InitializeApplication(new esriLicenseProductCode[]
            {
                esriLicenseProductCode.esriLicenseProductCodeAdvanced
            }
            , new esriLicenseExtensionCode[]{}
            );

            // .... your code here.

            //ESRI License Initializer generated code.
            //Do not make any call to ArcObjects after ShutDownApplication().
            m_AOLicenseInitializer.ShutdownApplication();
        }
    }
}

Imports ESRI.ArcGIS.esriSystem
Imports ESRI.ArcGIS.Geoprocessing;


Module Module1

Private m_AOLicenseInitializer As LicenseInitializer=New WalkthroughVBNet.LicenseInitializer()
<STAThread()> _
           Sub Main()
    'ESRI License Initializer generated code.
    m_AOLicenseInitializer.InitializeApplication(New esriLicenseProductCode() {esriLicenseProductCode.esriLicenseProductCodeAdvanced}, _
                                                 New esriLicenseExtensionCode() {})
    
    ' ... your code here.
    
    'ESRI License Initializer generated code.
    'Do not make any call to ArcObjects after ShutDownApplication().
    m_AOLicenseInitializer.ShutdownApplication()
End Sub

End Module

// Load the product code and version to the version manager.
//
ESRI.ArcGIS.RuntimeManager.Bind(ESRI.ArcGIS.ProductCode.Desktop);

' Load the product code and version to the version manager.
'
ESRI.ArcGIS.RuntimeManager.Bind(ESRI.ArcGIS.ProductCode.Desktop)

using System;
using ESRI.ArcGIS.esriSystem;
using ESRI.ArcGIS.Geoprocessing;

namespace GeoprocessingInDotNet2008
{
    class Program
    {
        private static LicenseInitializer m_AOLicenseInitializer=new
            GeoprocessingInDotNet2008.LicenseInitializer();
        [STAThread()] static void Main(string[] args)
        {

            // Load the product code and version to the version manager.
            ESRI.ArcGIS.RuntimeManager.Bind(ESRI.ArcGIS.ProductCode.Desktop);

            //ESRI License Initializer generated code.
            m_AOLicenseInitializer.InitializeApplication(new esriLicenseProductCode[]
            {
                esriLicenseProductCode.esriLicenseProductCodeAdvanced
            }
            , new esriLicenseExtensionCode[]{}
            );

            // Create geoprocessor. Overwrite true will replace existing output.
            IGeoProcessor2 gp=new GeoProcessorClass();
            gp.OverwriteOutput=true;

            // Get the workspace from the user.
            Console.WriteLine(
                "Enter the path to folder where you copied the data folder.");
            Console.WriteLine("Example: C:\\AirportsAndGolf\\data");
            Console.Write(">");
            string wks=Console.ReadLine();

            // Set the workspace to the value the user entered.
            gp.SetEnvironmentValue("workspace", wks + "\\" + "golf.gdb");

            // Add the custom toolbox to the geoprocessor.
            gp.AddToolbox(wks + "\\" + "Find Golf Courses.tbx");

            // Create a variant. Data is in the workspace.
            IVariantArray parameters=new VarArrayClass();
            parameters.Add("Airports");
            parameters.Add("8 Miles");
            parameters.Add("Golf");
            parameters.Add("GolfNearAirports");

            object sev=null;

            try
            {
                gp.Execute("GolfFinder", parameters, null);
                Console.WriteLine(gp.GetMessages(ref sev));
            }
            catch (Exception ex)
            {
                Console.WriteLine(ex.Message);
                string errorMsgs=gp.GetMessages(ref sev);
                Console.WriteLine(errorMsgs);
            }
            finally
            {
                Console.WriteLine("Hit Enter to quit");
                Console.ReadLine(); // Pause the console to view messages.
            }

            //ESRI License Initializer generated code.
            //Do not make any call to ArcObjects after ShutDownApplication().
            m_AOLicenseInitializer.ShutdownApplication();

        }
    }
}

Imports ESRI.ArcGIS.esriSystem
Imports ESRI.ArcGIS.Geoprocessing
Module Module1
Private m_AOLicenseInitializer As LicenseInitializer=New GeoprocessingInDotNet2008.LicenseInitializer()
<STAThread()> _
           Sub Main()
    
    ' Load the product code and version to the version manager.
    ESRI.ArcGIS.RuntimeManager.Bind(ESRI.ArcGIS.ProductCode.Desktop)
    
    'ESRI License Initializer generated code.
    m_AOLicenseInitializer.InitializeApplication(New esriLicenseProductCode() {esriLicenseProductCode.esriLicenseProductCodeAdvanced}, _
                                                 New esriLicenseExtensionCode() {})
    
    ' Create geoprocessor. Overwrite true will replace existing output.
    Dim gp As IGeoProcessor2=New GeoProcessor()
    gp.OverwriteOutput=True
    
    ' Get the workspace from the user.
    Console.WriteLine("Enter the path to folder where you copied the data folder.")
    Console.WriteLine("Example: C:\\AirportsAndGolf\\data")
    Console.Write(">")
    Dim wks As String=Console.ReadLine()
    
    ' Set the workspace to the value the user entered.
    gp.SetEnvironmentValue("workspace", wks + "\golf.gdb")
    
    ' Add the custom toolbox to the geoprocessor.
    gp.AddToolbox(wks + "\Find Golf Courses.tbx")
    
    ' Create a variant. Data is in the workspace.
    Dim parameters As IVariantArray=New VarArray()
    parameters.Add("Airports")
    parameters.Add("8 Miles")
    parameters.Add("Golf")
    parameters.Add("GolfNearAirports")
    
    Dim sev As Object=Nothing
    
    Try
    gp.Execute("GolfFinder", parameters, Nothing)
    Console.WriteLine(gp.GetMessages(sev))
    Catch ex As Exception
    Console.WriteLine(ex.Message)
    Dim errorMsgs As String=gp.GetMessages(sev)
    Console.WriteLine(errorMsgs)
    Finally
    Console.WriteLine("Hit Enter to quit")
    Console.ReadLine() ' Pause the console to view messages.
    End Try
    
    'ESRI License Initializer generated code.
    'Do not make any call to ArcObjects after ShutDownApplication().
    m_AOLicenseInitializer.ShutdownApplication()
    
End Sub

End Module

Testing the code

1. Start Visual Studio.
2. Click the Start Debugging  button and test the application. The application processes and returns the output. See the following screen shot:
   
   

See Also:

• ESRI.ArcGIS.Geoprocessing