StateDMI / Command / CheckInstreamFlowRights

• Overview
• Command Editor
• Command Syntax
• Examples
• Troubleshooting
• See Also

---

Overview

The CheckInstreamFlowRights command (for StateMod) checks instream flow rights data for problems. The command should usually be used with a WriteCheckFile command at the end of a command file.

Command Editor

The following dialog is used to edit the command and illustrates the command syntax.

CheckInstreamFlowRights Command Editor (see also the full-size image)

Command Syntax

The command syntax is as follows:

CheckInstreamFlowRights(Parameter="Value",...)

Command Parameters

Parameter	Description	Default
ID	The identifier for the location(s) to check. Use * to match a pattern.	None – must be specified.
IfNotFound	One of the following: Fail – generate a failure message if the location identifier is not matched Ignore – ignore (don’t generate a message) if the location identifier is not matched Warn – generate a warning message if the location identifier is not matched	Warn

Examples

See the automated tests.

The following excerpt from a command file illustrates how instream flow rights can be checked and written to a StateMod file:

#
#  Create instream flow rights file
#
WriteInstreamFlowRightsToStateMod(OutputFile="..\STATEMOD\cm2005.ifr")
#
# Check the results
CheckInstreamFlowRights(ID="*")
WriteCheckFile(OutputFile="ifr.commands.StateDMI.check.html")

Troubleshooting

See Also

• WriteCheckFile command