TSTool / Command / ReadNwsrfsFS5Files
Overview
The ReadNwsrfsFS5Files command reads a single time series from an NWSRFS FS5Files database
(see the NWSRFS FS5Files Input Type Appendix) and assigns an alias to the result.
Command Editor
The command is available in the following TSTool menu:
- Commands / Read Time Series
The following dialog is used to edit the command and illustrates the syntax:
ReadNwsrfsFS5Files Command Editor (see full-size image)
Command Syntax
The command syntax is as follows:
ReadNwsrfsFS5Files(Parameter="Value",...)
Command Parameters
| Parameter | Description | Default |
|---|---|---|
TSID |
A time series identifier to read – see the NWSRFS FS5Files Input Type Appendix. The input name for the time series identifier will agree with how the NWSRFS FS5Files were specified. For example if Apps Defaults are used, the input name will be omitted. If a directory is specified, it can be an absolute path or can be relative to the working directory (location of the command file). | |
Alias |
The alias to assign to the time series, as a literal string or using the special formatting characters listed by the command editor. The alias is a short identifier used by other commands to locate time series for processing, as an alternative to the time series identifier (TSID). | None – must be specified. |
InputStart |
The start of the period to read data – specify if the period should be different from the global query period. | Use the global query period. |
InputEnd |
The end of the period to read data – specify if the period should be different from the global query period. | Use the global query period. |
Units |
The data units to be returned. The units must be specified compatible with the database units to allow for the conversion. | Use the database units, which typically are SI units. |
Examples
See the automated tests.
A sample command file is as follows:
ReadNwsrfsFS5Files(Alias=”x”,TSID="DWRI1IU.NWSRFS.MAP.6Hour~NWSRFS_FS5Files~Data_BPA",Units="IN")
Troubleshooting
See the main TSTool Troubleshooting documentation.