Actions

Actions can be used to automate many IC-CAP dialog buttons and menu picks. The following tables cross-reference GUI buttons or menu picks to their corresponding actions.

Table 100 Hardware Setup Window Cross-Reference  

Button/Menu Pick	Action
Add Interface	Add Interface File
Add to List	Add Active Instr
Configure > Instrument Address	Change Address
Delete	Delete Active Instr
DeleteAll	Clear Active List
Delete Interface	Delete Interface File
File > Close Window	Close Hardware
File > Open	Read from File
File > Save	Write to File
Instruments > Display	Display Found Instrs
Instruments > Find	Search for Instruments
Instruments > Self Test	Run Self-Tests
Instruments > Usage	Diagnostics
Instruments > Zero Sources	Disable Supplies
Rebuild	Rebuild Active List
Tools > Address > Check	Check Active Address
Tools > Address > Listen	Listen Active Address
Tools > Address > Set	Set Active Address
Tools > Address > Talk	Talk Active Address
Tools > Address > Who Are You?	Who Are You
Tools > Interface > Change	Change Interface File
Tools > Interface > Lock	I-O_Lock
Tools > Interface > Reset	I-O_Reset
Tools > Interface > Status	Bus status
Tools > Interface > Unlock	I-O_Unlock
Tools > Macros > Execute	Macro File Execute
Tools > Macros > Specify	Macro File Specify
Tools > Send Receive > Display String	Print Read Buffer
Tools > Send Receive > Read String for Experts	Read String for Experts
Tools > Send Receive > Receive String	Read String
Tools > Send Receive > Send Byte	Send Command Byte
Tools > Send Receive > Send Receive Display	Send, Receive, and Print
Tools > Send Receive > Send String	Send String
Tools > Serial Poll	Serial Poll
Tools > Settings > Timeout	Set Timeout
View > Screen Debug	I-O_Screen Debug OFF I-O_Screen Debug ON

Table 101 License Status Cross-Reference  

Button/Menu Pick	Action
OK	Close License Window
Release	Release License

Table 102 Main Window Cross-Reference  

Button/Menu Pick	Action
File > Change Directory	Change Directory
Edit > Copy	Copy
Edit > Delete	Delete
File > Edit	Edit
File > Exit	Exit/Exit!
File > New	New Model
File > Open	Open Model
File > Save As	Save All Save All No Data
Tools > Hardware Setup	Open Hardware
Tools > License Status	License Status
Tools > Options > Diagnostics	Diagnostics
Tools > Options > File Debug	File Debug On File/Screen Debug Off
Tools > Options > Screen Debug	File/Screen Debug Off Screen Debug On
Tools > Simulation Debugger	Simulation Debugger
Tools > Stop Simulator	Stop Simulator
Windows > Status Window	Status Window

Table 103 Model Window Cross-Reference  

Button/Menu Pick	Action
Circuit folder, Import Text	Import Text
Circuit folder, Parse	Parse
Data > Plots > Display All	Display Plots
Duts/Setups folder, Add	New DUT New Setup
DUTs/Setups, Extract/Optimize folder, Algorithm	Set Algorithm
DUTs/Setups, Extract/Optimize folder, Error	Set Error
DUTs/Setups, Extract/Optimize folder, Execute	Execute
DUTs/Setups, Extract/Optimize folder, Recall Par	Recall Parameters
DUTs/Setups, Extract/Optimize folder, Store Par	Store Parameters
DUTs/Setups, Extract/Optimize folder, Tune Fast	Tune Fast
DUTs/Setups, Extract/Optimize folder, Tune Slow	Tune Slow
DUTs/Setups, Extract/Optimize folder, Undo Optim	Undo Optim
DUTs/Setups, Extract/Optimize, Parameters folder, Autoset	Auto Set Min Max
DUTs/Setups, Extract/Optimize, Parameters folder, Clear Table	Clear Table or Clear Parameter Table
DUTs/Setups, Extract/Optimize, Parameters folder, Reset	Reset Min Max
DUTs/Setups, Instrument Options folder	Set Instrument Option Value
DUTs/Setups, Measure/Simulate folder, Calibrate	Calibrate
DUTs/Setups, Measure/Simulate folder, Clear > Measured, Simulated or Both Measured Simulated	Clear Data/Simulated/Measured/Both
DUTs/Setups, Measure/Simulate folder, Export Data	Export Data Measured Export Data Simulated
DUTs/Setups, Measure/Simulate folder, Import Create	Import Create Import Create Header Only Import Create Measured Import Create Measured or Simulated Import Create Simulated Import Create Simulated or Measured
DUTs/Setups, Measure/Simulate folder, Measure	Measure
DUTs/Setups, Measure/Simulate folder, Simulate	Simulate
DUTs/Setups, Measure/Simulate folder, View	View
DUTs/Setups, Measure/Simulate and Plots folder	Set Table Field Value
DUTs/Setups, Measure/Simulate folder, Input or Output, View, Dump to Stdout	Dump To Stdout
DUTs/Setups, Measure/Simulate folder, Input or Output, View, Print	Dump To Plotter Dump To Printer Dump Via Server Send To Printer
DUTs/Setups, Measure/Simulate, Setup Variables folder, System Variables	Create Variable Table Variable
DUTs/Setups, Setup Variables folder	Set Variable Table Value
DUTs/Setups, Plots folder, Display Plot	Display Plot
DUTs/Setups, Plots folder, Display Plots	Display Plots
Edit > Cut Setup/Input	Import Delete
Extract > Active Setup or Active DUT	Extract
File > Close	Close All
File > Export Data	Export Dataset
File > Export Data > Extracted Deck	Save Extracted Deck
File > Import Data	Import Data Import Measured Data Import Measured or Simulated Data Import Simulated Data Import Simulated or Measured Data
File > Open	Open Open DUT Open Setup ReadOnlyValues
File > Open (Input, Output, Transform, or Plot level selection)	Open Input/Output/Transform/Plot
File > Open (for Macro)	Open Macro
File > Print, (various dialogs) > Print	Print Via Server
File > Save As	Save As Save As No Data
Macro folder, New	New Macro
Model Parameters folder, Memory Recall	Memory Recall
Model Parameters folder, Memory Store	Memory Store
Model Parameters folder, Reset	Reset
Optimize > Active Setup or Active DUT	Optimize
Tools > Plot Optimizer	Open Plot Optimizer
Tools > Refresh Last Dataset	Refresh Dataset
(various locations) > New	New Input/Output/Transform/Plot

Table 104 Plot Optimizer Window Cross-Reference  

Button/Menu Pick	Action
Algorithm	Set Algorithm
Parameters folder, Clear Table	Clear Table or Clear Parameter Table
Error	Set Error
Options folder, Print Settings	Dump To Plotter Dump To Printer Dump Via Server Send To Printer
File > Clear Plot Optimizer	Clear Plot Optimizer
File > Reset Option Table	Reset Option Table
File > Close	Close
Optimize > Tune Fast	Tune Fast
Optimize > Tune Slow	Tune Slow
Tools > Undo Optim	Undo Optim
Plots > Disable All	Disable All
Plots > Enable All	Enable All
Simulate > plot name	Simulate Plot Inputs
Simulate > Simulate All	Simulate All
Tools > AutoSet Min and Max	Auto Set Min Max
Tools > Recall Parameters	Recall Parameters
Tools > Reset Min and Max	Reset Min Max
Tools > Store Parameters	Store Parameters

Table 105 Plots Window Cross-Reference  

Button/Menu Pick	Action
File > Close	Close
File > Print	Dump Via Server UI
File > Save Image	Save Image
Optimizer > Autoconfigure and Enable	Autoconfigure or Autoconfigure And Enable
Optimizer > Disable All Traces	Disable All Traces
Optimizer > Enable/Disable Plot	Disable Plot Enable Plot
Optimizer > Global Region > Delete All	Delete Global Regions
Optimizer > Global Region > Reset	Reset Global Region
Optimizer > Open Optimizer	Open Plot Optimizer
Optimizer > trace > Disable	Disable Trace
Optimizer > trace > Set as Both Target and Simulated	Set Trace As Both
Optimizer > trace > Set as Target vs.	Set Target Vs Simulated
Optimizer > trace > Trace Optimizer Region > Add	Add Trace Region
Optimizer > trace > Trace Optimizer Region > DeleteAll	Delete Trace Regions
Optimizer > trace > Trace Optimizer Region > Reset	Reset Trace Region
Options > Autoscale	Autoscale
Options > Copy to Clipboard	Copy to Clipboard
Options > Copy to Variables	Copy to Variables
Options > Draw Diag Line	Draw Diag Line
Options > Edit Definition	Edit
Options > Error > Select Error Region	Select Error Region
Options > Error > Select Whole Plot	Select Whole Plot
Options > Error > Show Absolute Error	Show Absolute Error
Options > Error > Show Relative Error	Show Relative Error
Options > Manual rescale	Manual Rescale Scale Plot/Scale Plot Preview Scale RI Plot/Scale RI Plot Preview
Options > Replot	Replot
Options > Rescale	Rescale
Options > Session Settings > Area Tools	Area Tools
Options > Session Settings > Color	Color
Options > Session Settings > Exchange Black-White	Exchange Black-White
Options > Session Settings > Footer	Footer
Options > Session Settings > Header	Header
Options > Session Settings > Legend	Legend
Options > Session Settings > Reset to Saved Options	Reset to Saved Options
Options > Session Settings > Text Annotation	Text Annotation
Options > Update Annotation	Update Annotation
Plots > Full Page Plot	Full Page Plot
Plots > Select Plot	Select Plot
Plots > Undo Zoom	Undo Zoom
Plots > Unselect All	Unselect All
Plots > Zoom Plot	Zoom Plot

Table 106 Simulation Debugger Window Cross-Reference  

Button/Menu Pick	Action
File > Close	Close
File > Manual Simulation	Manual Simulation
File > Save Command File File > Save Input File File > Save Output File	Save Input/Command/Output File

Table 107 Status Window Cross-Reference  

Button/Menu Pick	Action
File > Clear > Errors	Clear Status Errors
File > Clear > Outputs	Clear Status Output
File > Close Error Log	Close Error Log
File > Close Output Log	Close Output Log
File > Open Error Log	Open Error Log
File > Open Output Log	Open Output Log

Table 108 System GUI Items Cross-Reference  

Button/Menu Pick	Action
Add, Add Child	Add GUI
Close GUI	Close GUI
Close Single GUI	Close Single GUI
Destroy GUI	Destroy GUI
Destroy Single GUI	Destroy Single GUI
Display Modal GUI	Display Modal GUI
Display Modeless GUI	Display Modeless GUI
Display Single Modal GUI	Display Single Modal GUI
Display Single Modeless GUI	Display Single Modeless GUI
Set GUI Callbacks	Set GUI Callbacks
Set GUI Options	Set GUI Options

Add Active Instr

Automates the functionality of the "Add to List" button in the Hardware Setup window's Instrument Library field.

Valid Objects

Hardware

menu_func style command: "Add Active Instr"

Adds the instrument selected in the Instrument Library to the Instrument List. To execute this function manually, the user selects an instrument from the Instrument Library, then presses the "Add to List" button. This functionality is emulated in PEL by appending the instrument to be added in the format:

"library name.select code.address"

followed by "ok" to the end of the command string.

Where

library name is the instrument model number exactly as it is listed in the Instrument Library.
select code is the bus address (in decimal notation) of the GPIB card.
address is the address (in decimal notation) of instrument, as set on the instrument itself.

