Skip to content

StateDMI / Command / SetInstreamFlowDemandTSAverageMonthlyConstant

Overview

The SetInstreamFlowDemandTSAverageMonthlyConstant command (for StateMod) sets instream flow demand time series (average monthly) data to constant monthly values. Typically this command is used to (re)set values after the SetInstreamFlowDemandTSAverageMonthlyFromRights command is used.

Command Editor

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

SetInstreamFlowDemandTSAverageMonthlyConstant

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

Command Syntax

The command syntax is as follows:

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

Command Parameters

Parameter             Description Default          
ID
required		 A single instream flow station identifier to match or a pattern using wildcards (e.g., 20*). None – must be specified.
MonthValues
required		 Twelve monthly instream flow demand time series values for January through December. None – must be specified.
RecalcLimits If True, then the time series average limits will be recalculated. If False, the limits from previously set data will be used (not typically used). True
IfNotFound Used for error handling, one of the following:
    Add – add the instream flow demand time series if the ID is not matched and is not a wildcard
  • Fail – generate a failure message if the ID is not matched
  • Ignore – ignore (don’t add and don’t generate a message) if the ID is not matched
  • Warn – generate a warning message if the ID is not matched</li></ul> |Warn`

Examples

See the automated tests.

Troubleshooting

See Also