Skip to content

StateDMI / Command / WriteCULocationsToList

Overview

The WriteCULocationsToList command (for StateCU) writes CU Locations data to a delimited (list) file. The command uses the specified filename to determine the names of several files to write, as shown below:

  • cm2006.csv – name specified with OutputFile parameter, used for main CU Location data
  • cm2006_ClimateStations.csv – list of climate stations for the CU Location
  • cm2006_Collections.csv – list of collection data (aggregate and systems parts) for the CU Location

Command Editor

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

WriteCULocationsToList command editor

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

Command Syntax

The command syntax is as follows:

WriteCULocationsToList(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)

Examples

See the automated tests.

The following example illustrates how to process CU Locations data from HydroBase, starting with a list of station identifiers, and creating a full list of data:

ReadCULocationsFromList(ListFile="list.csv")
FillCULocationsFromHydroBase(ID="*",CULocType="Structure",Region1Type="County",Region2Type="HUC")
WriteCULocationsToList(OutputFile="test2.lst")

Troubleshooting

See the main troubleshooting documentation

See Also