Example

 iccap_func("Hardware","Add Active Instr","HP8510.7.16","ok")

Add Global Region

Automates the Optimizer > Global Region > Add menu pick in a plot window.

Valid Objects

Plot

menu_func style command: none

Adds a global trace region without deleting existing global trace regions.

Example

 iccap_func("./dc/fgummel/ibicvsve", "AddGlobalRegion",
            "0.6", "0.8", "-8", "-3")
 ! Specify plot number for Multiplot
 iccap_func("./dc/fgummel/my_multiplot", "AddGlobalRegion",
            "0.6", "0.8", "-8", "-3", "1")

See Also

Delete Global Regions

Add GUI

Automates the functionality of the "Add" and "Add Child" buttons in the System GUI Items window.

Valid Objects

GUI Item

menu_func style command: none

Adds Items to a GUI Items page or another GUI Item. You must specify the Item's name and type code. To see the codes for all Item types, select the Show Codes button on the Properties dialog of a GUI Item.

Example

 iccap_func("./GUIItems","Add GUI","ANewTable","TL")
 iccap_func("./ANewTable","Add GUI","Button","PB")

See Also

Close GUI, Close Single GUI, Destroy GUI, Destroy Single GUI, Display Modal GUI, Display Modeless GUI, Display Single Modal GUI, Display Single Modeless GUI, Set GUI Callbacks, Set GUI Options

Add Interface File

Automates the functionality of the "Add Interface" button in the Hardware Setup window's GPIB Interface field.

Valid Objects

Hardware

menu_func style command: "Add Active Interface"

Adds a GPIB Interface to the system. If this function were executed manually, a dialog box would appear asking the user for the name of the interface to be added. This functionality is emulated in PEL by appending the interface to be added followed by "ok" to the end of the command string.

Example

 iccap_func("Hardware","Add Interface File","hpib","ok")

Add Trace Region

Automates the Optimizer > trace > Trace Optimizer Region > Add menu pick in a plot window.

Valid Objects

Plot

menu_func style command: none

Adds a trace optimizer region for the specified trace without deleting existing trace optimizer regions.

Example

 iccap_func("./dc/fgummel/ibicvsve", "AddTraceRegion", 
           "Y Data 0", "0.6", "0.8", "-8", "-3")
 iccap_func("./dc/fgummel/bvsic", "AddTraceRegion", 
           "Y Data 0", "1e-8", "1e-4", "20", "60")
 ! Specify plot number for Multiplot
 iccap_func("./dc/fgummel/my_multiplot", "AddTraceRegion",
            "Y Data 0", "1e-8", "1e-4", "20", "60", "1")

See Also

Delete Trace Regions

Area Tools

Automates the Options > Session Settings > Area Tools menu pick in a plot window.

Valid Objects

Plot

menu_func style command: none

Toggles the Area Tools on and off for the specified plot window.

Example

 iccap_func("./dc/fgummel/bvsic", "AreaTools")
 ! Specify plot number for Multiplot
 iccap_func("./dc/fgummel/my_multiplot", "AreaTools", "1")
 ! Apply to all plots in a Multiplot
 iccap_func("./dc/fgummel/my_multiplot", "AreaTools") 

See Also

Area Tools Off, Area Tools On

Area Tools Off

Hides the Area Tools for the specified plot window.

Valid Objects

Plot

menu_func style command: none

Example

 iccap_func("./dc/fgummel/bvsic", "AreaToolsOff")
 ! Specify plot number for Multiplot
 iccap_func("./dc/fgummel/my_multiplot", "AreaToolsOff", "1")
 ! Apply to all plots in a Multiplot
 iccap_func("./dc/fgummel/my_multiplot", "AreaToolsOff") 

See Also

Area Tools, Area Tools On

Area Tools On

Displays the Area Tools for the specified plot window.

Valid Objects

Plot

menu_func style command: none

Example

 iccap_func("./dc/fgummel/bvsic", "AreaToolsOn")
 ! Specify plot number for Multiplot
 iccap_func("./dc/fgummel/my_multiplot", "AreaToolsOn", "1")
 ! Apply to all plots in a Multiplot
 iccap_func("./dc/fgummel/my_multiplot", "AreaToolsOn") 

See Also

Area Tools, Area Tools Off

Autoconfigure or Autoconfigure And Enable

Automates the Optimizer > Autoconfigure and Enable menu pick in a plot window

Valid Objects

Plot

menu_func style command: none

Automatically enables and configures the inputs in a Plot window.

Example

 iccap_func("dc/fgummel/icibvsve", "Autoconfigure")
 iccap_func("dc/fgummel/icibvsve", "AutoconfigureAndEnable")
 ! Specify plot number for Multiplot
 iccap_func("dc/fgummel/my_multiplot", "Autoconfigure", "1")
 ! Apply to all plots in a Multiplot
 iccap_func("dc/fgummel/my_multiplot", "Autoconfigure")

Autoscale

Automates the Options > Autoscale menu pick in a plot window

Valid Objects

Plot

menu_func style command: "Replot Data"

Toggles whether the plot automatically rescales when the data changes.

Example

 iccap_func("/CGaas1/dc/igvg_0vs/vs/ig_vs_vg", "Autoscale")
 ! Specify plot number for Multiplot
 iccap_func("/CGaas1/dc/igvg/my_multiplot", "Autoscale", "1")
 ! Apply to all plots in a Multiplot
 iccap_func("/CGaas1/dc/igvg/my_multiplot", "Autoscale")

Auto Set Min Max

Automates the Tools > AutoSet Min Max menu pick in the Plot Optimizer window and the Auto Set button in the Extract/Optimize folder.

Valid Objects

Transform, Plot Optimizer

menu_func style command: none

Sets minimum and maximum optimizer parameter values based on the value of the coefficient defined with the AUTOSET_COEFF variable. The default coefficient value is 5.

Example

 iccap_func("./CGaas1/dc/igvg_0vs","Auto Set Min Max")
 iccap_func("./PlotOptimizer","Auto Set Min Max")

Auto Set Optimize or Auto Set And Optimize

Automates the Optimizer > Autoset Min/Max and Optimize menu pick in the Plot Optimizer window.

Valid Objects

Plot Optimizer

menu_func style command: none

Sets minimum and maximum optimizer parameter values based on the value of the coefficient defined with the AUTOSET_COEFF variable then runs an optimization. The default coefficient value is 5.

Example

 iccap_func("./PlotOptimizer","AutoSetAndOptimize")

Bus status

Automates the functionality of the "Tools/Interface/Status" menu pick in the Hardware Setup window.

Valid Objects

Hardware/HPIBAnalyzer

menu_func style command: "Bus status"

Provides information on the status of the current interface including:

This information is displayed in the IC-CAP/Status window and, if visible, the Hardware Setup window.

Example

 iccap_func("Hardware/HPIBAnalyzer","Bus status")

Calibrate

Automates the Measure/Simulate folder's Calibrate button.

Valid Objects

Setup

menu_func style command: "Calibrate"

Performs calibration on the specified setup

Example

 iccap_func("CGaas1/dc/igvg_0vs","Calibrate")

Change Address

Automates the functionality of the Instrument Address spin box in the dialog box displayed by the Configure button in the Instrument List in the Hardware Setup window.

Valid Objects

Hardware

menu_func style command: "Change Address"

Sets the address of the specified instrument. If this function were executed manually, the desired new address would be read from the spin box in the Configuration Dialog Box when the OK button was pushed. This functionality is emulated in PEL by appending the old GPIB name string in the format:

 "library name.select code.address"

followed by "ok" and the new desired address followed by "ok" to the end of the command string.

Example

 iccap_func("Hardware","Change Address",
           "HP3577.7.18","ok","19","ok")

Change Directory

Automates IC-CAP/Main File > Change Directory

Valid Objects

IC-CAP

menu_func style command: "Utilities/Change Directory"

Prompts for the name of a new directory to use as the current working directory. The directory prompt can be anticipated by the third argument.

Example

 iccap_func("ic-cap","Change Directory",
            "/users/me/my_other_work_dir")

Change Interface File

Automates the functionality of the Tools > Interface > Change menu pick in the Hardware Setup window.

Valid Objects

Hardware/HPIBAnalyzer

menu_func style command: "Change Interface File"

Changes the currently active GPIB interface. All further commands of the GPIB Analyzer will be directed to this new interface. If this function were executed manually, a dialog box would appear asking the user for the name of the new interface. This functionality is emulated in PEL by appending the name of the new interface followed by "ok" to the end of the command string.

Example

 iccap_func("Hardware/HPIBAnalyzer","Change Interface File",
           "new_name","ok")

Check Active Address

Automates the functionality of the Tools > Address > Check menu pick in the Hardware Setup window.

Valid Objects

Hardware/HPIBAnalyzer

menu_func style command: "Check Active Address"

This function sends a serial poll to the device at the currently active address as previously set by a call to "Set Active Address." The result is displayed in the IC-CAP/Status window and, if visible, the Hardware Setup window.

Example

 iccap_func("Hardware/HPIBAnalyzer","Set Active Address",
           "8","ok")
 iccap_func("Hardware/HPIBAnalyzer","Check Active Address")

Clear Active List

Automates the functionality of the DeleteAll button in the Hardware Setup window's Instrument List field.

Valid Objects

Hardware

menu_func style command: "Clear Active List"

Removes all instruments in all setups from the Active Instrument List.

Example

 iccap_func("Hardware","Clear Active List")

Clear Data/Simulated/Measured/Both

Automates the Model Window's Data > Clear Active Setup Data functionality or the Clear button in the Measure/Simulate folder.

Valid Objects

Model, DUT, Setup

menu_func style commands were the same.

Clears the specified type of data from the outputs and transforms of the named Model, named DUT, or named setup.

Examples

 iccap_func("/CGaas1/dc/igvg_0vs","Clear Data/Simulated")
 iccap_func("/CGaas1/dc","Clear Data/Measured")
 iccap_func("/CGaas1","Clear Data/Both")

Clear Plot Optimizer

Automates the File > Clear Plot Optimizer menu pick in the Plot Optimizer window.

Valid Objects

Plot Optimizer

menu_func style command: none

Disables all traces and regions in the plots, disables all open plots, and clears the Parameters table.

Example

 iccap_func("./PlotOptimizer","Clear Plot Optimizer")

See Also

Clear Table or Clear Parameter Table

Clear Status Errors

Clears Status window's Warnings/Errors.

Valid Objects

IC-CAP

menu_func style command: none

Example

 iccap_func("/","Clear Status Errors") 

Clear Status Output

Clears Status window's IC-CAP Output.

Valid Objects

IC-CAP

menu_func style command: none

Example

 iccap_func("/","Clear Status Output") 

Clear Table or Clear Parameter Table

Automates the Clear Table button on the Parameter folder in the Plot Optimizer window and in the Extract/Optimize folder.

Valid Objects

Transform, Plot Optimizer

menu_func style command: none

Deletes all parameters and variables in the optimizer's parameter folder.

Example

 iccap_func("./CGaas1/dc/igvg_0vs","Clear Table")
 iccap_func("./PlotOptimizer","Clear Table")

See Also

Clear Plot Optimizer

Close

Automates the IC-CAP/Simulation Debugger or Plot window's File > Close functionality.

Valid Objects

Simulation Debugger, Plot

menu_func style command: "Close"

Closes the Simulation Debugger or Plot window if open.

Example

 iccap_func("Simulation Debugger","Close")
 ! closed Simulation Debugger
 iccap_func("/npn/dc/fgummel/ibicvsve","Close")
 !closes plot

