StateDMI / Command / ReadInstreamFlowRightsFromHydroBase
Overview
The ReadInstreamFlowRightsFromHydroBase command (for StateMod)
reads instream flow rights from HydroBase, for each instream flow station that is defined.
The instream flow rights can then be manipulated and output with other commands.
Command Editor
The following dialog is used to edit the command and illustrates the command syntax.
ReadInstreamFlowRightsFromHydroBase Command Editor (see also the full-size image)
Command Syntax
The command syntax is as follows:
ReadInstreamFlowRightsFromHydroBase(Parameter="Value",...)
Command Parameters
| Parameter | Description | Default |
|---|---|---|
ID |
A single instream flow station identifier to match or a pattern using wildcards (e.g., 20*). |
None – must be specified. |
OnOffDefault |
Indicates how to set the on/off switch for all water rights that are processed. A value of 1 indicates that the right is on for the whole period. If the value is AppropriationDate, the switch is set to the year corresponding to the appropriation date, indicating that the right will be turned on starting in the year. Use set commands to reset the switch to other values. |
Appropriation |
| Date |
Examples
See the automated tests.
Troubleshooting
See Also
ReadInstreamFlowRightsFromStateModcommandWriteInstreamFlowRightsToStateModcommand