TSTool - Laserfiche WebLink

Home Browse Search

TSTooI Documentation 1. The parameter names are included in the command, in order to make the command more readable. 2. Because the parameter name is included, the parameters can generally be in any order. The command editor dialogs will enforce a default older. 3. Parameters that have default values can be omitted from the parameter list, shortening commands. 4. New parameters can be added over time, without requiring parameter order to change in existing commands. The above notation is being used for new commands and older commands are being updated to the new syntax as time allows. Command editor dialogs will update old commands to the new syntax and the processing code will recognize old and new command syntax. The Command Reference illustrates the current command syntax. The following sequence occurs when processing commands: 1. Parse the command. A time series identifier or command is parsed to determine how to execute the command. Example commands are shown below. If the command is a general command, the action is taken and a new command is read in step 1 (general commands can be specified multiple times to change properties throughout a run). If the command results in reading or creating a time series, steps 2 - 4 are executed. If a command is a time series manipulation command, step 4 is executed. # Example commands 08235350.USGS.Streamflow.Month»HydroBase 08236000.USGS.Streamflow.Month-HydroBase add(08235350.USGS.Streamflow.Month,IgnoreMissing,08236000.DWR.Streamflow.Month) 08235350.USGS.Streamflow.Month-HydroBase 2. Read Time Series. TSTooI recognizes that certain commands should read a new time series and will perform the appropriate action. For example, in the above example, the time series identifier 0 8 2 3 5 3 5 0. USGS . S t re amf 1 ow . Month~HydroBa s e indicates that the corresponding time series should be read from a HydroBase database (and since the full identifier is specified, no alias is assigned). The identifier input type is used to determine how to read the time series. Unless the setQueryPeriod () command has been used, the entire time series period is read in this step because data filling steps may require the full period (e.g., to determine regression relationships or long-term monthly average). Commands that do not cause a time series to be read (but instead to be manipulated) are described in step 4. If the input type, and if needed, input name, are specified in the identifier, they are only used in the initial read. Additional manipulation commands only use the first five parts of the identifier or the time series alias to identify the time series. If the same time series needs to be read from two input types (e.g., to compare whether a time series was properly loaded into a database from a file), use a different time series alias for each time series to uniquely identify each time series. At the end of this step, a new time series will exist in memory. 3. Compute Data Limits. The time series data limits are computed because they may be needed later for filling. This information includes the long-term monthly averages. These limits are referred to as the original data limits. 4. Access and Manipulate Time Series. Commands that manipulate time series (fill, add, etc.) do not read the time series or make another copy. Instead, time series that are in memory are located and Introduction - 6