Skip to content

TSTool / Command / SetAveragePeriod

Overview

The SetAveragePeriod command sets the period that is used to compute historic averages used with the FillHistMonthAverage and FillHistYearAverage commands. If the averaging period is not specified, the available period is used. Use a SetAveragePeriod command if a subset of the data should be used to compute averages.

Commands that are concerned with this issue also typically provide a parameter. Setting a global default with this command can make it more difficult to understand processing.

Command Editor

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

SetAveragePeriod

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

Command Syntax

The command syntax is as follows:

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

Command Parameters

Parameter            Description Default                           
[AverageStart
required		 The date for the start of the averaging period. The precision of the date should agree with that of time series to be processed, and is limited to monthly and yearly precision. None – must be specified.
[AverageEnd
required		 The date for the end of the averaging period. The precision of the date should agree with that of time series to be processed, and is limited to monthly and yearly precision. None – must be specified.

Examples

See the automated tests.

Troubleshooting

See Also