Close All

Automates the Model window's File > Close functionality.

Valid Objects

Model, DUT, Setup

menu_func style command: "Close All"

Closes the model window and all associated windows, or all plot windows within a named DUT or setup.

Example

 iccap_func("/CGaas1","Close All")
 ! closes model and all children
 iccap_func("/CGaas1/dc","Close All")
 ! closes all plots within DUT

Close Branch

Automates the action of closing a DUT on the DUTs/Setups tree.

Valid Objects

DUT

menu_func style command: none

Closes a DUT on the DUTs/Setups tree. By default, if you fabricate new DUTs with iccap_func Add DUT, the branch will be in the open state. Use this iccap_func to close it.

Example

 iccap_func("/mymodel/mydut","Close Branch")

See Also

Open Branch

Close Error Log

Automates the IC-CAP/Status window's Close Error Log functionality.

Valid Objects

IC-CAP

menu_func style command: none

Closes the error log file.

Example

 iccap_func("ic-cap","Close Error Log")

Close GUI

Automates closing an instance of a GUI item.

Valid Objects

GUI Item

menu_func style command: none

Closes the named instance of a GUI item. Although no longer displayed, the GUI item still reacts to modifications to the variables page, etc.

Example

 iccap_func("/mdl/dut/orSet/GUIName","Close GUI",
           "InstanceName") 

See Also

Add GUI, Close Single GUI, Destroy GUI, Destroy Single GUI, Display Modal GUI, Display Modeless GUI, Display Single Modal GUI, Display Single Modeless GUI, Set GUI Callbacks, Set GUI Options

Close Hardware

Automates the functionality of the File > Close Window menu pick in the Hardware Setup window.

Valid Objects

Hardware

menu_func style command: none

This function closes the Hardware Setup window.

Example

 iccap_func("Hardware","Close Hardware")

Close License Window

Automates the functionality of the OK button in the License Status window. The window must be currently displayed (either by a License Status call or by choosing Tools > License Status in the Main window).

Valid Objects

IC-CAP

menu_func style command: none

This function closes the License Status window.

Example

 iccap_func("IC-CAP","Close License Window")

Close Output Log

Automates the IC-CAP/Status window's Close Output Log functionality.

Valid Objects

IC-CAP

menu_func style command: none

Closes the output log file.

Example

 iccap_func("ic-cap","Close Output Log")

Close Single GUI

Automates closing a single displayed GUI item.

Valid Objects

GUI Item

menu_func style command: none

Closes the displayed GUI item. Although no longer displayed, the GUI item still reacts to modifications to the variables page, etc.

Example

 iccap_func("/mdl/dut/orSet/GUIName","Close Single GUI")

See Also

Add GUI, Close GUI, Destroy GUI, Destroy Single GUI, Display Modal GUI, Display Modeless GUI, Display Single Modal GUI, Display Single Modeless GUI, Set GUI Callbacks, Set GUI Options

Color

Automates the Options > Session Settings > Color menu pick in a plot window.

Valid Objects

Plot

Toggles between color and black and white. Each time you c all you either go to color or to black and white.

Example

 iccap_func("/CGaas1/dc/igvg_0vs/vs/ig_vs_vg","Color")

Copy

Automates copying an item to a new name, but does not permit undo or paste after completion.

Valid Objects

Model, Macro, DUT, Setup, Input, Output, Transform, Plot, Circuit, Test Circuit, Parameter Set, Device Parameter Set, GUI Item.

menu_func style command: "Copy"

Prompts for the name of the copied item, or uses the optional third argument if provided. The name of the copied item is determined relative to the item being copied, not relative to the transform/macro being run. Whether prompted or supplying the optional third argument, the name of the copied item must name the item. Thus to copy item item to container container, you must specify the copied name as container/item, not simply container.

Example

 iccap_func("/CGaas1","Copy","myCGaas1")
 iccap_func("/CGaas1/extract","Copy","myCGaas1/extract2")
 iccap_func("/mymodel/myGUI.subgui","Copy","newgui") 
! creates /mymodel/myGUI.newgui
 iccap_func("/mymodel/myGUI.subgui","Copy","./newGUI") 
! creates /mymodel/newGUI (name relative to copied item)

Copy to Clipboard

Automates the Options > Copy to Clipboard menu pick in a plot window. This feature is only available for the PC version of IC-CAP.

Valid Objects

Plot

menu_func style command: none

