TSTool / Command / SetPropertyFromTimeSeries

Overview
Command Editor
Command Syntax
Examples
Troubleshooting
See Also

Overview

The SetPropertyFromTimeSeries command sets the value of a processor property, using:

a time series property
the time series data value (and/or flag) for a specific date/time

The property will be available to subsequent commands that support using ${Property} notation in parameters, for example to specify filenames more dynamically or use with If commands. This command should not be confused with the SetTimeSeriesProperty command, which sets a property on specific time series.

Parameters are provided to select the time series. The property name can be dynamically changed (for example by using ${Property} for the property name).

Command Editor

The command is available in the following TSTool menu:

Commands / General - Running and Properties

The following dialog is used to edit the command and illustrates the command syntax when setting a simple property value.

SetPropertyFromTimeSeries Command Editor (see full-size image)

The following illustrates the command syntax when setting a property value to time series data. For example, the Date property can be set in a For command.

SetPropertyFromTimeSeries Command Editor for Data Values (see full-size image)

Command Syntax

The command syntax is as follows:

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

Property values can be set using the Property and/or Data tabs.

Command Parameters

Tab	Parameter	Description	Default
*All*	`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 modified. `AllTS` – all time series before the command. `EnsembleID` – all time series in the ensemble will be modified. `FirstMatchingTSID` – the first time series that matches the TSID (single TSID or TSID with wildcards) will be modified. `LastMatchingTSID` – the last time series that matches the TSID (single TSID or TSID with wildcards) will be modified. `SelectedTS` – the time series are those selected with the `SelectTimeSeries` command.	`AllTS`
	`TSID`	The time series identifier or alias for the time series to process, using the `*` wildcard character to match multiple time series. Can be specified using processor `${Property}.`	Required if `TSList=*TSID`
	`EnsembleID`	The ensemble to be modified, if processing an ensemble. Can be specified using processor `${Property}`.	Required if `TSList= EnsembleID`
*Property*	`PropertyName` required	The property name. Can be specified using a combination of literal text, `${Property}`, `%` specifiers, and `${ts:Property}`.	None – must be specified.
	`PropertyValue` required	The value of the property, set using a combination of text, the time series `%` specifiers, `${ts:Property}` for custom time series properties, and `${Property}`.	None – must be specified.
*Property*	`DateTime` required	The date/time for which to retrieve time series data. Can be specified using `${Property}` syntax.	None – must be specified when using data.
	`PropertyName` `ForValue` required	The property name for the data value.	None – must be specified when using data.
	`PropertyName` `ForFlag`	The property name for the data flag.

Examples

See the automated tests.

Troubleshooting

See the main TSTool Troubleshooting documentation.