poISubcase GetSyncValue

Returns the simulation sync value corresponding to the passed index.

Syntax

subcase_handle GetSyncValueindex

Application

HyperView Tcl Query

Description

This command returns the sync value for the index specified. The sync value that is returned is usually the time step, or frequency value, at which the results are computed.

Inputs

index: The simulation index.

Example

To get the simulation sync value:

hwi OpenStack
hwi GetSessionHandle session_handle
session_handle GetProjectHandle project_handle
project_handle GetPageHandle page_handle [project_handle GetActivePage]
page_handle GetWindowHandle window_handle [page_handle GetActiveWindow]
window_handle GetClientHandle client_handle
client_handle GetModelHandle model_handle [client_handle GetActiveModel]
model_handle GetResultCtrlHandle result_handle
result_handle GetSubcaseHandle subcase_handle 1

# Get the sync value for index 2
set sync_val [subcase_handle GetSyncValue 2]
hwi CloseStack

Errors

Returns 0 if an invalid index is specified.