Skip to content

TSTool / Command / SetPropertyFromEnsemble

Overview

The SetPropertyFromEnsemble command sets the value of a processor property, using time series ensemble properties as input. 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 SetEnsembleProperty command, which sets a property on an ensemble.

Command Editor

The following dialog is used to edit the command and illustrates the command syntax.

SetPropertyFromEnsemble

SetPropertyFromEnsemble Command Editor for General Set Parameters (see also the full-size image)

Command Syntax

The command syntax is as follows:

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

Command Parameters

Parameter                           Description Default          
EnsembleID
required		 The ensemble to be processed. Can be specified using processor ${Property}. The * wildcard can be used to match an ensemble, useful for when one ensemble is being processed in a graph template command file. None - must be specified.
PropertyName
required		 The property name to set. None – must be specified.
PropertyValue
required		 The value of the property, set using a combination of text, the time series % specifiers, ${tsensemble:Property} for custom time series ensemble properties, and ${Property}. None – must be specified.

Examples

See the automated tests.

Troubleshooting

See Also