StateDMI / Command / WriteWellRightsToList

Overview

The WriteWellRightsToList command (for StateMod) writes well rights data to a delimited file.

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

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

The command syntax is as follows:

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

Command Parameters

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

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

ReadWellStationsFromList(ListFile="test.lst")
ReadWellRightsFromHydroBase(ID="*")
WriteWellRightsToList(OutputFile="rights.lst")