Example

 iccap_func("/CGaas1/dc/igvg_0vs/vs/ig_vs_vg","Copy to
           Clipboard")

Copy to Variables

Automates the Options > Copy to Variables menu pick in a plot window.

Valid Objects

Plot

menu_func style command: "Set Variables"

Sets X_HIGH, X_LOW, Y_HIGH, and Y_LOW if those variables exist somewhere that the plot can see them and if a box has been selected on the graph. This function is not available for the Multiplot window.

Example

 iccap_func("/CGaas1/dc/igvg_0vs/vs/ig_vs_vg","Copy to
           Variables")

Create Variable Table Variable

Automates adding a new variable to a Variable table.

Valid Objects

IC-CAP, Model, DUT, Setup

menu_func style command: none

Uses one anticipated argument to name the variable to add to the Variable table on the noted object. Note, if this variable already exists, no action is taken.

 iccap_func(".","CreateVariableTableVariable","newVar")
newVar=12
 ! newVar is local to PEL only, won't reference Variable table

Examples

 iccap_func("/npn","CreateVariableTableVariable",
           "newVariable")

See Also

Set Table Field Value, Set Variable Table Value

Data Markers

Automates the Options > Data Markers menu pick in a plot window

Valid Objects

Plot

menu_func style command: "Line Number On Off"

Toggles whether Data Markers are displayed on the plot.

Example

 iccap_func("/CGaas1/dc/igvg_0vs/vs/ig_vs_vg","Data Markers")

Delete

Automates Edit > Delete (no Undo) menu selection

Valid Objects

Model, Macro, DUT, Setup, Input, Output, Transform, Plot

menu_func style command: "Delete"

Deletes the named object from the system. No Undo

Example

 iccap_func("/CGaas1","Delete")

Delete Active Instr

Automates the functionality of the Delete button in the Hardware Setup window's Instrument List field.

Valid Objects

Hardware

menu_func style command: "Delete Active Instr"

Deletes the instrument selected in the Instrument List from the Active Instrument List. If this function were executed manually, the user would select the instrument in the Instrument List field and press the "Delete" button. This functionality is emulated in PEL by appending the instrument to be deleted in the format:

"library name.select code.address"

followed by "ok" to the end of the command string.

Where

library name is the instrument model number exactly as it is listed in the Instrument Library.
select code is the bus address (in decimal notation) of the GPIB card.
address is the address (in decimal notation) of instrument, as set on the instrument itself.

Example

 iccap_func("Hardware","Delete Active Instr",
           "HP8510.7.16","ok")

Delete Interface File

Automates the functionality of the "Delete Interface" button in the Hardware Setup window's GPIB Interface field.

Valid Objects

Hardware

menu_func style command: "Delete Active Interface"

Deletes a GPIB Interface from the system. If this function were executed manually, the user would select the interface to be delete from the GPIB Interface list and press the "Delete Interface" button. This functionality is emulated in PEL by appending the interface name to be deleted followed by "ok" to the end of the command string.

Example

 iccap_func("Hardware","Delete Interface File","hpib","ok")

Delete Global Regions

Automates the Optimizer > Global Region > Delete All menu pick in a plot window.

Valid Objects

Plot

menu_func style command: none

Deletes all global trace regions.

Example

 iccap_func("./dc/fgummel/ibicvsve", "DeleteGlobalRegions")
 ! Specify plot number for Multiplot
 iccap_func("./dc/fgummel/my_multiplot", 
            "DeleteGlobalRegions", "1")

See Also

Add Global Region

Delete Trace Regions

Automates the Optimizer > trace > Trace Optimizer Region > DeleteAll menu pick in a plot window

Valid Objects

Plot

menu_func style command: none

Deletes all existing trace optimizer regions for the selected trace.

Example

 iccap_func("./dc/fgummel/ibicvsve", "DeleteTraceRegions", 
            "Y Data 0")
 ! Specify plot number for Multiplot
 iccap_func("./dc/fgummel/my_multiplot", 
            "DeleteTraceRegions", "Y Data 0", "1")

See Also

Add Trace Region

Delete All User Regions

Deletes all user defined regions.

Valid Objects

Plot

menu_func style command: none

Example

 iccap_func("dc/fgummel/icibvsve", "DeleteAllUserRegions")

See Also

Delete User Region, Set User Region

Delete User Region

Deletes specified user defined region.

Valid Objects

Plot

menu_func style command: none

Example

 iccap_func("dc/fgummel/icibvsve", "DeleteUserRegion",
            "my_region_name")

See Also

Delete All User Regions, Set User Region

Destroy GUI

Automates closing an instance of a GUI item and frees the associated memory.

Valid Objects

GUI Item

menu_func style command: none

Closes the named instance of a GUI item and frees the associated memory. The next Display needs to build the entire item again.

Example

 iccap_func("/mdl/dut/orSet/GUIName","Destroy GUI",
            "InstanceName")

See Also

Add GUI, Close GUI, Close Single GUI, Destroy Single GUI, Display Modal GUI, Display Modeless GUI, Display Single Modal GUI, Display Single Modeless GUI, Set GUI Callbacks, Set GUI Options

Destroy Single GUI

Automates closing a single displayed GUI item and frees the associated memory.

Valid Objects

GUI Item

menu_func style command: none

Closes the displayed GUI item and frees the associated memory. The next Display needs to build the entire item again.

Example

 iccap_func("/mdl/dut/orSet/GUIName","Destroy Single GUI")

See Also

Add GUI, Close GUI, Close Single GUI, Destroy GUI, Display Modal GUI, Display Modeless GUI, Display Single Modal GUI, Display Single Modeless GUI, Set GUI Callbacks, Set GUI Options

Diagnostics

Automates functionality of IC-CAP/Main Tools > Options > Diagnostics.

Valid Objects

IC-CAP

menu_func style command: "Utilities/Diagnostics"

Does a diagnostic check on most objects in the system. Reports on data structure integrity. Output is of the format:

Diagnostics check for <type> <name>: 
   Errors listed here. 
Diagnostics check for <type> <name>: 
   Errors listed here.
.
.
.

If no errors are reported, IC-CAP is functioning normally.

Example

 iccap_func("ic-cap","Diagnostics")

Diagnostics

Automates the functionality of the Instruments > Usage menu pick in the Hardware Setup window.

Valid Objects

Hardware

menu_func style command: "Diagnostics"

This command displays the usages of the instruments specified in the model file.

Example

 iccap_func("Hardware","Diagnostics")

Disable All

Automates the Plots > Disable All menu pick in the Plot Optimizer window.

Valid Objects

Setup, Transform

menu_func style command: none

Disables all open Plot windows in a model file.

Example

 iccap_func("./PlotOptimizer","DisableAll")

Disable All Traces

Automates the Optimizer > Disable All Traces menu pick in a plot window.

Valid Objects

Plot

menu_func style command: none

Disables all trace.

Example

 iccap_func("dc/fgummel/icibvsve", "DisableAllTraces")
 ! Specify plot number for Multiplot
 iccap_func("dc/fgummel/my_multiplot", "DisableAllTraces", "1")

Disable Plot

Automates the Optimizer > Enable/Disable Plot menu pick in a plot window.

Valid Objects

Plot

menu_func style command: none

Disables the plot window.

Example

 iccap_func("dc/fgummel/icibvsve", "DisablePlot")
 ! Specify plot number for Multiplot
 iccap_func("dc/fgummel/my_multiplot", "DisablePlot", "1")

Disable Supplies

Automates the functionality of the Instruments > Zero Sources menu pick in the Hardware Setup window.

Valid Objects

Hardware

menu_func style command: "Disable Supplies"

This command sets the outputs of all signal sources found either by the "Rebuild Active List" function or as the result of a measurement.

Example

 iccap_func("Hardware","Disable Supplies")

Disable Trace

Automates the Optimizer > trace > Disable menu pick in a plot window

Valid Objects

Plot

menu_func style command: none

Disables the selected trace.

Example

 iccap_func("dc/fgummel/icibvsve", "DisableTrace", "Y Data 1")
 ! Specify plot number for Multiplot
 iccap_func("dc/fgummel/my_multiplot", "DisableTrace", 
            "Y Data 1", "1")

Display Found Instrs

Automates the functionality of the Instruments > Display menu pick in the Hardware Setup window.

Valid Objects

Hardware

menu_func style command: "Display Found Instrs"

This command displays all the devices found on the bus either during the execution of the "Rebuild Active List" command or as the result of a measurement.

Example

 iccap_func("Hardware","Display Found Instrs")

Display Modal GUI

Automates displaying a named instance of a modal GUI.

Valid Objects

GUI Item

menu_func style command: none

Since the third argument is a unique name for that instance of the dialog, you can raise three identical dialogs if it makes sense to do so.

Example

 iccap_func("/mdl/dut/orSet/GuiName","Display Modal GUI",
           "InstanceName")

See Also

Add GUI, Close GUI, Close Single GUI, Destroy GUI, Destroy Single GUI, Display Modeless GUI, Display Single Modal GUI, Display Single Modeless GUI, Set GUI Callbacks, Set GUI Options

Display Modeless GUI

Automates displaying a named instance of a modeless GUI.

Valid Objects

GUI Item

menu_func style command: none

Since the third argument is a unique name for that instance of the dialog, you can raise three identical dialogs if it makes sense to do so.

Example

 iccap_func("/mdl/dut/orSet/GuiName","Display Modeless GUI",
           "InstanceName")

See Also

Add GUI, Close GUI, Close Single GUI, Destroy GUI, Destroy Single GUI, Display Modal GUI, Display Single Modal GUI, Display Single Modeless GUI, Set GUI Callbacks, Set GUI Options

Display Plot

Automates the Display Plot functionality.

Valid Objects

Plot

menu_func style command: "Display Plot"

Displays the named plot.

Examples:

 iccap_func("DC/forward/log_ia_va","Display Plot")
 iccap_func("MultiPlot/wafermap_sim/WaferMap","Display Plot")

Display Plots

Automates the Data > Plots > Display All functionality.

Valid Objects

Model, DUT, Setup

menu_func style command: "Display Plots"

Displays all plots available in the named Model, named DUT, or named setup.

Examples:

 iccap_func("/CGaas1/dc","Display Plots")
 iccap_func("/CGaas1/dc/igvg_0vs","Display Plots")
 iccap_func("/CGaas1","Display Plots")

Display Single Modal GUI

Automates displaying a single modal GUI item.

Valid Objects

GUI Item

menu_func style command: none

Since a name is not required, you can only show the dialog once using this command. This is useful for callbacks—see the properties for the Wizard GUI Item's Cancel button in the gui_tutorial.mdl.

Example

 iccap_func("/mdl/dut/orSet/GuiName","Display Single Modal 
           GUI")

See Also

Add GUI, Close GUI, Close Single GUI, Destroy GUI, Destroy Single GUI, Display Modal GUI, Display Modeless GUI, Display Single Modeless GUI, Set GUI Callbacks, Set GUI Options

Display Single Modeless GUI

Automates displaying a single modeless GUI item.

Valid Objects

GUI Item

menu_func style command: none

Since a name is not required, you can only show the dialog once using this command. This is useful for callbacks—see the properties for the Wizard GUI Item's Cancel button in the gui_tutorial.mdl.

Example

 iccap_func("/mdl/dut/orSet/GuiName","Display Single Modeless
           GUI")

See Also

Add GUI, Close GUI, Close Single GUI, Destroy GUI, Destroy Single GUI, Display Modal GUI, Display Modeless GUI, Display Single Modal GUI, Set GUI Callbacks, Set GUI Options

Draw Diag Line

Automates the Options > Draw Diag Line menu pick in a plot window

Valid Objects

Plot

menu_func style command: "Draw Diag Line"

Draws a solid line along the diagonal. Acts as a toggle, each time you call you either draw it or take it down.

Example

 iccap_func("/CGaas1/dc/igvg_0vs/vs/ig_vs_vg","DrawDiagLine")
 ! Specify plot number for Multiplot
 iccap_func("/CGaas1/dc/igvg/my_multiplot","DrawDiagLine",
            "1")

Dump To Plotter

Provided to be compatible with Version 4.5 style of printing

Valid Objects

Plot

menu_func style command: "Dump To Printer"

Prompts for the name of the command through which to pipe the HPGL file. May be anticipated by a third argument. Prints the graphical plot.

Example

 iccap_func("/CGaas1/dc/igvg_0vs/vs/ig_vs_vg","Dump To 
           Plotter","lp -dmyprinter")

See Also

Print Via Server, Dump To Printer, Dump Via Server

Dump To Printer

Provided to be compatible with 4.5 style of printing.

Valid Objects

Plot

menu_func style command: "Dump To Printer"

Prompts for the name of the command through which to pipe the required file. May be anticipated by a third argument. Prints the graphical plot.

Example

 iccap_func("/CGaas1/dc/igvg_0vs/vs/ig_vs_vg","Dump To 
           Printer","lp -dmyprinter")

See Also

Print Via Server, Dump To Plotter, Dump Via Server

Dump To Stdout

Automates the "Dump To Stdout" button on the 'View Data' window.

Valid Objects

Input, Output, Transform

menu_func style command: "Dump To Stdout"

Writes the text that would go in the 'View Data' block out to the output window of the Status window. Useful if running a logfile of the output window and you want to monitor your automation.

Example

 iccap_func("CGaas1/dc/igvg_0vs/vs","Dump To Stdout")

Dump Via Server

Automates printing to supported file types.

Valid Objects

Plot

menu_func style command: none (see "Send to Printer")

Provides functionality for the HPGL2 printing capability available in the File > Print dialog box. For the PC, this also provides functionality for the .emf file output accessed in the File > Print dialog box. Finally, it provides the capability to create a black and white postscript file. Note, this is for backward compatibility only and this black and white postscript file can only be printed via this command—there is no user interface access to generating such a postscript file.

This iccap_func() prompts with questions for additional arguments. Initially you are prompted "Print to a File?"

if you answer "Y", you are prompted for a filename and then for the format

if you answer "N", a failure is indicated since this option is not available starting with IC-CAP 2004.

Examples:

 ! following line creates an HPGL2 file 
 iccap_func("myPlot","Dump Via Server","Y","hpglfile.hgl", 
            "HPGL2")
 ! following line creates a black & white postscript file
 iccap_func("myPlot","Dump Via Server","Y","psfile.ps","PS")
 ! following line will create a .emf file on PC only
 iccap_func("myPlot","Dump Via Server","Y","emffile.emf",
            "EMF")

See Also

Send To Printer, Dump To Printer, Dump To Plotter, and Variables PAPER and PLOT_SCALE_FACTOR

Dump Via Server UI

Automates a Plot window's File > Print functionality.

Valid Object

Plot

Displays the Print dialog box for printing a graphical plot.

Example

iccap_func("myPlot","Dump Via Server UI")

See Also

Print Via Server

Edit

Automates the IC-CAP/Main window's File > Restore functionality or an Input, Output, or Plot's Edit… functionality.

Valid Objects

Model, Input, Output, Plot

menu_func style command: "Edit"

Opens the Model window for the specified model. For Inputs, Outputs, or Plots, opens the dialog box for editing the definition of that Input, Output, or Plot. You cannot use extra arguments to fill in the dialog box. For that functionality, use "Set Table Field Value" instead.

Example

 iccap_func("/CGaas1","Edit")
iccap_func("/npn/dc/fgummel/bvsic","Edit")
iccap_func("/npn/dc/fgummel/ic","Edit")
iccap_func("/npn/dc/fgummel/vc","Edit")

Enable All

Automates the Plots > Enable All menu pick in the Plot Optimizer window.

Valid Objects

Plot Optimizer

menu_func style command: none

Enables all open Plot windows in a model file.

Example

 iccap_func("./PlotOptimizer","Enable All")

Enable Plot

Automates the Optimizer > Enable/Disable Plot menu pick in a plot window

Valid Objects

Plot

menu_func style command: none

Enables the plot window. Enabling the plot window synchronizes it with the Plot Optimizer window.

Example

 iccap_func("dc/fgummel/icibvsve", "EnablePlot")
 ! Specify plot number for Multiplot
 iccap_func("dc/fgummel/my_multiplot", "EnablePlot", "1")
 ! Apply to all plots in a Multiplot
 iccap_func("dc/fgummel/my_multiplot", "EnablePlot")

Exchange Black-White

Automates the Options > Session Settings > Exchange Black-White menu pick in a plot window.

Valid Objects

Plot

menu_func style command: "Exchange Blk Wht"

Toggles the background color of the plot from black to white.

Example

 iccap_func("/CGaas1/dc/igvg_0vs/vs/ig_vs_vg","Exchange
           Black-White")

Execute

Automates the Execute button on the Macro or Extract/Optimize Page.

Valid Objects

Macro, Transform

menu_func style command: "Execute" for macros and "Perform Transform" for transforms

Executes the named macro or transform.

Example

 iccap_func("/CGaas1/extract","Execute")
 iccap_func("/CGaas1/dc/igvg_0vs/rf_off","Execute")

Exit/Exit!

Automates the IC-CAP/Main window's File > Exit functionality.

Valid Objects

IC-CAP

menu_func style command: "Exit/Exit IC-CAP" which maps to the new "Exit" form

Shuts down the current IC-CAP session.

Example

 iccap_func("ic-cap","Exit")
 iccap_func("ic-cap","Exit!")

Export Data Measured

Automates the Export Data button in the Measure/Simulate folder.

Valid Objects

Setup

menu_func style command: none

Prompts for the name of the file to export the measured data to, or uses the optional third argument if provided. (No provision is made for exporting transforms with this iccap_func statement.)

Example

 iccap_func("/spar_vs_temp/ac/spar_vs_temp","Export Data
           Measured","my_file.mdm")

Export Dataset

Automates the Model window's File > Export Data menu pick functionality.

Valid Objects

Model, DUT, Setup

Exports the data to a dataset file (*.ds) in the specified path. If the optional third argument is not specified, prompts for the full path and file name.

Example

 iccap_func("/CGaas1","Export Dataset", 
          "/tmp/data/my_dataset.ds")
 iccap_func("/CGaas1/dc","Export Dataset", 
          "/tmp/data/my_dataset.ds")
 iccap_func("/CGaas1/dc/igvg_0vs","Export Dataset", 
          "/tmp/data/my_dataset.ds")

See Also

Refresh Dataset

Export Data Simulated

Automates the Export Data button in the Measure/Simulate folder.

Valid Objects

Setup

menu_func style command: none

Prompts for the name of the file to export the simulated data to, or uses the optional third argument if provided. (No provision is made for exporting transforms with this iccap_func statement.)

Example

 iccap_func("/spar_vs_temp/ac/spar_vs_temp","Export Data
           Simulated","my_file.mdm")

Extract

Automates the Extract menu picks.

Valid Objects

DUT, Setup

menu_func style command: "Extract"

Performs Extraction Transforms on all setups within named DUT or within named setup.

Example

 iccap_func("/CGaas1/dc","Extract")
 iccap_func("/CGaas1/dc/igvg_0vs","Extract")

File Debug On

Automates functionality of IC-CAP/Main Tools > Options > File Debug.

Valid Objects

IC-CAP

menu_func style command: "Utilities/File Debug On"

Logs most debug information to $HOME/.icdebug. Also prints certain information only to the Status window.

Example

 iccap_func("ic-cap","File Debug On")

See Also

Debug Off, File Debug Off

File/Screen Debug Off

Automates functionality of IC-CAP/Main Tools > Options > File Debug and IC-CAP/Main Tools > Options > Screen Debug by effectively turning the toggles off.

Valid Objects

IC-CAP

menu_func style command: "Utilities/Debug Off"

"File Debug Off", "Screen Debug Off", and "Debug Off" All have the same effect. They halt logging of data either to the screen or file.

Example

 iccap_func("ic-cap","Debug Off")

See Also

File Debug On, Screen Debug On

Footer

Automates the Options > Session Settings > Footer menu pick in a plot window

Valid Objects

Plot

Toggles the footer text on and off for the specified plot. If Show Absolute Error or Show Relative Error is turned on, the error is displayed in the footer area and the footer text is turned off.

Example

 iccap_func("./dc/fgummel/bvsic", "Footer")
 ! Specify plot number for Multiplot
 iccap_func("./dc/fgummel/my_multiplot", "Footer", "1")
 ! Apply to all plots in a Multiplot
 iccap_func("./dc/fgummel/my_multiplot", "Footer")

See Also

Footer Off, Footer On, Show Absolute Error, Show Relative Error

Footer Off

Turns off the footer text for the specified plot.

Valid Objects

Plot

Example

 iccap_func("./dc/fgummel/bvsic", "FooterOff")
 ! Specify plot number for Multiplot
 iccap_func("./dc/fgummel/my_multiplot", "FooterOff", "1")
 ! Apply to all plots in a Multiplot
 iccap_func("./dc/fgummel/my_multiplot", "FooterOff")

See Also

Footer, Footer On

Footer On

Turns on the footer text for the specified plot

Valid Objects

Plot

Example

 iccap_func("./dc/fgummel/bvsic", "FooterOn")
 ! Specify plot number for Multiplot
 iccap_func("./dc/fgummel/my_multiplot", "FooterOn", "1")
 ! Apply to all plots in a Multiplot
 iccap_func("./dc/fgummel/my_multiplot", "FooterOn")

See Also

Footer, Footer Off

Full Page Plot

Automates the Plots > Full Page Plot menu pick in a Multiplot window

Valid Objects

Plot

In the Multiplot window, displays only the specified plot and hides all other plots. Use Undo Zoom to display all plots.

Example

 iccap_func("./dc/fgummel/my_multiplot", "FullPagePlot", "1")

See Also

Toggle Zoom, Zoom Plot, Undo Zoom

Header

Automates the Options > Session Settings > Header menu pick in a plot window

Valid Objects

Plot

Toggles the header text on and off for the specified plot.

Example

 iccap_func("./dc/fgummel/bvsic", "Header")
 ! Specify plot number for Multiplot
 iccap_func("./dc/fgummel/my_multiplot", "Header", "1")
 ! Apply to all plots in a Multiplot
 iccap_func("./dc/fgummel/my_multiplot", "Header")

See Also

Header Off, Header On

Header Off

Turns on the header text for the specified plot

Valid Objects

Plot

Example

 iccap_func("./dc/fgummel/bvsic", "HeaderOff")
 ! Specify plot number for Multiplot
 iccap_func("./dc/fgummel/my_multiplot", "HeaderOff", "1")
 ! Apply to all plots in a Multiplot
 iccap_func("./dc/fgummel/my_multiplot", "HeaderOff")

See Also

Header, Header On

Header On

Turns on the header text for the specified plot

Valid Objects

Plot

Example

 iccap_func("./dc/fgummel/bvsic", "HeaderOn")
 ! Specify plot number for Multiplot
 iccap_func("./dc/fgummel/my_multiplot", "HeaderOn", "1")
 ! Apply to all plots in a Multiplot
 iccap_func("./dc/fgummel/my_multiplot", "HeaderOn")

See Also

Header, Header Off

Hide Highlighted Curves

Does not highlight the curves that were marked highlighted.

Valid Objects

Plot

menu_func style command: none

This command allows you to retain the set of highlighted curves, but not display them highlighted. Note the highlight set of curves will always highlight during an optimization. You can use this command to turn off the highlight after an optimization completes.

Example

 iccap_func("dc/fgummel/icibvsve", "Hide Highlighted Curves")
 
 ! Do not show the curves highlighted, which have been marked 
! highlighted in the 2nd subplot of my_muliplot.
 ! Specify the subplot number as "1"
 iccap_func("dc/fgummel/my_multiplot", "Hide Highlighted 
            Curves", "1")
 
 ! Do not show the curves highlighted, which have been marked 
! highlighted in all the subplots of my_muliplot.
 iccap_func("dc/fgummel/my_multiplot","Hide Highlighted Curves")

See Also

Mark Curve Highlighted, Unmark Highlighted Curve, Unmark All Highlighted Curves, Show Highlighted Curves

I-O_Lock

Automates the functionality of the Tools > Interface > Lock menu pick in the Hardware Setup window.

Valid Objects

Hardware/HPIBAnalyzer

menu_func style command: "I-O_Lock"

Because the GPIB allows multiple sessions on the same device or interface, the action of opening does not mean the user has exclusive use. In some cases, the user might not want others to have access to the devices on the bus or interface while he is using it. In such cases, the interface should be locked, which restricts other device and interface sessions from accessing it. This function sends a lock command to the currently active interface.

Example

 iccap_func("Hardware/HPIBAnalyzer","I-O_Lock")

I-O_Reset

Automates the functionality of the Tools > Interface > Reset menu pick in the Hardware Setup window.

Valid Objects

Hardware/HPIBAnalyzer

menu_func type command: "I-O_Reset"

This function sends a reset command to the currently active interface.

Example

 iccap_func("Hardware/HPIBAnalyzer","I-O_Reset")

I-O_Screen Debug OFF

Automates the functionality of the View > Screen Debug menu pick in the Hardware Setup window.

Valid Objects

Hardware/HPIBAnalyzer

menu_func style command: "I-O_Screen Debug OFF"

This command turns off the IC-CAP GPIB debugger and removes the check mark from the menu item.

Example

 iccap_func("Hardware/HPIBAnalyzer","I-O_Screen Debugger 
             OFF")

I-O_Screen Debug ON

Automates the functionality of the View > Screen Debug menu pick in the Hardware Setup window. This menu item is a toggle. If a checkmark appears next to the it, the debugger is ON; otherwise, it is OFF.

Valid Objects

Hardware/HPIBAnalyzer

menu_func style command: "I-O_Screen Debug ON"

This command turns on the IC-CAP GPIB debugger which produces detailed status messages as the various operations are executed. This information is displayed in the IC-CAP/Status window and, if visible, the Hardware Setup window.

Example

 iccap_func("Hardware/HPIBAnalyzer","I-O_Screen Debug ON")

I-O_Unlock

Automates the functionality of the Tools > Interface > Unlock menu pick in the Hardware Setup window.

Valid Objects

Hardware/HPIB Analyzer

menu_func style command: "I-O_Unlock"

This function sends a unlock command to the currently active interface.

Example

 iccap_func("Hardware/HPIBAnalyzer","I-O_Unlock")

Import Create

Reads named MDM file, removes existing information from setup, then imports all header information and data from the file to the setup object. If third argument is omitted, you will be prompted for a filename.

Valid Objects

Setup

menu_func style command: none

Data is read into the measured array for outputs of type M or B and into the simulated array for outputs of type S. This is identical to Import Create Measured or Simulated.

Example

 iccap_func("/myModel/myDut/mySetup","Import Create", 
           "/tmp/tmpfile.mdm")
 iccap_func("/myModel/myDut/mySetup","Import Create") 
           ! prompt user

See Also

Import Create Header Only, Import Create Measured, Import Create Simulated, Import Create Simulated or Measured

Import Create Header Only

Reads the header of the MDM file and creates or modifies the named setup to exactly match the shape of the data contained in the MDM file. No data is imported. If third argument is omitted, you will be prompted for a filename.

Valid Objects

Setup

menu_func style command: none

Example

 iccap_func("/myModel/myDut/mySetup","Import Create Header 
           Only","/tmp/tmpfile.mdm")
 iccap_func("/myModel/myDut/mySetup","Import Create Header 
           Only") ! prompt user

See Also

Import Create, Import Create Measured, Import Create Simulated, Import Create Measured or Simulated, Import Create Simulated or Measured

Import Create Measured

Reads named MDM file, removes existing information from setup, then imports all header information and data from the file to the setup object. If third argument is omitted, you will be prompted for a filename.

Valid Objects

Setup

menu_func style command: none

Data is read into the measured array for outputs of type M or B and no data is read into the simulated array for outputs of type S.

Example

 iccap_func("/myModel/myDut/mySetup","Import Create 
           Measured","/tmp/tmpfile.mdm")
 iccap_func("/myModel/myDut/mySetup","Import Create 
           Measured")! prompt user

See Also

Import Create, Import Create Header Only, Import Create Simulated, Import Create Measured or Simulated, Import Create Simulated or Measured

Import Create Measured or Simulated

Reads named MDM file, removes existing information from setup, then imports all header information and data from the file to the setup object. If third argument is omitted, you will be prompted for a filename.

Valid Objects

Setup

menu_func style command: none

Data is read into the measured array for outputs type M or B and into the simulated array for outputs type S. This is identical to Import Create.

Example

 iccap_func("/myModel/myDut/mySetup","Import Create Measured 
           or Simulated","/tmp/tmpfile.mdm")
 iccap_func("/myModel/myDut/mySetup","Import Create Measured 
           or Simulated") ! prompt user

See Also

Import Create Header Only, Import Create Measured, Import Create Simulated, Import Create Simulated or Measured

Import Create Simulated

Reads named MDM file, removes existing information from setup, then imports all header information and data from the file to the setup object. If third argument is omitted, you will be prompted for a filename.

Valid Objects

Setup

menu_func style command: none

Data is read into the simulated array for outputs type S or B and no data is read into the measured array for outputs of type M.

Example

 iccap_func("/myModel/myDut/mySetup","Import Create 
          Simulated","/tmp/tmpfile.mdm")
 iccap_func("/myModel/myDut/mySetup","Import Create 
          Simulated") ! prompt user

See Also

Import Create, Import Create Header Only, Import Create Measured, Import Create Measured or Simulated, Import Create Simulated or Measured

Import Create Simulated or Measured

Reads named MDM file, removes existing information from setup, then imports all header information and data from the file to the setup object. If third argument is omitted, you will be prompted for a filename.

Valid Objects

Setup

menu_func style command: none

Data is read into the simulated array for outputs of type S or B and into the measured array for outputs of type M.

Example

 iccap_func("/myModel/myDut/mySetup","Import Create Simulated 
           or Measured","/tmp/tmpfile.mdm")
 iccap_func("/myModel/myDut/mySetup","Import Create Simulated 
           or Measured") ! prompt user

See Also

Import Create, Import Create Header Only, Import Create Measured, Import Create Simulated, Import Create Measured or Simulated

Import Data

Automates the Model window's File > Import Data > Active Setup, All Setups in Active DUT, or All DUTs in a Model menu pick.

Valid Objects

Model, DUT, Setup

menu_func style command: none

For Model and DUT, MDM filenames are specified in MDM_FILE_PATH and MDM_FILE_NAME in the setups contained by the DUT or Model. For calls to Setup objects, either specify the name in the 3rd argument or you will be prompted for a filename.

Data is read into the measured array for outputs type M or B and into the simulated array for outputs type S. This is identical to Import Measured or Simulated Data.

Example

 iccap_func("/CGaas1","Import Data") 
 ! Imports data to all DUTs in a model
 iccap_func("/CGaas1/dc","Import Data") 
 ! Imports data to all Setups in a DUT
 iccap_func("/CGaas1/dc/igvg_0vs","Import Data") 
 ! Imports data to a single setup, prompts user
 iccap_func("/CGaas1/dc/igvg_0vs","Import Data","tmp.mdm") 
 ! Imports data to a single setup

See Also

Import Measured Data, Import Measured or Simulated Data, Import Simulated Data, Import Simulated or Measured Data

Import Delete

Deletes inputs and outputs from the named setup.

Valid Objects

Setup

menu_func style command: none

Example

 iccap_func("/CGaas1/dc/igvg_0vs","Import Delete")

Import Measured Data

Automates the Model window's File > Import Data > Active Setup, All Setups in Active DUT, or All DUTs in a Model menu pick and selects Measured only.

Valid Objects

Model, DUT, Setup

menu_func style command: none

For Model and DUT, MDM filenames are specified in MDM_FILE_PATH and MDM_FILE_NAME in the setups contained by the DUT or Model. For calls to Setup objects, either specify the name in the 3rd argument or you will be prompted for a filename.

Data is read into the measured array for outputs of type M or B and no data is read into the simulated array for outputs of type S.

Example

 iccap_func("/CGaas1","Import Measured Data") 
 ! Imports measured data to all DUTs in a model
 iccap_func("/CGaas1/dc","Import Measured Data") 
 ! Imports measured data to all Setups in a DUT
 iccap_func("/CGaas1/dc/igvg_0vs","Import Measured Data")
 ! Imports measured data to a single setup and prompts user
 iccap_func("/CGaas1/dc/igvg_0vs","Import Measured 
           Data","tmp.mdm") 
 ! Imports measured data to a single setup

See Also

Import Data, Import Measured or Simulated Data, Import Simulated Data, Import Simulated or Measured Data

Import Measured or Simulated Data

Automates the Model window's File > Import Data > Active Setup, All Setups in Active DUT, or All DUTs in a Model menu pick and selects Measured if available, otherwise Simulated.

Valid Objects

Model, DUT, Setup

menu_func style command: none

For Model and DUT, MDM filenames are specified in MDM_FILE_PATH and MDM_FILE_NAME in the setups contained by the DUT or Model. For calls to Setup objects, either specify the name in the 3rd argument or you will be prompted for a filename.

Data is read into the measured array for outputs type M or B and into the simulated array for outputs type S. This is identical to Import Data.

Example

 iccap_func("/CGaas1","Import Measured or Simulated Data") 
 ! Imports measured data if available, otherwise simulated 
 ! data to all DUTs in a model
 iccap_func("/CGaas1/dc","Import Measured or Simulated Data") 
 ! Imports measured data if available, otherwise simulated 
 ! data to all Setups in a DUT
 iccap_func("/CGaas1/dc/igvg_0vs","Import Measured or 
           Simulated Data")
 ! Imports measured data if available, otherwise simulated 
 ! data to a single setup and prompts user
 iccap_func("/CGaas1/dc/igvg_0vs","Import Measured or 
           Simulated Data","tmp.mdm")
 ! Imports measured data if available, otherwise simulated 
 ! data to a single setup

See Also

Import Data, Import Measured Data, Import Simulated Data, Import Simulated or Measured Data

Import Simulated Data

Automates the Model window's File > Import Data > Active Setup, All Setups in Active DUT, or All DUTs in a Model menu pick and selects Simulated only.

Valid Objects

Model, DUT, Setup

menu_func style command: none

For Model and DUT, MDM filenames are specified in MDM_FILE_PATH and MDM_FILE_NAME in the setups contained by the DUT or Model. For calls to Setup objects, either specify the name in the 3rd argument or you will be prompted for a filename.

Data is read into the simulated array for outputs type S or B and no data is read into the measured array for outputs of type M.

Example

 iccap_func("/CGaas1","Import Simulated Data") 
 ! Imports simulated data to all DUTs in a model
 iccap_func("/CGaas1/dc","Import Simulated Data") 
 ! Imports simulated data to all Setups in a DUT
 iccap_func("/CGaas1/dc/igvg_0vs","Import Simulated Data")
 ! Imports simulated data to a single setup and prompts user
 iccap_func("/CGaas1/dc/igvg_0vs","Import Simulated 
           Data","tmp.mdm")
 ! Imports simulated data to a single setup

See Also

Import Data, Import Measured Data, Import Measured or Simulated Data, Import Simulated or Measured Data

Import Simulated or Measured Data

Automates the Model window's File > Import Data > Active Setup, All Setups in Active DUT, or All DUTs in a Model menu pick and selects Simulated if available, otherwise Measured.

Valid Objects

Model, DUT, Setup

menu_func style command: none

For Model and DUT, MDM filenames are specified in MDM_FILE_PATH and MDM_FILE_NAME in the setups contained by the DUT or Model. For calls to Setup objects, either specify the name in the 3rd argument or you will be prompted for a filename.

Data is read into the simulated array for outputs of type S or B and into the measured array for outputs of type M.

Example

 iccap_func("/CGaas1","Import Simulated or Measured Data") 
 ! Imports simulated data if available, otherwise measured 
 ! data to all DUTs in a model
 iccap_func("/CGaas1/dc","Import Simulated or Measured Data") 
 ! Imports simulated data if available, otherwise measured 
 ! data to all Setups in a DUT
 iccap_func("/CGaas1/dc/igvg_0vs","Import Simulated or 
           Measured Data")
 ! Imports simulated data if available, otherwise measured 
 ! data to a single setup and prompts user
 iccap_func("/CGaas1/dc/igvg_0vs","Import Simulated or 
           Measured Data","tmp.mdm")
 ! Imports simulated data if available, otherwise measured 
 ! data to a single setup

See Also

Import Data, Import Measured Data, Import Measured or Simulated Data, Import Simulated Data

Import Text

Automates the "Import Text..." button in the Circuit folder.

Valid Objects

Circuit, Test Circuit

menu_func style command: "Read Netlist"

Prompts for the name of a file from which to read text. Places all text in the Circuit folder. Automatically performs Parse. An optional third argument may be specified to name the file.

Example

 iccap_func("/CGaas1/Circuit","Import Text","mycirc.deck")
 iccap_func("/CGaas1/dc/TestCircuit","Import Text",
           "mycirc.deck")

Legend

Automates the Options > Session Settings > Legend menu pick in a plot window

Valid Objects

Plot

menu_func style command: none

Toggles the legend on and off for the specified plot.

Example

 iccap_func("./dc/fgummel/bvsic", "Legend")
 ! Specify plot number for Multiplot
 iccap_func("./dc/fgummel/my_multiplot", "Legend", "1")
 ! Apply to all plots in a Multiplot
 iccap_func("./dc/fgummel/my_multiplot", "Legend")

See Also

Legend Off, Legend On

Legend Off

Turns off the legend for the specified plot

Valid Objects

Plot

menu_func style command: none

Example

 iccap_func("./dc/fgummel/bvsic", "LegendOff")
 ! Specify plot number for Multiplot
 iccap_func("./dc/fgummel/my_multiplot", "LegendOff", "1")
 ! Apply to all plots in a Multiplot
 iccap_func("./dc/fgummel/my_multiplot", "LegendOff")

See Also

Legend, Legend On

Legend On

Turns on the legend for the specified plot

Valid Objects

Plot

menu_func style command: none

Example

 iccap_func("./dc/fgummel/bvsic", "LegendOn")
 ! Specify plot number for Multiplot
 iccap_func("./dc/fgummel/my_multiplot", "LegendOn", "1")
 ! Apply to all plots in a Multiplot
 iccap_func("./dc/fgummel/my_multiplot", "LegendOn")

See Also

Legend, Legend Off

License Status

Brings up the same dialog that IC-CAP/Main Tools > License Status does.

Valid Objects

IC-CAP

menu_func style command: "Utilities/Available Codewords"

Launches the 'License Status' dialog. However, this cannot be modified while PEL is still running. This iccap_func is useful only for informational purposes while the macro is running.

Example

 iccap_func("ic-cap","License Status")

Listen Active Address

Automates the functionality of the Tools > Address > Listen menu pick in the Hardware Setup window.

Valid Objects

Hardware/HPIBAnalyzer

menu_func style command: "Listen Active Address"

This function sends a LISTEN command to the device at the currently active address. The result is displayed in the IC-CAP/Status window and, if visible, the Hardware Setup window.

Example

 iccap_func("Hardware/HPIBAnalyzer","Listen Active Address")

Macro File Execute

Automates the functionality of the Tools > Macros > Execute menu pick in the Hardware Setup window.

Valid Objects

Hardware/HPIBAnalyzer

menu_func style command: "Macro File Execute"

This command executes the IC-CAP GPIB macro file name saved by the "Macro File Specify" command.

Example

 iccap_func("Hardware/HPIBAnalyzer","Marco File Execute")
//==========================================================
//
// IC-CAP GPIB Analyzer macro command file description: 
//
//==========================================================

\b \r \n \0 \f \t \v \\ \<any other char>

will first be converted to control characters or otherwise: backspace, CR, newline(=linefeed), null, formfeed, tab, vertical tab, backslash, <any other char>, respectively. \<any other char> behaves as a non-operation—it causes <any other char> to be sent. Note that a backslash and the directive char can always be sent, if preceded by backslash.

$c	indicates current line is a comment
$r	reads into the read buffer
$a2	sets the active address (2 in this case)
$w3	wait for 3 seconds; if argument absent, default of ~2 chosen
$p	prints the contents of the read buffer
$m	message panel—user can indicate stop or continue; system will append the words "; want to continue?" to the characters that follow $m on the command line.
$n	print something to the Output panel IC-CAP/Status window and in the Hardware Setup window Status panel, if visible.
$s	serial poll of the device at the active address. If an integer parameter is present, then it is a serial poll mask, and the program will loop until <poll result> AND <integer mask> is non-zero, i.e., a desired 'bit' is set; if mask is negative, it loops until a mask-specified bit is clear.
$i	'call' another file and execute the macros in it. It should take the form: $i /users/icuser/macrofile.

An example of a legal macro file:

$c	this is an example IC-CAP GPIB Analyzer macro file ...
$a 16	active address = 16
$c	send request for instrument ID string:
*IDN?\n
$r	read answer back
$p	print it
RST\n
$w2	wait 2 seconds after sending RST to instrument
$c	next will open window, and ask:
$c	'Will now call other_macro_file; want to continue?'
$m	Will now call other_macro_file
$i	/icecap/other_macro_file 'call' another macro file
RST\n
$w2	wait 2 seconds after sending RST to instrument

Macro File Specify

Automates the functionality of the Tools > Macros > Specify menu pick in the Hardware Setup window.

Valid Objects

Hardware/HPIBAnalyzer

menu_func style command: "Macro File Specify"

This function saves the name of an IC-CAP GPIB Macro file to be executed later. If this menu pick were done manually, a dialog box would pop up requesting the name of the macro file. This functionality is emulated in PEL by appending the name of the file desired and "ok" to the command string.

Example

 iccap_func("Hardware/HPIBAnalyzer","Marco File Specify","
           ../mdl/bus_analyzer_macro.mac","OK")

Manual Rescale

Automates the Options > Manual rescale menu pick of a plot window.

Valid Objects

Plot

menu_func style command: none

Adjusts the axes' scales to values entered in statement. Scale values are entered in the order
X-min, Y-min, X-max, Y-max.

Example

 iccap_func("/CGaas1/dc/igvg_0vs/ig_vs_vg","ManualRescale"
           ,"-2,0,0.1,0.01")

Manual Simulation

Automates the IC-CAP/Simulation Debugger File > Manual Simulation functionality.

Valid Objects

Simulation Debugger

menu_func style command: "Manual Simulate"

Performs a manual simulation on the last simulation run. Simulation Debugger window must be open. Must have an Input file from a previous simulation in the simulation debugger input window.

Example

 iccap_func("SimulationDebugger","Manual Simulation")

Mark Curve Highlighted

Marks a specific curve as a highlighted curve.

Valid Objects

Plot

menu_func style command: none

Example

 ! Mark the 1st curve of the 2nd trace as highlighted cure.
 ! Specify the trace number as "1", specify the curve number 
! as "0"
 iccap_func("dc/fgummel/icibvsve", "Mark Curve Highlighted", 
            "1", "0")
 
 ! Mark the 1st curve of the 1st trace of the 2nd subplot as 
! highlighted cure.
 ! Specify the trace number as "0", specify the curve number 
! as "0",
 ! Specify the subplot number as "1"
 iccap_func("dc/fgummel/my_multiplot",  "Mark Curve 
             Highlighted", "0", "0","1")

See also

Unmark Highlighted Curve, Unmark All Highlighted Curves, Hide Highlighted Curves, Show Highlighted Curves

Measure

Automates the Measure menu picks.

Valid Objects

DUT, Setup

menu_func style command: "Measure"

Performs a measurement on all setups within named DUT or within named setup.

Example

 iccap_func("/CGaas1/dc","Measure")
 iccap_func("/CGaas1/dc/igvg_0vs","Measure")

Memory Recall

Automates the "Memory Recall" button on a Model Parameters page.

Valid Objects

Parameter Set, Device Parameter Set

menu_func style command: "Recall Stored Values"

Restores the parameter values previously stored via Memory Store.

Example

 iccap_func("/CGaas1/ParameterSet","Memory Recall")
 iccap_func("/CGaas1/dc/DeviceParameterSet","Memory Recall")

See Also

Memory Store

Memory Store

Automates the "Memory Store" button on a Model Parameters page.

Valid Objects

Parameter Set, Device Parameter Set

menu_func style command: "Store Current Values"

Makes a temporary, internal, hidden copy of the current state of the parameter page.

Example

 iccap_func("/CGaas1/ParameterSet","Memory Store")
 iccap_func("/CGaas1/dc/DeviceParameterSet","Memory Store")

See Also

Memory Recall

New DUT

Automates the Model window's Add... Button functionality.

Valid Objects

Model

menu_func style command: none

Adds a new DUT to the named model. Prompts for the name unless one is provided as the optional third argument.

Example

 iccap_func("/CGaas1","New DUT","Dut1")

New Input/Output/Transform/Plot

Automates the "New..." Buttons under the various setup pages.

Valid Objects

Setup

menu_func style command: none

Adds a new Setup child the named Setup. Will prompt for the name unless one is provided as the optional third argument.

Example

 iccap_func("/CGaas1/ac/s_at_f","New Input","input1")
 iccap_func("/CGaas1/ac/s_at_f","New Output","output1")
 iccap_func("/CGaas1/ac/s_at_f","New Transform","transform1")
 iccap_func("/CGaas1/ac/s_at_f","New Plot","plot1")

New Macro

Automates the Macros Page New... Button functionality.

Valid Objects

Model

menu_func style command: none

Adds a new macro to the named model. Prompts for the name unless one is provided as the optional third argument.

Example

 iccap_func("/CGaas1","New Macro","Dut1")

New Model

Automates the IC-CAP/Main window's File > New functionality.

Valid Objects

IC-CAP

menu_func style command: none

Adds a new model to the system. An optional third parameter will be the name for the model, otherwise a prompt will appear for the name of the new model.

Example

 iccap_func("/","New Model")
 iccap_func("/","New Model","MyModel")

New Setup

Automates the "Add..." Button under the DUTs/Setups tree.

Valid Objects

DUT

menu_func style command: none

Adds a new Setup the named DUT. Will prompt for the name unless one is provided as the optional third argument.

Example

 iccap_func("/CGaas1/dc","New Setup","Setup1")

Open

Automates the File > Open menu pick in the model window when replace is selected or when File > Open is chosen in the system variables window.

Valid Objects

GUI Items, Model, Variables, Circuit, Parameter Set, Macro, DUT, Test Circuit, Device Parameter Set, Setup, Instrument Options, Input, Output, Transform, Plot

menu_func style command: "Read From File"

Prompts for the new name of the file to read, or uses the optional third argument if provided. This will read the file over the top of the specified object leaving the name unchanged. Destroys all previous contents of the named object.

Example

 iccap_func("/CGaas1","Open","tmpSave.mdl")
 iccap_func("/CGaas1/Variables","Open","myvars.vat")

See Also

Open Model, Open DUT, Open Macro, Open Setup, Open Input, Open Output, Open Transform, Open Plot, ReadOnlyValues

Open Branch

Automates the action of opening a DUT on the DUTs/Setups tree.

Valid Objects

DUT

menu_func style command: none

Opens a DUT on the DUTs/Setups tree.

Example

iccap_func("/mymodel/mydut","Open Branch")

See Also

Close Branch

Open DUT

Automates the Model window's File > Open functionality for the DUT level selection.

Valid Objects

Model

menu_func style command: none

Prompts for a name of a .dut file to be read into the current model unless the optional third argument is specified as the name.

Example

 iccap_func("/CGaas1","Open DUT","mydutfile.dut")

Open Error Log

Automates the IC-CAP/Status window's File > Open Error Log functionality.

Valid Objects

IC-CAP

menu_func style command: none

Opens the error log file using the file name if provided.

Example

 iccap_func("ic-cap","Open Error Log", <optional file name>)

Open Hardware

Automates the IC-CAP/Main window's Tools > Hardware Setup functionality.

Valid Objects

IC-CAP

menu_func style command: "Hardware/Edit"

Opens the Hardware Setup window.

Example

 iccap_func("ic-cap","Open Hardware")

Open Input/Output/Transform/Plot

Automates the Model window's File > Open functionality for the Input, Output, Transform, or Plot level selection.

Valid Objects

Setup

menu_func style command: none

Prompts for a name of a .inp, .out, .xfm, or .plt file to be read into the current setup unless the optional third argument is specified as the name.

Example

 iccap_func("/CGaas1/ac/s_at_f","Open Input","myInput.inp")
 iccap_func("/CGaas1/ac/s_at_f","Open Output","myOutput.out")
 iccap_func("/CGaas1/ac/s_at_f","Open Transform",
           "myTransform.xfm")
 iccap_func("/CGaas1/ac/s_at_f","Open Plot","myPlot.plt")

Open Macro

Automates the Model window's File > Open functionality for the Macro level selection.

Valid Objects

Model

menu_func style command: none

Prompts for a name of a .mac file to be read into the current model unless the optional third argument is specified as the name.

Example

 iccap_func("/CGaas1","Open Macro","mydutfile.mac")

Open Model

Automates the IC-CAP/Main window's File > Open functionality.

Valid Objects

IC-CAP

menu_func style command: none

Prompts for a name of a file from which to read models. Name of file can be specified as a third argument.

Example

 iccap_func("/","Read Model")
 iccap_func("/","Read Model","MyModel.mdl")

Open Output Log

Automates the IC-CAP/Status window's File > Open Output Log functionality.

Valid Objects

IC-CAP

menu_func style command: none

Opens the output log file using file name if provided.

Example

 iccap_func("ic-cap","Open Output Log", <optional file name>)

Open Plot Optimizer

Automates the Tools > Plot Optimizer menu pick of a model window and the Optimizer > Open Optimizer menu pick in a plot window.

Valid Objects

Plot

menu_func style command: none

Opens the Plot Optimizer window.

Example

 iccap_func("dc/fgummel/icibvsve", "OpenPlotOptimizer")
 ! Specify plot number for Multiplot
 iccap_func("dc/fgummel/my_multiplot", "OpenPlotOptimizer",
            "1")

Open Setup

Automates the Model window's File > Open functionality for the Setup level selection.

Valid Objects

Model

menu_func style command: none

Prompts for a name of a .set file to be read into the current model unless the optional third argument is specified as the name.

Example

 iccap_func("/CGaas1/dc","Open Setup","mysetfile.set")

Optimize

Automates the Optimize menu picks in the Extract/Optimize folder and the Optimize > Run Optimization menu pick in the Plot Optimizer window.

Valid Objects

DUT, Setup, Plot Optimizer

menu_func style command: "Extract"

Performs Transforms that are optimizers on all setups within named DUT/setup or in the Plot Optimizer window.

Example

 iccap_func("./CGaas1/dc","Optimize")
 iccap_func("./CGaas1/dc/igvg_0vs","Optimize")
 iccap_func("./PlotOptimizer","Optimize")

Parse

Automates the "Parse..." button in the Circuit folder

Valid Objects

Circuit, Test Circuit

menu_func style command: "Parse"

Checks the syntax of the Circuit in reference to the specified simulator and updates the list of parameters if they have changed names. NOTE: Parse does not assign the Parameters table values to those in the Circuit, unless they have been newly added.

Example

 iccap_func("/CGaas1/Circuit","Parse")
 iccap_func("/CGaas1/dc/TestCircuit","Parse")

See Also

Reset

Print Read Buffer

Automates the functionality of the Tools > Send Receive > Display String menu pick in the Hardware Setup window.

Valid Objects

Hardware/HPIB Analyzer

menu_func style command: "Print Read String"

This function prints the ASCII string stored in the read buffer that had been read back by a call to "Read String". The string is displayed in the IC-CAP/Status window and if visible, the Hardware Setup window.

Example

 iccap_func("Hareware","HPIB Analyzer","Print Read Buffer")

Print Via Server

Automates the functionality of File > Print in the Model windows and the "Print" button on various dialogs.

Valid Objects

Variables, Input, Output, Transform, Plot

menu_func style command: none (see "Send to Printer")

Displays the Print dialog box for printing the item. Starting with IC-CAP 2004, the Print dialog box is always displayed when printing. In previous releases, File > Print did not display a dialog box except when asking for a file name if printing to a file.

For plots, Print Via Server prints a tabular listing of the data. To print the graphical plot, use Dump Via Server UI.

Example

 iccap_func("/CGaas1/Variables","Print Via Server")

See Also

Send To Printer, Dump To Printer, Dump To Plotter, Dump Via Server, Dump Via Server UI

Read from File

Automates the functionality of the File > Open menu pick in the Hardware Setup window.

Valid Objects

Hardware

menu_func style command: "Read from File"

Reads in a previously saved hardware configuration file. If this function were executed manually, a dialog box would appear asking the user for the name of the configuration file to read. This functionality is emulated in PEL by appending the desired file name followed by "ok" to the end of the command string.

Example

 iccap_func("Hardware","Read from File","
            ../mdl/hwm_pel_test.hdw","ok")

ReadOnlyValues

Automates the File > Open menu pick when Read Values Only is selected in the Model Parameters folder or the DUT Parameters folder.

Valid Objects

Parameter Set, Device Parameter Set

Prompts for the new name of the file to read, or uses the optional third argument if provided. This replaces parameter Values while maintaining existing Min and Max ranges if possible. If the new value is outside the existing range, Min or Max is extended to include the new Value and a warning is displayed in the Status window.

Example

 iccap_func("./ParameterSet","ReadOnlyValues","myparms.mps")
 iccap_func("/CGaas1/dc/DeviceParameterSet","ReadOnlyValues",
            "myparms.dps")

See Also

Open

Read String

Automates the functionality of the Tools > Send Receive > Receive String menu pick in the Hardware Setup window.

Valid Objects

Hardware/HPIBAnalyzer

menu_func style command: "Read String"

This function reads back an ASCII string from the device at the currently active address as previously set by a call to "Set Active Address". The device should have been previously prepared to talk by sending it a string that generated something for it to say. The received string itself is not displayed; rather the number of characters read is displayed in the IC-CAP/Status window and, if visible, the Hardware Setup window. The string itself is stored in a read_buffer where a call to "Print Read Buffer" can display it later.

Example

 iccap_func("Hardware/HPIBAnalyzer","Read String")

Read String for Experts

Automates the functionality of the Tools > Send Receive > Read String for Experts menu pick in the Hardware Setup window.

Valid Objects

Hardware/HPIBAnalyzer

menu_func style command: "Read String for Experts"

This function is similar to the "Read String" command except it skips the talk/listen setup of the device which should be done using the "Send Command Byte" command. The result is placed in the HPIB_READ_STRING system variable, if it has been defined.

Example

 iccap_func("Hardware/HPIBAnalyzer","Read String for Experts")

Rebuild Active List

Automates the functionality of the "Rebuild" button in the Hardware Setup window's Instrument List field.

Valid Objects

Hardware

menu_func style command: "Rebuild Active List"

Scans the bus and rebuilds the active instrument list for all DUTs and setups based on the instruments it finds there.

Example

 iccap_func("Hardware","Rebuild Active List")

Recall Parameters

Automates the Tools > Recall Parameters menu pick in the Plot Optimizer window and the Recall Par button in the Extract/Optimize folder.

Valid Objects

Transform, Plot Optimizer

menu_func style command: none

Resets the optimizer Parameters table values to the locally stored values.

Example

 iccap_func("./CGaas1/dc/igvg_0vs","Recall Parameters")
 iccap_func("./PlotOptimizer","Recall Parameters")

See Also

Store Parameters

Redisplay

Provided for compatibility.

Valid Objects

Input, Output, Transform, Plot

menu_func style command: "Redisplay"

Refreshes the screen of the 'View Data' of the associated object.

Example

 iccap_func("CGaas1/dc/igvg_0vs/vs","Redisplay")

Refresh Dataset

Automates the Model window's Tools > Refresh Last Dataset menu pick functionality.

Valid Objects

Model

Exports new data to the last exported dataset file (*.ds). If no dataset file had been successful exported, this function will have no effect.

Example

iccap_func("/","Refresh Dataset")

See Also

Export Dataset

Release License

Automates the functionality of the Release button in the License Status window's In Use field.

Valid Objects

IC-CAP

menu_func style command: none

This function releases a license for a specified licensed feature and returns it to the license pool. Specify the desired license name, followed by ok.

Valid license names are:

DC Measurements	Gummel-Poon Bipolar Model
AC Measurements	Curtice-Statz GAAS Model
LCRZ Measurements	Time Domain Measurements
HP Pulsed System Measurements	Philips MEXTRAM Model
1/f Noise Measurements	Philips MOS Model 9
Analysis	UCB MOS3 Model
IC-CAP Statistics	UCB BSIM3 Model
HP Root FET Model	UCB BSIM4 Model
HP Root MOS Model	HP EEFET3 Model
HP Root Diode Model	HP EEHEMT1 Model
VBIC BJT Model	HP EEBJT2 Model

Example

 iccap_func("IC-CAP","Release License","DC Measurements",
            "ok")

Rename

Automates changing the text under the Model icon.

Valid Objects

Model, Macro, DUT, Setup, Input, Output, Transform, Plot

menu_func style command: "Rename"

Prompts for the new name of the model, or uses the optional third argument if provided.

Example

 iccap_func("/CGaas1","Rename","my_CGaas1")

Replace Interface File

This function is not implemented.

Replot

Automates the Options > Replot menu pick of a plot window.

Valid Objects

Plot

menu_func style command: "Replot Data"

Refreshes the plot-- plot window must be open.

Example

 iccap_func("/CGaas1/dc/igvg_0vs/vs/ig_vs_vg","Replot")

Rescale

Automates the Options > Rescale menu pick in a plot window.

Valid Objects

Plot

menu_func style command: "Rescale Graph"

Adjusts the axes to fit the data.

Example

 iccap_func("/CGaas1/dc/igvg_0vs/vs/ig_vs_vg","Rescale")
 ! Specify plot number for Multiplot
 iccap_func("/CGaas1/dc/igvg/my_multiplot","Rescale","1")

Reset

Automates the "Reset" button on a Model Parameters page.

Valid Objects

Parameter Set

menu_func style command: "Reset to Defaults"

Resets the parameter values to the values in the Circuit folder.

Example

 iccap_func("/CGaas1/ParameterSet","Reset")
 iccap_func("/CGaas1/dc/DeviceParameterSet","Reset")

Reset Global Region

Automates the Optimizer > Global Region > Reset menu pick in a plot window.

Valid Objects

Plot

menu_func style command: none

Deletes all existing global trace regions on the plot and defines a new global trace region.

Example

 iccap_func("./dc/fgummel/ibicvsve", "ResetGlobalRegion", 
          "0.6", "0.8", "-8", "-3")
 iccap_func("./dc/fgummel/bvsic", "ResetGlobalRegion", 
           "1e-8", "1e-4", "20", "60")
 ! Specify plot number for Multiplot
 iccap_func("./dc/fgummel/my_multiplot", "ResetGlobalRegion", 
          "0.6", "0.8", "-8", "-3", "1")

Reset Min Max

Automates the Tools > Reset Min Max menu pick in the Plot Optimizer window and the Reset Min Max button in the Extract/Optimize folder.

Valid Objects

Transform, Plot Optimizer

menu_func style command: none

Sets minimum and maximum optimizer parameter values based on the value of the coefficient defined with the AUTOSET_COEFF variable on the System Variables page. The default coefficient value is 5.

Example

 iccap_func("./CGaas1/dc/igvg_0vs","ResetMinMax")
 iccap_func("./PlotOptimizer","ResetMinMax")

Reset Option Table

Automates the File > Reset Option Table menu pick in the Plot Optimizer window.

Valid Objects

Transform, Plot Optimizer

menu_func style command: none

Resets all options in the Options table to the default values.

Example

 iccap_func("./CGaas1/dc/igvg_0vs","ResetOptionsTable")
 iccap_func("./PlotOptimizer","ResetOptionsTable")

Reset to Saved Options

Automates the Options > Session Settings > Reset to Saved Options menu pick in a plot window.

Valid Objects

Plot

menu_func style command: none

Restores the Plot Options to their saved state. For Multiplot, specify a plot number to reset the Plot Options for a specific plot. To reset the Plot Options for a Multiplot, do not specify a plot number.

Example

 iccap_func("./dc/fgummel/bvsic", "ResettoSavedOptions")
 iccap_func("./dc/fgummel/my_multiplot", 
           "ResettoSavedOptions")
 ! Specify plot number in Multiplot to reset specific plot 
 iccap_func("./dc/fgummel/my_multiplot",
            "ResettoSavedOptions", "1")

Reset Trace Region

Automates the Optimizer > trace > Trace Optimizer Region > Reset menu pick in a plot window

Valid Objects

Plot

menu_func style command: none

Deletes all existing trace optimizer regions for the specified trace and defines a new trace optimizer region.

Example

 iccap_func("./dc/fgummel/ibicvsve", "ResetTraceRegion", 
            "Y Data 0", "0.6", "0.8", "-8", "-3")
 iccap_func("./dc/fgummel/bvsic", "ResetTraceRegion", 
           "Y Data 0", "1e-8", "1e-4", "20", "60")
 ! Specify plot number for Multiplot
 iccap_func("./dc/fgummel/my_multiplot", "ResetTraceRegion", 
            "Y Data 0", "0.6", "0.8", "-8", "-3", "1")

Run Self-Tests

Automates the functionality of the Hardware Setup > Instruments > Self Test menu pick in the Hardware Setup window.

Valid Objects

Hardware

menu_func style command: "Run Self-Tests"

Runs self tests on all instruments found on the bus during a rebuild of the active list or a measure. Note that to successfully perform the "Run Self-Tests" function either the "Rebuild Active List" or the "Measure" function must have been performed first.

Example

 iccap_func("Hardware","Run Self-Tests");

Save All

Automates IC-CAP/Main File > Save As, but does not permit selective grouping of models into a .mdl file

Valid Objects

IC-CAP

menu_func style command: "Write All Models To File"

Prompts for the name of a file and saves all loaded models to that file. Name of the file can be anticipated by the third argument.

Example

 iccap_func("/","Save All","myfile.mdl")

See Also

Save All No Data, Save As, Save As No Data

Save All No Data

Automates IC-CAP/Main File > Save As with the "Save without measured/simulated data" option, but does not permit selective grouping of models into a .mdl file

Valid Objects

IC-CAP

menu_func style command: none

Prompts for the name of a file and saves all loaded models to that file without any measured or simulated data. Name of the file can be anticipated by the third argument.

Example

 iccap_func("/","Save All No Data")

See Also

Save As, Save All No Data

Save As

Automates the Model window's File > Save As functionality for the Model level selection.

Valid Objects

GUI Items, Model, Variables, Circuit, ParameterSet, Macro, DUT, TestCircuit, DeviceParameterSet, Setup, InstrumentOptions, Input, Output, Transform, Plot

menu_func style command: "Write To File"

Prompts for a name of a .mdl file to be written unless the optional third argument is specified as the file name.

If the third parameter is "", then the function will write the file out to the default name. The default name is the name of the file that it was read in from, or the name of the last file to which it was written.

Example

 iccap_func("/CGaas1","Save As","tmpFile.mdl")

See Also

Save All, Save All No Data, Save As No Data

Save As No Data

Automates the Model window's File > Save As functionality for the Model level selection choosing the "Save Without Measured/Simulated Data" option.

Valid Objects

Model, Variables, Circuit, Parameter Set, Macro, DUT Test Circuit, Device Parameter Set, Setup, Instrument Options, Input, Output, Transform, Plot

menu_func style command: none

Prompts for a name of a .mdl file to be written unless the optional third argument is specified as the file name.

If the third parameter is "", then the function will write the file out to the default name. The default name is the name of the file that it was read in from, or the name of the last file to which it was written.

Example

 iccap_func("/CGaas1","Save As No Data","smallFile.mdl")

See Also

Save All, Save All No Data, Save As