poISubcase GetSimulationLabel

Returns the simulation label corresponding to the index.

Syntax

subcase_handle GetSimulationLabel index

Application

HyperView Tcl Query

Description

This command returns the simulation label for the index specified. The returned label is a string which is similar to the one seen in the loadcase dialog.

Inputs

index: The simulation index (which starts from 0).

Example

To get the simulation label:

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 simulation label for index 2
set sim_lab [subcase_handle GetSimulationLabel 2]
hwi CloseStack

Errors

Returns a null string if an invalid index is specified.