StateDMI / Command / WriteReservoirRightsToList
Overview
The WriteReservoirRightsToList command (for StateMod)
writes reservoir rights data to a delimited file.
Command Editor
The following dialog is used to edit the command and illustrates the command syntax.
WriteReservoirRightsToList Command Editor (see also the full-size image)
Command Syntax
The command syntax is as follows:
WriteReservoirRightsToList(Parameter="Value",...)
Command Parameters
| Parameter | Description | Default |
|---|---|---|
OutputFilerequired |
The name of the output file to write, surrounded by double quotes. | 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 reservoir rights from a list of stations:
ReadReservoirStationsFromList(ListFile="cm2005.res.csv",IDCol=1)
ReadReservoirRightsFromHydroBase(ID="*")
WriteReservoirRightsToList(OutputFile="cm2005.rer.csv")
Troubleshooting
See the main troubleshooting documentation
See Also
ReadReservoirRightsFromHydroBasecommandReadReservoirRightsFromStateModcommandWriteReservoirRightsToStateModcommand