Skip to content

StateDMI / Command / CheckDiversionDemandTSMonthly


Overview

The CheckDiversionDemandTSMonthly command (for StateMod) diversion demand monthly time series 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.

CheckDiversionDemandTSMonthly Command Editor

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

Command Syntax

The command syntax is as follows:

CheckDiversionDemandTSMonthly(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 diversion demand time series can be checked and written to a StateMod file:

#
#  Create diversion demand monthly time series file
#
WriteDiversionDemandTSMonthlyToStateMod(OutputFile="..\STATEMOD\rg2007C.ddm")
#
# Check the results
CheckDiversionDemandTSMonthly(ID="*")
WriteCheckFile(OutputFile="Cddm.commands.StateDMI.check.html")

Troubleshooting

See the main troubleshooting documentation

See Also