Skip to content

TSTool / Command / WriteTimeSeriesPropertiesToFile

Overview

The WriteTimeSeriesPropertiesToFile command writes the value of time series properties to a file. This command should not be confused with the WritePropertiesToFile command, which writes processor properties. This command is useful for testing whether properties are being set. It can also be used to pass information from TSTool to another program.

A number of property formats are supported as listed in the following table.

Property File Formats

Format                              Description
NameValue Simple format, all properties handled as text:

PropertyName=PropertyValue
PropertyName="Property value, quoted if necessary"
NameTypeValue Same as NameValue format, with non-primitive objects treated as simple constructors:

PropertyName=PropertyValue
DateTimeProperty=DateTime("2010-10-01 12:30")
NameTypeValuePython Similar to the NameTypeValue format; however, objects are represented using “Pythonic” notation, to allow the file to be used directly by Python scripts:

PropertyName="PropertyValue"
DateTimeProperty=DateTime(2010,10,1,12,30)

Command Editor

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

WriteTimeSeriesPropertiesToFile

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

Command Syntax

The command syntax is as follows:

WriteTimeSeriesPropertiesToFile(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
OutputFile
required		 The property file to write, as an absolute path or relative to the command file, can use ${Property}. None - must be specified.
IncludeProperties The names of properties to write, separated by commas. The * wildcard can be used to indicate multiple properties. If not specified, all processor properties will be written.
WriteMode Indicates how the file should be written:
  • Append – append the properties to the file without checking for matches (create the file if it does not exist)
  • Overwrite – overwrite the properties file
  • Update – update the properties in the file by first checking for matching property names (which will be updated) and then appending unmatched properties (not yet implemented)
 Overwrite
FileFormat Format of the properties file (see descriptions in the above Property File Formats table):
  • NameValue
  • NameTypeValue
  • NameTypeValuePython
 NameValue
SortOrder The order to sort properties:
  • Ascending
  • Descending
  • None
 None – order depends on order in processor.

Examples

See the automated tests.

Troubleshooting

See Also