poITensorDefine SetDataComponent

Sets the data component of the result definition.

Syntax

poITensorDefine_handle SetDataComponent comp

Application

HyperView Tcl Modify

Description

This command, valid only in Upfront Data Loading Mode, sets the data component for the result definition. Returns Success (0) or an error code.
Note: The result definition can only be modified if it is not cached.

Inputs

comp
The data component as a space separated list of valid component values depending on the tensor format type:
  • "Principal" - Valid values are "Major", "Mid", "Minor", "full" (equivalent to "Major Mid Minor").
  • "Component" - Valid values are "xx”, “yy”, “zz”, “xy”, “yx”, “yz”, “zy”, “zx”, “xz”, “all” (equivalent to “xx yy zz”), “full” (equivalent to “xx yy zz xy yz zx”).

Example

To set the data component of a tensor result definition to "Major Minor":

hwi OpenStack
hwi GetSessionHandle sess
sess GetProjectHandle proj
proj GetPageHandle page [proj GetActivePage]
page GetWindowHandle win [page GetActiveWindow]
win GetClientHandle client
client GetResultHandle tdefine 3 tensor
tdefine SetFormat principal
tdefine SetDataComponent "Major Minor"
hwi CloseStack

Errors

Returns an error code if there was an error setting the data component 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.