Laserfiche WebLink
TSTool Documentation <br />Introduction - 10 <br />2.6 Time Series Commands and Processing Sequence <br /> <br />Although TSTool can be run in batch mode (see Chapter 3 – Getting Started ), it is possible t o perform <br />all time series viewing and ma nipulation within the GUI. Commands are used to read, manipulate, and <br />output time series. Commands are processed sequentially from the first to the last commands using the <br />steps described below. This section describes in detail the processing sequence. See the examples in <br />Chapter 6 – Examples of Use for illustrations of the processing sequence. <br /> <br />TSTool commands fall into several categories: <br /> <br />1. Time series identifiers (see Section 2.2 – Time Series Objects and Identifiers ), which are <br />equivalent to time ser ies “read” commands (where the identifier input type or datastore is used to <br />determine how to read from the original data format) <br />2. General commands, which are used to set propert ies like the period for output <br />3. Time series commands, which are used to read and manipulate time series and output results <br />4. Ensemble commands, which process ensembles of time series, <br />5. Table commands, which process tables of information . <br /> <br />Commands are processed sequentially and can be repeated as necessary. A typical user starts learnin g <br />TSTool by performing simple queries and displaying results while gradually utilizing more commands. <br />C ommand syntax is as follows: <br /> <br />C ommand(P aram1=V alue1,P aram2=”V alue”,…) <br /> <br />Values that may contain spaces or commas are normally surrounded by double quotes . This notation is <br />useful for the following reasons: <br /> <br />• The parameter names are included in the command, which make s the command more readable as <br />text . <br />• Because the parameter name is included, the parameters can be in any order. The command <br />editor dialogs w ill enforce a default older. <br />• Parameters that have default values can be omitted from the parameter list, shortening commands. <br />• New parameters can be added over time, without requiring parameter order to change in existing <br />commands. <br /> <br />O lder commands used a fi xed notation where parameters were required to be in a specific order. TSTool <br />will attempt to update older command syntax to the current syntax when a command file is read. The <br />Command Reference describes each command ’s function and parameters . <br /> <br />The foll owing sequence occurs when processing commands: <br /> <br />1. Check the command for run -time initialization errors . Commands initially are parsed when a <br />command file is opened or new commands are added in the GUI. When commands are run, <br />additional checks are perform ed based on run -time data, such as the period that has been specified <br />for the run. Example commands are shown below. If the command results in reading or creating <br />a time series, step 3 is executed , as described below . <br /> <br /># Example commands 08235350.USGS.S treamflow.Month~HydroBase <br />08236000.DWR .Streamflow.Month~HydroBase <br />A dd(TSID=”08235350.USGS.Streamflow.Month ”,HandleMissingHow=IgnoreMissing, <br /> TSList=SpecifiedTSID,AddTSID=”08236000.DWR.Streamflow.Month ”) <br />22