poIScalarDefine SetAverageMode

Sets the averaging mode.

Syntax

poIScalarDefine_handle SetAverageMode mode

Application

HyperView Tcl Modify

Description

This command, valid only in Upfront Data Loading Mode, sets the averaging mode for the result definition.
Note: The result definition can only be modified if it is not cached.

Inputs

mode
The averaging mode. The mode must be one of the following: “none”, “simple”, “advanced”, “difference”, “maximum”, “minimum”, “max of corner”, “min or corner” or “extreme of corner”.

Example

To set the averaging mode for a result definition to advanced:

hwi OpenStack
hwi GetSessionHandle sess
sess GetProjectHandle proj
proj GetPageHandle page [proj GetActivePage]
page GetWindowHandle win [page GetActiveWindow]
win GetClientHandle client
client GetResultHandle sdefine 4 scalar
sdefine SetAverageMode advanced
hwi CloseStack

Errors

Returns an error code if there was an error setting the averaging mode and sets error condition on the session handle. See session_handle GetError.

Related Topics

See the Upfront Data Loader APIs topic for additional information regarding the various Tcl/Tk commands that have been added for this workflow.