Skip to content

TSTool / Command / SetTimeSeriesPropertiesFromTable

Overview

The SetTimeSeriesPropertiesFromTable command sets time series properties using values in a table. This is useful, for example, when additional attributes are available for locations associated with time series. The time series can then be selected for processing by matching properties with the SelectTimeSeries command.

Command Editor

The command is available in the following TSTool menu:

  • Commands(Table) / Table, Time Series Processing

The following dialog is used to edit the command and illustrates the command syntax (in this case the location part of the time series identifier is used to match the contents of the “loc” column in the table).

SetTimeSeriesPropertiesFromTable command editor

SetTimeSeriesPropertiesFromTable Command Editor (see also the full-size image)

Command Syntax

The command syntax is as follows:

SetTimeSeriesPropertiesFromTable(Parameter="Value",...)

Command Parameters

Parameter                           Description Default                     
TSList Indicates the list of time series to be processed, one of:
  • AllMatchingTSID – all time series that match the TSID (single TSID or TSID with wildcards) will be processed.
  • AllTS – all time series before the command.
  • EnsembleID – all time series in the ensemble will be processed (see the EnsembleID parameter).
  • FirstMatchingTSID – the first time series that matches the TSID (single TSID or TSID with wildcards) will be processed.
  • LastMatchingTSID – the last time series that matches the TSID (single TSID or TSID with wildcards) will be processed.
  • SelectedTS – the time series are those selected with the SelectTimeSeries command.
 AllTS
TSID The time series identifier or alias for the time series to be processed, using the * wildcard character to match multiple time series. Can be specified using ${Property}. Required if TSList=*TSID
EnsembleID The ensemble to be processed, if processing an ensemble. Can be specified using ${Property}. Required if TSList=*EnsembleID
TableID
required		 The identifier for the table that contains properties. None – must be specified.
TableTSIDColumn
required		 Table column name that is used to match the time series identifier for processing. None – must be specified.
TableTSIDFormat The specification to format the time series identifier to match the TSID column. Use the format choices and other characters to define a unique identifier. Time series alias if available, or otherwise the time series identifier.
TableInputColumns
required		 The name(s) of the column(s) to supply properties for the matching time series. Separate column names with commas. None – must be specified.
TSPropertyNames Indicate property names that should be renamed from table column names using syntax:
ColumnName1:TableProperty1,
ColumnName2:TableProperty2
The special property name ${ts:Description} will set the time series description to that of the column value.|Same asTableInputColumns`

Examples

See the automated tests.

Troubleshooting

See the main TSTool Troubleshooting documentation.

See Also