StateDMI / Command / SetOutputPeriod
Overview
The SetOutputPeriod command (for StateCU and StateMod)
sets the output period for time series.
Specifying the output period is necessary when creating model files or filling
an extended period (time series will not automatically be extended by fill commands).
The TSTool software uses SetInputPeriod command to constrain the data that are read,
and can be used with different dates for SetOutpuPeriod.
However, StateDMI generally uses the period from SetOutputPeriod for the period to to read data and output results.
Some commands allow the period to read to be specified.
The following dialog is used to edit this command and illustrates the syntax of the command.
Note that the output period should always use calendar month and year,
even if other than calendar year are used for output (see
SetOutputYearType.
Command Editor
The following dialog is used to edit the command and illustrates the command syntax.
SetOutputPeriod Command Editor (see also the full-size image)
Command Syntax
The command syntax is as follows:
SetOutputPeriod(Parameter="Value",...)
Command Parameters
| Parameter | Description | Default |
|---|---|---|
OutputStart |
The output period start, in a standard date/time format. The precision of this value should match that of data because it is used to iterate through the data. For example, if monthly data are being processed, specify the OutputStart using year and month. |
None – must be specified. |
OutputEnd |
The output period end, in a standard date/time format. The precision of this value should match that of data because it is used to iterate through the data. For example, if monthly data are being processed, specify the OutputStart using year and month. |
None – must be specified. |
Examples
See the automated tests.
Troubleshooting
See the main troubleshooting documentation
See Also
SetOutputYearTypecommand