axlGetRunData

axlGetRunData( 
t_sessionName 
x_runID 
) 
=> x_historyHandle / nil 

Description

Returns the handle to the history obtained after running a simulation in the given session. You can use this handle to get access to the history results or to get setup details by using the history checkpoint.

Arguments

t_sessionName	Name of the session or a handle to it.
x_runID	Unique run ID obtained after running a simulation.

Value Returned

x_historyHandle	Handle to the history of the simulation run.
nil	The command could not be run.

Example

The following example shows how to get the history handle and use it to work with the results:

session=axlGetWindowSession()
=> "session0"

runid=axlRunSimulation(?session session)
=> 0
; here, 0 is the run ID

x_historyHandle=axlGetRunData(session 0)
=> 3234

; you can use this history handle to get the details of history or to get results

t_historyName=axlGetHistoryName(x_historyHandle)
=> "Interactive.20"

; the following function call loads the results for the history in the GUI

axlViewHistoryResults(session x_historyHandle)

; the history name can be used to access the results by using SKILL code, as shown below.

rdbObj=axlReadHistoryResDB(t_historyName ?session session)
=>axlrdb@0x1949a418

; This results data object can be used to access different elements from the results database for that history. 

Related Topics

axlReadResDB

Return to top