axlGetSetupInfo

axlGetSetupInfo( 
t_sessionName
[ ?testName t_testName ]
) 
=> r_setupInfo / nil 

Description

Returns the setup information for the complete setup or a specific test. This includes the number of corners, sweep points, and data points in the setup.

Arguments

t_sessionName	Name of the active session
?testName t_testName
	Test name for which the setup information is to be retrieved. If the test name is not provided, the tool displays the setup information for all the tests. The default value is "".

Value Returned

r_setupInfo	The setup information containing the count of corners, sweeps, and data points is returned.
nil	Indicates an error.

Examples

Returns the setup information for the active setup:

session = axlGetWindowSession()
=> "session0"

x_mainSDB = axlGetMainSetupDB(session)
=>1001

;; display the total number of points, corners, and data points for all the corners
axlGetSetupInfo(session)
=> (nil Corners 6 SweepPoints 1 DataPoints 7)
;
;; display the number of points, corners, and data points for the AC test 
axlGetSetupInfo(session ?testName "AC")
=> (nil Corners 3 SweepPoints 1 DataPoints 3)
;
;; display the number of points, corners, and data points for the TRAN test 
x_setupInfo = axlGetSetupInfo(session ?testName "TRAN")
=> (nil Corners 3 SweepPoints 2 DataPoints 6)

;; you can use the handle to the returned struct to get the count of 
;; corners and sweep points individually as shown below.
;
x_setupInfo->Corners
=>3
;
x_setupInfo->SweepPoints
=>2
;
x_setupInfo->DataPoints
=>6

Return to top