Skip to content

StateDMI / Command / WriteInstreamFlowStationsToList

Overview

The WriteInstreamFlowStationsToList command (for StateMod) writes instream flow stations data to a delimited file.

Command Editor

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

WriteInstreamFlowStationsToList

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

Command Syntax

The command syntax is as follows:

WriteInstreamFlowStationsToList(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 instream flow stations from a network file:

ReadInstreamFlowStationsFromNetwork(InputFile="cm2005.net")
WriteInstreamFlowStationsToList(OutputFile="cm2005.ifs.csv”)

Troubleshooting

See Also