com.esri.arcgis.geoprocessing
Interface IMdModel

All Superinterfaces:
Serializable
All Known Implementing Classes:
MdModel

public interface IMdModel
extends Serializable

Provides access to properties/methods of a model.

Product Availability

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

Supported Platforms

Windows


Method Summary
 void addElement(IMdElement element)
          Adds the given element to the model.
 void addElements(IArray elements)
          Adds the collection of elements to the model.
 boolean canAddElement(IMdElement pElement)
          Returns whether or not the given model element can be added to the model.
 String createUniqueElementName(String name)
          Generates a new unique name that may be used for adding a new model element to the model.
 void deleteElement(IMdElement element)
          Removes the given element from the model.
 void disconnectElements(IMdElement pFromElement, IMdElement pToElement, int connectionType)
          Removes the connection/dependency between two model elements.
 void empty()
          Removes all model elements from the model.
 void execute(ITrackCancel trackcancel, boolean reset, IGPEnvironmentManager pEnvMgr, IGPMessages messages, boolean stopOnFirstFailure)
          Executes all the processes in the model.
 void executeProcess(IMdProcess pMdProcess, ITrackCancel trackcancel, boolean reset, IGPEnvironmentManager pEnvMgr, IGPMessages messages, boolean stopOnFirstFailure)
          Executes a single process in the model.
 IEnumMdElement findDependents(IMdElement pMdElement, int direction, int connectionType)
          Returns all the model elements dependent on the given model element in the given direction of the given connection type.
 IMdElement getElement(String name)
          Returns the model element with the given name.
 IMdElement getElementByID(int identifier)
          Returns the model element with the given identifier.
 IEnumMdElement getElements()
          Returns all of the model elements in the model.
 IGPEnvironmentManager getEnvironmentManager()
          The set of overriding environment values used when validating/executing the model.
 String getName()
          Name of the model.
 IEnumMdProcess getProcesses()
          Returns all of the processes in the model.
 IEnumMdVariable getVariables()
          Returns all of the variables in the model.
 boolean isLicensed()
          Returns whether or not all the processes in the model are licensed.
 boolean isValid()
          Returns whether or not all the model elements in the model are valid.
 void mergeElements(IEnumMdElement pElements)
          Merges the given enumeration of model elements, commonly from another model, into the current model.
 void setEnvironmentManagerByRef(IGPEnvironmentManager ppEnvMgr)
          The set of overriding environment values used when validating/executing the model.
 void setName(String name)
          Name of the model.
 IEnumMdElement sortElements()
          Returns all the model elements in the model in sorted order.
 IEnumMdElement traceDependents(IMdElement pMdElement, int direction, int depth)
          Returns all the model elements dependent on the given model element in the given direction.
 IGPMessages validate(boolean reset, IGPEnvironmentManager pEnvMgr)
          Validates all model elements in the model.
 boolean verifyUniqueElementName(String name)
          Returns whether or not the model already contains a model element by the given name.
 

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException
Name of the model.

Product Availability

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

Supported Platforms

Windows

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

setName

void setName(String name)
             throws IOException,
                    AutomationException
Name of the model.

Product Availability

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

Supported Platforms

Windows

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

addElement

void addElement(IMdElement element)
                throws IOException,
                       AutomationException
Adds the given element to the model.

Product Availability

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

Supported Platforms

Windows

