axlGetRunStatus

axlGetRunStatus( 
t_sessionName
[ ?optionName t_optionName ]
[ ?historyName t_historyName ]
) 
=> l_statusValues

Description

Returns the completion status in terms of the number of points, tests, or corners completed for all histories running in the given session or for the specified history.

Arguments

t_sessionName	Name of the session
?optionName t_optionName
	A value that specifies the elements for which the status value is to be returned. Valid values are: all: Returns the number of points for which simulation is complete and the total number of points. Tests: Returns the number of tests for which simulation is complete and the total number of tests. Corners: Returns number of corners for which simulation is complete and the total number of corners. Default value: all
?historyName t_historyName
	Name of the history item for which the status is to be returned. The default value is "" If this argument is not provided, the tool returns the completion status for the given session. In this case, the total number of points, tests, or corners in the returned value is the total number of points, tests, or corners run across all the histories running in the given session.

Value Returned

l_statusValues

The returned list contains the following two values: The number of points, tests, or corners completed The total number of points, tests, or corners to be run in the given session

Examples

The following example code shows how the completion status for a simulation run is returned:

axlSession=axlGetWindowSession( hiGetCurrentWindow()) 
=> "session0"
axlGetRunStatus("session0")
=> (4 14)
; The returned value suggests that out of the total 14 points to be run in the session session0, simulations are complete for 4 points.
;
axlGetRunStatus("session0" ?historyName "Interactive.10" ?optionName "tests")
=> (1 2)
; The returned value suggests that out of the total two tests in the Interactive.10 history of session0, simulations are complete for one test.
;
axlGetRunStatus("session0" ?historyName "Interactive.10" ?optionName "corners")
=> (4 8)
; The returned value suggests that out of the total eight corners to be run in the Interactive.10 history of session0, simulations are complete for four corners.

Related Topics

Starting a Simulation

Return to top