StateDMI / Command / WriteInstreamFlowRightsToList
Overview
The WriteInstreamFlowRightsToList command (for StateMod)
writes instream flow rights data to a delimited file.
Command Editor
The following dialog is used to edit the command and illustrates the command syntax.
WriteInstreamFlowRightsToList Command Editor (see also the full-size image)
Command Syntax
The command syntax is as follows:
WriteInstreamFlowRightsToList(Parameter="Value",...)
Command Parameters
| Parameter | Description | Default |
|---|---|---|
OutputFilerequired |
The name of the output file to write. | None – must be specified. |
WriteHow |
OverwriteFile if the file should be overwritten or UpdateFile if the file should be updated, resulting in the previous header being carried forward. |
OverwriteFile |
Delimiter |
The delimiter character to use between columns. | , (comma) |
Examples
See the automated tests.
The following example illustrates how to create a list of instream flow rights from a list of stations:
ReadInstreamFlowStationsFromList(ListFile="cm2005.ifs.csv")
ReadInstreamFlowRightsFromHydroBase(ID="*")
WriteInstreamFlowRightsToList(OutputFile="cm2005.ifr.csv")
Troubleshooting
See the main troubleshooting documentation
See Also
ReadInstreamFlowRightsFromStateModcommandWriteInstreamFlowRightsToStateModcommand