Parameters:
element - A reference to a com.esri.arcgis.geoprocessing.IMdElement (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addElements

void addElements(IArray elements)
                 throws IOException,
                        AutomationException
Adds the collection of elements to the model.

Product Availability

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

Supported Platforms

Windows

Parameters:
elements - A reference to a com.esri.arcgis.system.IArray (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getElement

IMdElement getElement(String name)
                      throws IOException,
                             AutomationException
Returns the model element with the given name.

Product Availability

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

Supported Platforms

Windows

Parameters:
name - The name (in)
Returns:
A reference to a com.esri.arcgis.geoprocessing.IMdElement
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getElementByID

IMdElement getElementByID(int identifier)
                          throws IOException,
                                 AutomationException
Returns the model element with the given identifier.

Product Availability

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

Supported Platforms

Windows

Parameters:
identifier - The identifier (in)
Returns:
A reference to a com.esri.arcgis.geoprocessing.IMdElement
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getElements

IEnumMdElement getElements()
                           throws IOException,
                                  AutomationException
Returns all of the model elements in the model.

Product Availability

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

Supported Platforms

Windows

Returns:
A reference to a com.esri.arcgis.geoprocessing.IEnumMdElement
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getVariables

IEnumMdVariable getVariables()
                             throws IOException,
                                    AutomationException
Returns all of the variables in the model.

Product Availability

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

Supported Platforms

Windows

Returns:
A reference to a com.esri.arcgis.geoprocessing.IEnumMdVariable
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getProcesses

IEnumMdProcess getProcesses()
                            throws IOException,
                                   AutomationException
Returns all of the processes in the model.

Product Availability

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

Supported Platforms

Windows

Returns:
A reference to a com.esri.arcgis.geoprocessing.IEnumMdProcess
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteElement

void deleteElement(IMdElement element)
                   throws IOException,
                          AutomationException
Removes the given element from the model.

Product Availability

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

Supported Platforms

Windows

Parameters:
element - A reference to a com.esri.arcgis.geoprocessing.IMdElement (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

empty

void empty()
           throws IOException,
                  AutomationException
Removes all model elements from the model.

Product Availability

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

Supported Platforms

Windows

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

validate

IGPMessages validate(boolean reset,
                     IGPEnvironmentManager pEnvMgr)
                     throws IOException,
                            AutomationException
Validates all model elements in the model.

Product Availability

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

Supported Platforms

Windows

Parameters:
reset - The reset (in)
pEnvMgr - A reference to a com.esri.arcgis.geoprocessing.IGPEnvironmentManager (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGPMessages
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

execute

void execute(ITrackCancel trackcancel,
             boolean reset,
             IGPEnvironmentManager pEnvMgr,
             IGPMessages messages,
             boolean stopOnFirstFailure)
             throws IOException,
                    AutomationException
Executes all the processes in the model.

Product Availability

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

Supported Platforms

Windows

Parameters:
trackcancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
reset - The reset (in)
pEnvMgr - A reference to a com.esri.arcgis.geoprocessing.IGPEnvironmentManager (in)
messages - A reference to a com.esri.arcgis.geodatabase.IGPMessages (in)
stopOnFirstFailure - The stopOnFirstFailure (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

executeProcess

void executeProcess(IMdProcess pMdProcess,
                    ITrackCancel trackcancel,
                    boolean reset,
                    IGPEnvironmentManager pEnvMgr,
                    IGPMessages messages,
                    boolean stopOnFirstFailure)
                    throws IOException,
                           AutomationException
Executes a single process in the model.

Product Availability

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

Supported Platforms

Windows

Parameters:
pMdProcess - A reference to a com.esri.arcgis.geoprocessing.IMdProcess (in)
trackcancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
reset - The reset (in)
pEnvMgr - A reference to a com.esri.arcgis.geoprocessing.IGPEnvironmentManager (in)
messages - A reference to a com.esri.arcgis.geodatabase.IGPMessages (in)
stopOnFirstFailure - The stopOnFirstFailure (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

sortElements

IEnumMdElement sortElements()
                            throws IOException,
                                   AutomationException
Returns all the model elements in the model in sorted order.

Product Availability

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

Supported Platforms

Windows

Returns:
A reference to a com.esri.arcgis.geoprocessing.IEnumMdElement
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

traceDependents

IEnumMdElement traceDependents(IMdElement pMdElement,
                               int direction,
                               int depth)
                               throws IOException,
                                      AutomationException
Returns all the model elements dependent on the given model element in the given direction.

Product Availability

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

Supported Platforms

Windows

Parameters:
pMdElement - A reference to a com.esri.arcgis.geoprocessing.IMdElement (in)
direction - A com.esri.arcgis.geoprocessing.esriMdDirection constant (in)
depth - The depth (in)
Returns:
A reference to a com.esri.arcgis.geoprocessing.IEnumMdElement
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findDependents

IEnumMdElement findDependents(IMdElement pMdElement,
                              int direction,
                              int connectionType)
                              throws IOException,
                                     AutomationException
Returns all the model elements dependent on the given model element in the given direction of the given connection type.

Product Availability

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

Supported Platforms

Windows

Parameters:
pMdElement - A reference to a com.esri.arcgis.geoprocessing.IMdElement (in)
direction - A com.esri.arcgis.geoprocessing.esriMdDirection constant (in)
connectionType - A com.esri.arcgis.geoprocessing.esriMdConnectionType constant (in)
Returns:
A reference to a com.esri.arcgis.geoprocessing.IEnumMdElement
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

mergeElements

void mergeElements(IEnumMdElement pElements)
                   throws IOException,
                          AutomationException
Merges the given enumeration of model elements, commonly from another model, into the current model.

Product Availability

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

Supported Platforms

Windows

Parameters:
pElements - A reference to a com.esri.arcgis.geoprocessing.IEnumMdElement (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

verifyUniqueElementName

boolean verifyUniqueElementName(String name)
                                throws IOException,
                                       AutomationException
Returns whether or not the model already contains a model element by the given name.

Product Availability

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

Supported Platforms

Windows

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

canAddElement

boolean canAddElement(IMdElement pElement)
                      throws IOException,
                             AutomationException
Returns whether or not the given model element can be added to the model.

Product Availability

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

Supported Platforms

Windows

Parameters:
pElement - A reference to a com.esri.arcgis.geoprocessing.IMdElement (in)
Returns:
The pCanAdd
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getEnvironmentManager

IGPEnvironmentManager getEnvironmentManager()
                                            throws IOException,
                                                   AutomationException
The set of overriding environment values used when validating/executing the model.

Product Availability

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

Supported Platforms

Windows

Returns:
A reference to a com.esri.arcgis.geoprocessing.IGPEnvironmentManager
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setEnvironmentManagerByRef

void setEnvironmentManagerByRef(IGPEnvironmentManager ppEnvMgr)
                                throws IOException,
                                       AutomationException
The set of overriding environment values used when validating/executing the model.

Product Availability

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

Parameters:
ppEnvMgr - A reference to a com.esri.arcgis.geoprocessing.IGPEnvironmentManager (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isValid

boolean isValid()
                throws IOException,
                       AutomationException
Returns whether or not all the model elements in the model are valid.

Product Availability

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

Supported Platforms

Windows

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

isLicensed

boolean isLicensed()
                   throws IOException,
                          AutomationException
Returns whether or not all the processes in the model are licensed.

Product Availability

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

Supported Platforms

Windows

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

disconnectElements

void disconnectElements(IMdElement pFromElement,
                        IMdElement pToElement,
                        int connectionType)
                        throws IOException,
                               AutomationException
Removes the connection/dependency between two model elements.

Product Availability

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

Supported Platforms

Windows

Parameters:
pFromElement - A reference to a com.esri.arcgis.geoprocessing.IMdElement (in)
pToElement - A reference to a com.esri.arcgis.geoprocessing.IMdElement (in)
connectionType - A com.esri.arcgis.geoprocessing.esriMdConnectionType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createUniqueElementName

String createUniqueElementName(String name)
                               throws IOException,
                                      AutomationException
Generates a new unique name that may be used for adding a new model element to the model.

Product Availability

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

Supported Platforms

Windows

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