com.esri.arcgis.geoprocessing
Interface IMdModelIteration

All Superinterfaces:

Serializable

All Known Implementing Classes:

MdModel

public interface IMdModelIteration
extends Serializable

Provides access to properties/methods of a model iteration.

Product Availability

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

Method Summary

int	getCurrentIteration() Current model iteration.
int	getIterationCount() Number of times to iterate the model.
int	getIterationType() Indicates model iteration type.
IMdVariable	getIterationVariable() Model iteration variable.
void	setIterationCount(int count) Number of times to iterate the model.
void	setIterationType(int type) Indicates model iteration type.
void	setIterationVariableByRef(IMdVariable ppVariable) Model iteration variable.

Method Detail

getIterationType

int getIterationType()
                     throws IOException,
                            AutomationException

Indicates model iteration type.

Product Availability

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

Returns:

A com.esri.arcgis.geoprocessing.esriMdIterationType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIterationType

void setIterationType(int type)
                      throws IOException,
                             AutomationException

Indicates model iteration type.

Product Availability

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

Parameters:

type - A com.esri.arcgis.geoprocessing.esriMdIterationType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIterationCount

int getIterationCount()
                      throws IOException,
                             AutomationException

Number of times to iterate the model.

Product Availability

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

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIterationCount

void setIterationCount(int count)
                       throws IOException,
                              AutomationException

Number of times to iterate the model.

Product Availability

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

Parameters:

count - The count (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIterationVariable

IMdVariable getIterationVariable()
                                 throws IOException,
                                        AutomationException

Model iteration variable.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.geoprocessing.IMdVariable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIterationVariableByRef

void setIterationVariableByRef(IMdVariable ppVariable)
                               throws IOException,
                                      AutomationException

Model iteration variable.

Product Availability

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

Parameters:

ppVariable - A reference to a com.esri.arcgis.geoprocessing.IMdVariable (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentIteration

int getCurrentIteration()
                        throws IOException,
                               AutomationException

Current model iteration.

Product Availability

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

Returns:

The iteration

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.