StateDMI / Command / WriteDiversionStationsToList
Overview
The WriteDiversionStationsToList
command (for StateMod)
writes diversion stations data to a delimited file.
In addition to the main station file,
files with suffixes _Collections
and _ReturnFlows
are written, containing secondary station information.
Command Editor
The following dialog is used to edit the command and illustrates the command syntax.
WriteDiversionStationsToList
Command Editor (see also the full-size image)
Command Syntax
The command syntax is as follows:
WriteDiversionStationsToList(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) |
Examples
See the automated tests.
The following example illustrates how to create a list of diversion stations from a network file:
ReadDiversionStationsFromNetwork(InputFile="cm2005.net")
WriteDiversionStationsToList(OutputFile="cm2005.csv")
Troubleshooting
See Also
ReadDiversionStationsFromStateMod
commandWriteDiversionStationsToStateMod
command