StateDMI / Command / WriteDiversionRightsToList

Overview

The WriteDiversionRightsToList command (for StateMod) writes diversion rights data to a delimited file.

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

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

The command syntax is as follows:

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

Command Parameters

Parameter	Description	Default
`OutputFile` required	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)

The following example illustrates how to create a list of diversion rights from a list of stations:

ReadDiversionStationsFromList(ListFile="test.csv")
ReadDiversionRightsFromHydroBase(ID="*")
WriteDiversionRightsToList(OutputFile="rights.csv")