Stop (ModelBuilder)

Summary

Exits a model out of the iteration loop if the input values are set to true or set to false. For the set of input values, iteration will continue if all the inputs are true and stop if any one of the inputs is false. It is functionally similar to the While tool but is useful to stop a model if there is one While iterator in a model and no additional iterators can be added.

Learn how Stop works in ModelBuilder

Usage

  • This tool is intended for use in ModelBuilder, not in Python scripting.

Syntax

arcpy.mb.Stop(in_values, {condition})
ParameterExplanationData Type
in_values
[in_values,...]

The values that will be checked before the model iteration will stop.

Any Value
condition
(Optional)

Specifies whether the iteration will run until all the inputs values are true or all the input values are false.

  • TRUEThe iteration will run until all the input values are true. This is the default.
  • FALSEThe iteration will run until all the input values are false.
String

Derived Output

NameExplanationData Type
continue

The continue value will be true if all inputs are True, and false if any of the inputs are False.

Boolean

Environments

This tool does not use any geoprocessing environments.

Licensing information

  • Basic: Yes
  • Standard: Yes
  • Advanced: Yes