StateDMI / Command Reference / Overview
This documentation is in draft format and will be updated in the future. Some of the content is from TSTool.
This reference section of the documentation provides information about StateDMI commands, listed in groups consistent with the StateDMI software menus. If necessary, use the documentation Search tool or the Find tool for the web browser to find a specific command or topic.
Reference documentation for commands is being transferred from the original Word versions. Commands that don't have a description after the name do not have documentation included here.
- Command Syntax Overview
- Command List - alphabetical list of commands (is at the end of this section)
- StateCU Commands - need to convert documentation
- StateMod Commands - need to convert documentation
- Topic Area Commands
- Datastore Processing - read/write database data
- Output File Processing - process output model output files
- Spatial Processing - read/write spatial data
- Spreadsheet Processing - read/write spreadsheet files
- General Commands
- General - Comments - insert comments
- General - File Handling - manipulate files
- General - Logging and Messaging - handle log files and other messages
- General - Running and Properties - run programs and control logic
- General - Test Processings - automated tests for quality control
- Table Commands
- Create, Copy, Free Table - basic table object management
- Read Table - read tables from files, databases, and web services
- Append, Join Tables - append and join tables
- Table, Time Series Processing - translate tables to/from time series
- Manipulate Tables - manipulate table data
- Analyze Table - analyze table data
- Output Table - output (write) tables to files and databases
- Running and Properties - use table data to control logic
Command Syntax Overview
StateDMI command files contain a list of commands, one command per line. These commands are processed in sequence from top to bottom.
Each command adheres to the syntax:
CommandName(ParameterName1="ParameterValue1",ParameterName2="ParameterValue2",...)
The following are guidelines for commands:
- Commands always follow the convention of command name at start with a list of named parameters in parentheses. The only exceptions are:
- Commands are generally not case-specific although the StateDMI software enforces standards.
- Command and parameter names use mixed case where the first letter of each word is capitalized.
- Parameter values may optionally be surrounded by double quotes, regardless of type. Double quotes are required in some cases to protect spaces and other characters within quotes.
- Each command must exist on a single line.
- Spaces at the front of a command for indentation are currently not allowed. This limitation is planned to be removed in the future. Tabs used for indentation are discouraged and will likely be prohibited because tab width is ambiguous between different users and tools. Spaces will be the preferred method of indentation.
- Empty (blank) lines are allowed and will be handled as
Empty
commands. - Unknown commands are handled as
UnknownCommand
commands.
StateCU Commands
To be completed.
StateMod Commands
To be completed.
Topic Area Commands
The following commands are grouped into specific topic areas.
Datastore Processing
These commands handle reading and writing time series and other data from datastores, in particular databases. Utility commands for executing SQL and creating a data dictionary are also provided.
ReadTableFromDataStore
- read a table from a datastore
Output File Processing
These commands process output files (beyond the functionality of commands in other sections):
SplitStateModReport
- split a StateMod output file into separate files
Spatial Processing
WriteTableToGeoJSON
- write a table to a GeoJSON fileWriteTableToShapefile
- write a table to a shapefile
Spreadsheet Processing
NewExcelWorkbook
- create a new Excel workbook fileReadExcelWorkbook
- read Excel workbook fileReadTableFromExcel
- read a table from an Excel workbook fileReadTableCellsFromExcel
- read table cells from Excel worksheetReadPropertiesFromExcel
- read processor properties from ExcelSetExcelCell
- set data in an Excel cellSetExcelWorksheetViewProperties
- set Excel worksheet view propertiesWriteTableToExcel
- write a table to an Excel workbook fileWriteTableCellsToExcel
- write table row cells to an Excel worksheetCloseExcelWorkbook
- close Excel workbook that is open
General Commands
General commands perform tasks that are general in nature, meaning they are not specific to processing time series, tables, or other specific data types.
General - Comments
These commands are used to insert comments into command files.
#
comment - single line comment\*
comment block start - start of multi-line comment block\*
comment block end - end of multi-line comment block
General - File Handling
These commands provide general file handling capabilities.
ListFiles
- list files in a folderFTPGet
- download a file from an FTP siteWebGet
- download a file from a URLRemoveFile
- remove a fileUnzipFile
- unzip the contents of a zip file
General - Logging and Messaging
These commands handle run-time configuration of logging and sending messages.
Message
- output a message to the log fileSetDebugLevel
- set the debug level for loggingSetWarningLevel
- set the warning level for loggingStartLog
- (re)start the log file
General - Running and Properties
These commands provide general capabilities to control running commands, including running programs external to StateDMI and
handling processor properties (used with ${Property}
).
ReadPropertiesFromFile
- read processor properties from a fileSetProperty
- set a processor property valueFormatDateTimeProperty
- format a date/time processor propertyFormatStringProperty
- format a string processor propertyWritePropertiesToFile
- write processor properties to a fileRunCommands
- run a TSTool command fileRunProgram
- run a programRunPython
- run a Python a programRunR
- run an R scriptExit
- stop processing commandsSetWorkingDir
- set the working directory (folder) for following commandsEmpty
- empty (blank) lineUnknownCommand
- unknown command
General - Test Processing
These commands are used to run automated tests, in particular when running the full suite of tests.
CompareFiles
- compare files to detect whether they are the same or differentCreateRegressionTestCommandFile
- create a regression test suite command fileStartRegressionTestResultsReport
- start the regression test results report file to record output of tests
Table Commands
Table commands are used to process tabular data, for example:
- database tables
- Excel worksheets
- delimited and other data files
Tables are converted to an in-memory representation where each column stores a single data type. Tables and time series can be converted back and forth, as needed.
Create, Copy, Free Table
These commands create, copy, and free tables.
NewTable
- create a new tableCopyTable
- copy a table to a new tableFreeTable
- free memory resources for a table
Read Table
These commands read tables from various sources.
ReadTableFromDataStore
- read a table from a datastoreReadTableFromDBF
- read a table from a DBF fileReadTableFromDelimitedFile
- read a table from a delimited fileReadTableFromExcel
- read a table from an Excel workbook fileReadTableFromFixedFormatFile
- read a table from a fixed-format file
Append, Join Tables
These commands append and join tables.
AppendTable
- append a table to another tableJoinTables
- join two tables
Manipulate Tables
These commands manipulate tables.
InsertTableColumn
- insert a column in a tableDeleteTableColumns
- delete columns from a tableDeleteTableRows
- delete rows from a tableFormatTableDateTime
- format a date/time in a tableFormatTableString
- format a string in a tableManipulateTableString
- manipulate a string in a tableSetTableValues
- set values in a tableSplitTableColumn
- split table column into multiple columnsTableMath
- perform simple math on table columnsInsertTableRow
- insert a row in a tableSortTable
- sort table contentsSplitTableRow
- split a table row into multiple rows
Analyze Table
These commands analyze tables.
CompareTables
- compare tables to detect whether they are the same or different
Output Table
These commands write tables to various formats.
WriteTableToDelimitedFile
- write a table to a delimited fileWriteTableToExcel
- write a table to an Excel workbook fileWriteTableToHTML
- write a table to an HTML file
Running and Properties
These commands handle table properties, which are used to control run logic.
SetPropertyFromTable
- set a processor property from a table
Command List
The following table contains every command and provides summary information that is useful to software users and developers. "Documentation Migrated" indicates whether the original Word version of documentation have been migrated to the new online version (this documentation).
Command | Description | Doc. Status | Def. to Rel. Path |
---|---|---|---|
# comment |
Single line comment. | Migrated? | |
\* comment block start |
Start of multi-line comment block. | Migrated? | |
\* comment block end |
End of multi-line comment block. | Migrated? | |
AggregateWellRights |
AggregateWellRights | ||
AppendNetwork |
AppendNetwork | ||
AppendTable |
Append a table to another table. | Migrated? | |
CalculateDiversionDemandTSMonthly |
CalculateDiversionDemandTSMonthly | ||
CalculateDiversionDemandTSMonthlyAsMax |
CalculateDiversionDemandTSMonthlyAsMax | ||
CalculateDiversionStationEfficiencies |
CalculateDiversionStationEfficiencies | ||
CalculateStreamEstimateCoefficients |
CalculateStreamEstimateCoefficients | ||
CalculateWellDemandTSMonthly |
CalculateWellDemandTSMonthly | ||
CalculateWellDemandTSMonthlyAsMax |
CalculateWellDemandTSMonthlyAsMax | ||
CalculateWellStationEfficiencies |
CalculateWellStationEfficiencies | ||
CheckBlaneyCriddle |
CheckBlaneyCriddle | ||
CheckClimateStations |
CheckClimateStations | ||
CheckCropCharacteristics |
CheckCropCharacteristics | ||
CheckCropPatternTS |
CheckCropPatternTS | ||
CheckCULocations |
CheckCULocations | ||
CheckDiversionDemandTSMonthly |
CheckDiversionDemandTSMonthly | ||
CheckDiversionHistoricalTSMonthly |
CheckDiversionHistoricalTSMonthly | ||
CheckDiversionRights |
CheckDiversionRights | ||
CheckDiversionStations |
CheckDiversionStations | ||
CheckInstreamFlowDemandTSAverageMonthly |
CheckInstreamFlowDemandTSAverageMonthly | ||
CheckInstreamFlowRights |
CheckInstreamFlowRights | ||
CheckInstreamFlowStations |
CheckInstreamFlowStations | ||
CheckIrrigatedLands |
CheckIrrigatedLands | ||
CheckIrrigationPracticeTS |
CheckIrrigationPracticeTS | ||
CheckParcels |
CheckParcels | ||
CheckPenmanMonteith |
CheckPenmanMonteith | ||
CheckReservoirRights |
CheckReservoirRights | ||
CheckReservoirStations |
CheckReservoirStations | ||
CheckRiverNetwork |
CheckRiverNetwork | ||
CheckStreamEstimateCoefficients |
CheckStreamEstimateCoefficients | ||
CheckStreamEstimateStations |
CheckStreamEstimateStations | ||
CheckStreamGageStations |
CheckStreamGageStations | ||
CheckWellDemandTSMonthly |
CheckWellDemandTSMonthly | ||
CheckWellHistoricalPumpingTSMonthly |
CheckWellHistoricalPumpingTSMonthly | ||
CheckWellRights |
CheckWellRights | ||
CheckWellStations |
CheckWellStations | ||
CloseExcelWorkbook |
Close Excel workbook that is open. | Migrated? | |
CompareFiles |
Compare files to detect whether they are the same or different. | Migrated? | |
CompareTables |
Compare tables to detect whether they are the same or different. | Migrated? | |
CopyTable |
Copy a table to a new table. | Migrated? | |
CreateCropPatternTSForCULocations |
CreateCropPatternTSForCULocations | ||
CreateIrrigationPracticeTSForCULocations |
CreateIrrigationPracticeTSForCULocations | ||
CreateNetworkFromRiverNetwork |
CreateNetworkFromRiverNetwork | ||
CreateRegressionTestCommandFile |
CreateRegressionTestCommandFile | ||
CreateRiverNetworkFromNetwork |
CreateRiverNetworkFromNetwork | ||
DeleteTableColumns |
Delete columns from a table. | Migrated? | |
DeleteTableRows |
Delete rows from a table. | Migrated? | |
Empty |
Empty (blank) commands line. | Migrated? | |
Exit |
Stop processing commands. | Migrated? | |
FillClimateStation |
FillClimateStation | ||
FillClimateStationsFromHydroBase |
FillClimateStationsFromHydroBase | ||
FillCropPatternTSConstant |
FillCropPatternTSConstant | ||
FillCropPatternTSInterpolate |
FillCropPatternTSInterpolate | ||
FillCropPatternTSRepeat |
FillCropPatternTSRepeat | ||
FillCropPatternTSUsingWellRights |
FillCropPatternTSUsingWellRights | ||
FillCULocation |
FillCULocation | ||
FillCULocationClimateStationWeights |
FillCULocationClimateStationWeights | ||
FillCULocationsFromHydroBase |
FillCULocationsFromHydroBase | ||
FillCULocationsFromList |
FillCULocationsFromList | ||
FillDiversionDemandTSMonthlyAverage |
FillDiversionDemandTSMonthlyAverage | ||
FillDiversionDemandTSMonthlyConstant |
FillDiversionDemandTSMonthlyConstant | ||
FillDiversionDemandTSMonthlyPattern |
FillDiversionDemandTSMonthlyPattern | ||
FillDiversionHistoricalTSMonthlyAverage |
FillDiversionHistoricalTSMonthlyAverage | ||
FillDiversionHistoricalTSMonthlyConstant |
FillDiversionHistoricalTSMonthlyConstant | ||
FillDiversionHistoricalTSMonthlyPattern |
FillDiversionHistoricalTSMonthlyPattern | ||
FillDiversionRight |
FillDiversionRight | ||
FillDiversionStation |
FillDiversionStation | ||
FillDiversionStationsFromHydroBase |
FillDiversionStationsFromHydroBase | ||
FillDiversionStationsFromNetwork |
FillDiversionStationsFromNetwork | ||
FillInstreamFlowRight |
FillInstreamFlowRight | ||
FillInstreamFlowStation |
FillInstreamFlowStation | ||
FillInstreamFlowStationsFromHydroBase |
FillInstreamFlowStationsFromHydroBase | ||
FillInstreamFlowStationsFromNetwork |
FillInstreamFlowStationsFromNetwork | ||
FillIrrigationPracticeTSAcreageUsingWellRights |
FillIrrigationPracticeTSAcreageUsingWellRights | ||
FillIrrigationPracticeTSInterpolate |
FillIrrigationPracticeTSInterpolate | ||
FillIrrigationPracticeTSRepeat |
FillIrrigationPracticeTSRepeat | ||
FillNetworkFromHydroBase |
FillNetworkFromHydroBase | ||
FillReservoirRight |
FillReservoirRight | ||
FillReservoirStation |
FillReservoirStation | ||
FillReservoirStationsFromHydroBase |
FillReservoirStationsFromHydroBase | ||
FillReservoirStationsFromNetwork |
FillReservoirStationsFromNetwork | ||
FillRiverNetworkFromHydroBase |
FillRiverNetworkFromHydroBase | ||
FillRiverNetworkFromNetwork |
FillRiverNetworkFromNetwork | ||
FillRiverNetworkNode |
FillRiverNetworkNode | ||
FillStreamEstimateStation |
FillStreamEstimateStation | ||
FillStreamEstimateStationsFromHydroBase |
FillStreamEstimateStationsFromHydroBase | ||
FillStreamEstimateStationsFromNetwork |
FillStreamEstimateStationsFromNetwork | ||
FillStreamGageStation |
FillStreamGageStation | ||
FillStreamGageStationsFromHydroBase |
FillStreamGageStationsFromHydroBase | ||
FillStreamGageStationsFromNetwork |
FillStreamGageStationsFromNetwork | ||
FillWellDemandTSMonthlyAverage |
FillWellDemandTSMonthlyAverage | ||
FillWellDemandTSMonthlyConstant |
FillWellDemandTSMonthlyConstant | ||
FillWellDemandTSMonthlyPattern |
FillWellDemandTSMonthlyPattern | ||
FillWellHistoricalPumpingTSMonthlyAverage |
FillWellHistoricalPumpingTSMonthlyAverage | ||
FillWellHistoricalPumpingTSMonthlyConstant |
FillWellHistoricalPumpingTSMonthlyConstant | ||
FillWellHistoricalPumpingTSMonthlyPattern |
FillWellHistoricalPumpingTSMonthlyPattern | ||
FillWellRight |
FillWellRight | ||
FillWellStation |
FillWellStation | ||
FillWellStationsFromDiversionStations |
FillWellStationsFromDiversionStations | ||
FillWellStationsFromNetwork |
FillWellStationsFromNetwork | ||
FormatDateTimeProperty |
Format a date/time processor property. | Migrated? | |
FormatStringProperty |
Format string processor property. | Migrated? | |
FormatTableDateTime |
Format a date/time in a table. | Migrated? | |
FormatTableString |
Format a string in a table. | Migrated? | |
FreeTable |
Free memory resources for a table. | Migrated? | |
FTPGet |
Download a file from an FTP site. | Migrated? | |
InsertTableColumn |
Insert a column in a table. | Migrated? | |
InsertTableRow |
Insert a row in a table. | Migrated? | |
JoinTables |
Join two tables. | Migrated? | |
LimitDiversionDemandTSMonthlyToRights |
LimitDiversionDemandTSMonthlyToRights | ||
LimitDiversionHistoricalTSMonthlyToRights |
LimitDiversionHistoricalTSMonthlyToRights | ||
LimitWellDemandTSMonthlyToRights |
LimitWellDemandTSMonthlyToRights | ||
LimitWellHistoricalPumpingTSMonthlyToRights |
LimitWellHistoricalPumpingTSMonthlyToRights | ||
ListFiles |
List files in a folder. | Migrated? | |
ManipulateTableString |
Manipulate a string in a table. | Migrated? | |
MergeListFileColumns |
MergeListFileColumns | ||
MergeWellRights |
MergeWellRights | ||
Message |
Output a message to the log file. | Migrated? | |
NewExcelWorkbook |
Create a new Excel workbook file. | Migrated? | |
NewTable |
Create a new table. | Migrated? | |
OpenHydroBase |
OpenHydroBase | ||
PrintNetwork |
PrintNetwork | ||
ReadBlaneyCriddleFromHydroBase |
ReadBlaneyCriddleFromHydroBase | ||
ReadBlaneyCriddleFromStateCU |
ReadBlaneyCriddleFromStateCU | ||
ReadClimateStationsFromList |
ReadClimateStationsFromList | ||
ReadClimateStationsFromStateCU |
ReadClimateStationsFromStateCU | ||
ReadControlFromStateMod |
ReadControlFromStateMod | ||
ReadCropCharacteristicsFromHydroBase |
ReadCropCharacteristicsFromHydroBase | ||
ReadCropCharacteristicsFromStateCU |
ReadCropCharacteristicsFromStateCU | ||
ReadCropPatternTSFromHydroBase |
ReadCropPatternTSFromHydroBase | ||
ReadCropPatternTSFromParcels |
ReadCropPatternTSFromParcels | ||
ReadCropPatternTSFromStateCU |
ReadCropPatternTSFromStateCU | ||
ReadCULocationsFromStateCU |
ReadCULocationsFromStateCU | ||
ReadCULocationsFromStateMod |
ReadCULocationsFromStateMod | ||
ReadDelayTablesDailyFromStateMod |
ReadDelayTablesDailyFromStateMod | ||
ReadDelayTablesMonthlyFromStateMod |
ReadDelayTablesMonthlyFromStateMod | ||
ReadDiversionDemandTSMonthlyFromStateMod |
ReadDiversionDemandTSMonthlyFromStateMod | ||
ReadDiversionHistoricalTSMonthlyFromHydroBase |
ReadDiversionHistoricalTSMonthlyFromHydroBase | ||
ReadDiversionHistoricalTSMonthlyFromStateMod |
ReadDiversionHistoricalTSMonthlyFromStateMod | ||
ReadDiversionRightsFromHydroBase |
ReadDiversionRightsFromHydroBase | ||
ReadDiversionRightsFromStateMod |
ReadDiversionRightsFromStateMod | ||
ReadDiversionStationsFromList |
ReadDiversionStationsFromList | ||
ReadDiversionStationsFromNetwork |
ReadDiversionStationsFromNetwork | ||
ReadDiversionStationsFromStateMod |
ReadDiversionStationsFromStateMod | ||
ReadExcelWorkbook |
ReadExcelWorkbook | ||
ReadInstreamFlowDemandTSAverageMonthlyFromStateMod |
ReadInstreamFlowDemandTSAverageMonthlyFromStateMod | ||
ReadInstreamFlowRightsFromHydroBase |
ReadInstreamFlowRightsFromHydroBase | ||
ReadInstreamFlowRightsFromStateMod |
ReadInstreamFlowRightsFromStateMod | ||
ReadInstreamFlowStationsFromList |
ReadInstreamFlowStationsFromList | ||
ReadInstreamFlowStationsFromNetwork |
ReadInstreamFlowStationsFromNetwork | ||
ReadInstreamFlowStationsFromStateMod |
ReadInstreamFlowStationsFromStateMod | ||
ReadIrrigationPracticeTSFromHydroBase |
ReadIrrigationPracticeTSFromHydroBase | ||
ReadIrrigationPracticeTSFromList |
ReadIrrigationPracticeTSFromList | ||
ReadIrrigationPracticeTSFromParcels |
ReadIrrigationPracticeTSFromParcels | ||
ReadIrrigationPracticeTSFromStateCU |
ReadIrrigationPracticeTSFromStateCU | ||
ReadIrrigationWaterRequirementTSMonthlyFromStateCU |
ReadIrrigationWaterRequirementTSMonthlyFromStateCU | ||
ReadNetworkFromStateMod |
ReadNetworkFromStateMod | ||
ReadOperationalRightsFromStateMod |
ReadOperationalRightsFromStateMod | ||
ReadPatternFile |
ReadPatternFile | ||
ReadParcelsFromHydroBase |
ReadParcelsFromHydroBase | ||
ReadPenmanMonteithFromHydroBase |
ReadPenmanMonteithFromHydroBase | ||
ReadPenmanMonteithFromStateCU |
ReadPenmanMonteithFromStateCU | ||
ReadPlanReturnFromStateMod |
ReadPlanReturnFromStateMod | ||
ReadPlanStationsFromStateMod |
ReadPlanStationsFromStateMod | ||
ReadPlanWellAugmentationFromStateMod |
ReadPlanWellAugmentationFromStateMod | ||
ReadPropertiesFromExcel |
ReadPropertiesFromExcel | ||
ReadPropertiesFromFile |
ReadPropertiesFromFile | ||
ReadReservoirReturnFromStateMod |
ReadReservoirReturnFromStateMod | ||
ReadReservoirRightsFromHydroBase |
ReadReservoirRightsFromHydroBase | ||
ReadReservoirRightsFromStateMod |
ReadReservoirRightsFromStateMod | ||
ReadReservoirStationsFromList |
ReadReservoirStationsFromList | ||
ReadReservoirStationsFromNetwork |
ReadReservoirStationsFromNetwork | ||
ReadReservoirStationsFromStateMod |
ReadReservoirStationsFromStateMod | ||
ReadResponseFromStateMod |
ReadResponseFromStateMod | ||
ReadRiverNetworkFromStateMod |
ReadRiverNetworkFromStateMod | ||
ReadStreamEstimateCoefficientsFromStateMod |
ReadStreamEstimateCoefficientsFromStateMod | ||
ReadStreamEstimateStationsFromList |
ReadStreamEstimateStationsFromList | ||
ReadStreamEstimateStationsFromNetwork |
ReadStreamEstimateStationsFromNetwork | ||
ReadStreamEstimateStationsFromStateMod |
ReadStreamEstimateStationsFromStateMod | ||
ReadStreamGageStationsFromList |
ReadStreamGageStationsFromList | ||
ReadStreamGageStationsFromNetwork |
ReadStreamGageStationsFromNetwork | ||
ReadStreamGageStationsFromStateMod |
ReadStreamGageStationsFromStateMod | ||
ReadTableCellsFromExcel |
Read table cells from Excel worksheet. | Migrated? | |
ReadTableFromDataStore |
Read a table from a datastore. | Migrated? | |
ReadTableFromDBF |
Read a table from a DBF file. | Migrated? | |
ReadTableFromDelimitedFile |
Read a table from a delimited file. | Migrated? | |
ReadTableFromExcel |
Read a table from an Excel workbook file. | Migrated? | |
ReadTableFromFixedFormatFile |
Read a table from a fixed-format file. | Migrated? | |
ReadWellDemandTSMonthlyFromStateMod |
ReadWellDemandTSMonthlyFromStateMod | ||
ReadWellHistoricalPumpingTSMonthlyFromStateCU |
ReadWellHistoricalPumpingTSMonthlyFromStateCU | ||
ReadWellHistoricalPumpingTSMonthlyFromStateMod |
ReadWellHistoricalPumpingTSMonthlyFromStateMod | ||
ReadWellRightsFromHydroBase |
ReadWellRightsFromHydroBase | ||
ReadWellRightsFromStateMod |
ReadWellRightsFromStateMod | ||
ReadWellStationsFromNetwork |
ReadWellStationsFromNetwork | ||
ReadWellStationsFromStateMod |
ReadWellStationsFromStateMod | ||
RemoveCropPatternTS |
RemoveCropPatternTS | ||
RemoveFile |
Remove a file. | Migrated? | |
RunCommands |
Run a TSTool command file. | Migrated? | |
RunProgram |
Run a program. | Migrated? | |
RunPython |
Run a python program. | Migrated? | |
RunR |
Run an R script. | Migrated? | |
SetBlaneyCriddle |
SetBlaneyCriddle | ||
SetClimateStation |
SetClimateStation | ||
SetCropCharacteristics |
SetCropCharacteristics | ||
SetCropPatternTS |
SetCropPatternTS | ||
SetCropPatternTSFromList |
SetCropPatternTSFromList | ||
SetCULocation |
SetCULocation | ||
SetCULocationClimateStationWeights |
SetCULocationClimateStationWeights | ||
SetCULocationClimateStationWeightsFromHydroBase |
SetCULocationClimateStationWeightsFromHydroBase | ||
SetCULocationClimateStationWeightsFromList |
SetCULocationClimateStationWeightsFromList | ||
SetCULocationsFromList |
SetCULocationsFromList | ||
SetDebugLevel |
Set the debug level for logging. | Migrated? | |
SetDiversionAggregate |
SetDiversionAggregate | ||
SetDiversionAggregateFromList |
SetDiversionAggregateFromList | ||
SetDiversionDemandTSMonthly |
SetDiversionDemandTSMonthly | ||
SetDiversionDemandTSMonthlyConstant |
SetDiversionDemandTSMonthlyConstant | ||
SetDiversionHistoricalTSMonthly |
SetDiversionHistoricalTSMonthly | ||
SetDiversionHistoricalTSMonthlyConstant |
SetDiversionHistoricalTSMonthlyConstant | ||
SetDiversionMultiStruct |
SetDiversionMultiStruct | ||
SetDiversionMultiStructFromList |
SetDiversionMultiStructFromList | ||
SetDiversionRight |
SetDiversionRight | ||
SetDiversionStation |
SetDiversionStation | ||
SetDiversionStationCapacitiesFromTS |
SetDiversionStationCapacitiesFromTS | ||
SetDiversionStationDelayTablesFromNetwork |
SetDiversionStationDelayTablesFromNetwork | ||
SetDiversionStationDelayTablesFromRTN |
SetDiversionStationDelayTablesFromRTN | ||
SetDiversionStationsFromList |
SetDiversionStationsFromList | ||
SetDiversionSystem |
SetDiversionSystem | ||
SetDiversionSystemFromList |
SetDiversionSystemFromList | ||
SetExcelCell |
Set data in an Excel cell. | Migrated? | |
SetExcelWorksheetViewProperties |
Set Excel worksheet view properties. | Migrated? | |
SetInstreamFlowDemandTSAverageMonthlyConstant |
SetInstreamFlowDemandTSAverageMonthlyConstant | ||
SetInstreamFlowDemandTSAverageMonthlyFromRights |
SetInstreamFlowDemandTSAverageMonthlyFromRights | ||
SetInstreamFlowRight |
SetInstreamFlowRight | ||
SetInstreamFlowStation |
SetInstreamFlowStation | ||
SetIrrigationPracticeTS |
SetIrrigationPracticeTS | ||
SetIrrigationPracticeTSFromHydroBase |
SetIrrigationPracticeTSFromHydroBase | ||
SetIrrigationPracticeTSFromList |
SetIrrigationPracticeTSFromList | ||
SetIrrigationPracticeTSFromStateCU |
SetIrrigationPracticeTSFromStateCU | ||
SetIrrigationPracticeTSMaxPumpingToRights |
SetIrrigationPracticeTSMaxPumpingToRights | ||
SetIrrigationPracticeTSPumpingMaxUsingWellRights |
SetIrrigationPracticeTSPumpingMaxUsingWellRights | ||
SetIrrigationPracticeTSSprinklerAcreageFromList |
SetIrrigationPracticeTSSprinklerAcreageFromList | ||
SetIrrigationPracticeTSSprinklerAreaFromList |
SetIrrigationPracticeTSSprinklerAreaFromList | ||
SetIrrigationPracticeTSTotalAcreageToCropPatternTSTotalAcreage |
SetIrrigationPracticeTSTotalAcreageToCropPatternTSTotalAcreage | ||
SetOperationalRight |
SetOperationalRight | ||
SetOutputPeriod |
Set the global processor output period. | Migrated? | |
SetOutputYearType |
Set the global processor output year type. | Migrated? | |
SetParcel |
SetParcel | ||
SetParcelGroundWaterSupply |
SetParcelGroundWaterSupply | ||
SetParcelSurfaceWaterSupply |
SetParcelSurfaceWaterSupply | ||
SetPenmanMonteith |
SetPenmanMonteith | ||
SetPlanStation |
SetPlanStation | ||
SetProperty |
Set processor property value. | Migrated? | |
SetPropertyFromTable |
Set processor property from a table. | Migrated? | |
SetReservoirAggregate |
SetReservoirAggregate | ||
SetReservoirAggregateFromList |
SetReservoirAggregateFromList | ||
SetReservoirRight |
SetReservoirRight | ||
SetReservoirStation |
SetReservoirStation | ||
SetRiverNetworkNode |
SetRiverNetworkNode | ||
SetStreamEstimateCoefficients |
SetStreamEstimateCoefficients | ||
SetStreamEstimateCoefficientsPFGage |
SetStreamEstimateCoefficientsPFGage | ||
SetStreamEstimateStation |
SetStreamEstimateStation | ||
SetStreamGageStation |
SetStreamGageStation | ||
SetTableValues |
Set values in a table. | Migrated? | |
SetWarningLevel |
Set the warning level for logging. | Migrated? | |
SetWellAggregate |
SetWellAggregate | ||
SetWellAggregateFromList |
SetWellAggregateFromList | ||
SetWellDemandTSMonthly |
SetWellDemandTSMonthly | ||
SetWellDemandTSMonthlyConstant |
SetWellDemandTSMonthlyConstant | ||
SetWellHistoricalPumpingTSMonthly |
SetWellHistoricalPumpingTSMonthly | ||
SetWellHistoricalPumpingTSMonthlyConstant |
SetWellHistoricalPumpingTSMonthlyConstant | ||
SetWellRight |
SetWellRight | ||
SetWellStation |
SetWellStation | ||
SetWellStationAreaToCropPatternTS |
SetWellStationAreaToCropPatternTS | ||
SetWellStationCapacitiesFromTS |
SetWellStationCapacitiesFromTS | ||
SetWellStationCapacityToWellRights |
SetWellStationCapacityToWellRights | ||
SetWellStationDelayTablesFromNetwork |
SetWellStationDelayTablesFromNetwork | ||
SetWellStationDelayTablesFromRTN |
SetWellStationDelayTablesFromRTN | ||
SetWellStationDepletionTablesFromRTN |
SetWellStationDepletionTablesFromRTN | ||
SetWellStationsFromList |
SetWellStationsFromList | ||
SetWellSystem |
SetWellSystem | ||
SetWellSystemFromList |
SetWellSystemFromList | ||
SetWorkingDir |
Set the working directory (folder) for following commands. | Migrated? | |
SortBlaneyCriddle |
SortBlaneyCriddle | ||
SortClimateStations |
SortClimateStations | ||
SortCropCharacteristics |
SortCropCharacteristics | ||
SortCropPatternTS |
SortCropPatternTS | ||
SortCULocations |
SortCULocations | ||
SortDiversionDemandTSMonthly |
SortDiversionDemandTSMonthly | ||
SortDiversionHistoricalTSMonthly |
SortDiversionHistoricalTSMonthly | ||
SortDiversionRights |
SortDiversionRights | ||
SortDiversionStations |
SortDiversionStations | ||
SortInstreamFlowRights |
SortInstreamFlowRights | ||
SortInstreamFlowStations |
SortInstreamFlowStations | ||
SortIrrigationPracticeTS |
SortIrrigationPracticeTS | ||
SortPenmanMonteith |
SortPenmanMonteith | ||
SortReservoirRights |
SortReservoirRights | ||
SortReservoirStations |
SortReservoirStations | ||
SortStreamEstimateStations |
SortStreamEstimateStations | ||
SortStreamGageStations |
SortStreamGageStations | ||
SortTable |
Sort table contents. | Migrated? | |
SortWellDemandTSMonthly |
SortWellDemandTSMonthly | ||
SortWellHistoricalPumpingTSMonthly |
SortWellHistoricalPumpingTSMonthly | ||
SortWellRights |
SortWellRights | ||
SortWellStations |
SortWellStations | ||
SplitStateModReport |
Split a StateMod report file into separate files. | Migrated | |
SplitTableColumn |
Split a table column into multiple columns. | Migrated? | |
SplitTableRow |
Split a table row into multiple rows. | Migrated? | |
StartLog |
(Re)start the log file. | Migrated? | |
StartRegressionTestResultsReport |
Start the regression test results report file to record output of tests. | Migrated? | |
TableMath |
Perform simple math on table columns. | Migrated? | |
TranslateBlaneyCriddle |
TranslateBlaneyCriddle | ||
TranslateCropCharacteristics |
TranslateCropCharacteristics | ||
TranslateCropPatternTS |
TranslateCropPatternTS | ||
TranslatePenmanMonteith |
TranslatePenmanMonteith | ||
UnknownCommand |
Unknown command. | Migrated? | |
UnzipFile |
Unzip the contents of a zip file. | Migrated? | |
WebGet |
Download a file from a URL. | Migrated? | |
WriteBlaneyCriddleToList |
WriteBlaneyCriddleToList | ||
WriteBlaneyCriddleToStateCU |
WriteBlaneyCriddleToStateCU | ||
WriteCheckFile |
Write command log to file. | Migrated? | |
WriteClimateStationsToList |
WriteClimateStationsToList | ||
WriteClimateStationsToStateCU |
WriteClimateStationsToStateCU | ||
WriteControlToStateMod |
WriteControlToStateMod | ||
WriteCropCharacteristicsToList |
WriteCropCharacteristicsToList | ||
WriteCropCharacteristicsToStateCU |
WriteCropCharacteristicsToStateCU | ||
WriteCropPatternTSToDateValue |
WriteCropPatternTSToDateValue | ||
WriteCropPatternTSToStateCU |
WriteCropPatternTSToStateCU | ||
WriteCULocationsToStateCU |
WriteCULocationsToStateCU | ||
WriteDelayTablesDailyToList |
WriteDelayTablesDailyToList | ||
WriteDelayTablesDailyToStateMod |
WriteDelayTablesDailyToStateMod | ||
WriteDelayTablesMonthlyToList |
WriteDelayTablesMonthlyToList | ||
WriteDelayTablesMonthlyToStateMod |
WriteDelayTablesMonthlyToStateMod | ||
WriteDelayTablesToStateCU |
WriteDelayTablesToStateCU | ||
WriteDiversionDemandTSMonthlyToStateMod |
WriteDiversionDemandTSMonthlyToStateMod | ||
WriteDiversionHistoricalTSMonthlyToStateMod |
WriteDiversionHistoricalTSMonthlyToStateMod | ||
WriteDiversionRightsToList |
WriteDiversionRightsToList | ||
WriteDiversionRightsToStateMod |
WriteDiversionRightsToStateMod | ||
WriteDiversionStationsToList |
WriteDiversionStationsToList | ||
WriteDiversionStationsToStateMod |
WriteDiversionStationsToStateMod | ||
WriteInstreamFlowDemandTSAverageMonthlyToStateMod |
WriteInstreamFlowDemandTSAverageMonthlyToStateMod | ||
WriteInstreamFlowRightsToList |
WriteInstreamFlowRightsToList | ||
WriteInstreamFlowRightsToStateMod |
WriteInstreamFlowRightsToStateMod | ||
WriteInstreamFlowStationsToList |
WriteInstreamFlowStationsToList | ||
WriteInstreamFlowStationsToStateMod |
WriteInstreamFlowStationsToStateMod | ||
WriteIrrigationPracticeTSToDateValue |
WriteIrrigationPracticeTSToDateValue | ||
WriteIrrigationPracticeTSToStateCU |
WriteIrrigationPracticeTSToStateCU | ||
WriteNetworkToStateMod |
WriteNetworkToStateMod | ||
WriteOperationalRightsToStateMod |
WriteOperationalRightsToStateMod | ||
WriteParcelsToFile |
WriteParcelsToFile | ||
WritePenmanMonteithToList |
WritePenmanMonteithToList | ||
WritePenmanMonteithToStateCU |
WritePenmanMonteithToStateCU | ||
WritePlanReturnToStateMod |
WritePlanReturnToStateMod | ||
WritePlanStationsToStateMod |
WritePlanStationsToStateMod | ||
WritePlanWellAugmentationToStateMod |
WritePlanWellAugmentationToStateMod | ||
WritePropertiesToFile |
Write processor properties to a file. | Migrated? | |
WriteReservoirReturnToStateMod |
WriteReservoirReturnToStateMod | ||
WriteReservoirRightsToList |
WriteReservoirRightsToList | ||
WriteReservoirRightsToStateMod |
WriteReservoirRightsToStateMod | ||
WriteReservoirStationsToList |
WriteReservoirStationsToList | ||
WriteReservoirStationsToStateMod |
WriteReservoirStationsToStateMod | ||
WriteResponseToStateMod |
WriteResponseToStateMod | ||
WriteRiverNetworkToList |
WriteRiverNetworkToList | ||
WriteRiverNetworkToStateMod |
WriteRiverNetworkToStateMod | ||
WriteStreamEstimateCoefficientsToList |
WriteStreamEstimateCoefficientsToList | ||
WriteStreamEstimateCoefficientsToStateMod |
WriteStreamEstimateCoefficientsToStateMod | ||
WriteStreamEstimateStationsToList |
WriteStreamEstimateStationsToList | ||
WriteStreamEstimateStationsToStateMod |
WriteStreamEstimateStationsToStateMod | ||
WriteStreamGageStationsToList |
WriteStreamGageStationsToList | ||
WriteStreamGageStationsToStateMod |
WriteStreamGageStationsToStateMod | ||
WriteTableCellsToExcel |
Write table row cells to an Excel worksheet. | Migrated? | |
WriteTableToDelimitedFile |
Write a table to delimited file. | Migrated? | |
WriteTableToExcel |
Write a table to an Excel workbook file. | Migrated? | |
WriteTableToGeoJSON |
Write a table to a GeoJSON file. | Migrated? | |
WriteTableToHTML |
Write a table to an HTML file. | Migrated? | |
WriteTableToShapefile |
Write a table to a shapefile. | Migrated? | |
WriteTableToShapefile |
WriteTableToShapefile | ||
WriteWellDemandTSMonthlyToStateMod |
WriteWellDemandTSMonthlyToStateMod | ||
WriteWellHistoricalPumpingTSMonthlyToStateMod |
WriteWellHistoricalPumpingTSMonthlyToStateMod | ||
WriteWellRightsToList |
WriteWellRightsToList | ||
WriteWellRightsToStateMod |
WriteWellRightsToStateMod | ||
WriteWellStationsToStateMod |
WriteWellStationsToStateMod |