Manuals >Reference >ICCAP_FUNC Statement
Print version of this Book (PDF file)
prevnext

Objects

IC-CAP

Specify using: "IC-CAP", "ic-cap" or "/"

Actions allowed

Change Directory
Clear Status Errors
Clear Status Output
Close Error Log
Close License Window
Close Output Log
Create Variable Table Variable
Debug Off
Diagnostics
Exit/Exit!
File Debug Off
File Debug On
License Status

New Model
Open Error Log
Open Hardware
Open Model
Open Output Log
Release License
Save All
Save All No Data
Screen Debug Off
Screen Debug On
Set Variable Table Value
Simulation Debugger
Status Window
Stop Simulator

Variables

Specify using: "<path>/Variables" where <path> is the path to a Model, DUT, or Setup, or the slash (/) only to specify the top-level IC-CAP object.

Actions allowed
Open
Print Via Server
Save As
Save As No Data
Send To Printer
Set Table Field Value

Examples:
 iccap_func("/Variables","Save As")
iccap_func("/CGaas1/Variables","Save As")
iccap_func("/CGaas1/dc/Variables","Save As")
iccap_func("/myModel/myDut/mySetup/Variables","Save As")

GUI Items

Specify using: "GUIItems"

Actions allowed
Open
Save As

GUI Item

Specify using: "GUIItem"

Actions allowed
Add GUI
Close GUI
Close Single GUI
Copy
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

Simulation Debugger

Specify using: "SimulationDebugger"

Actions allowed
Close
Manual Simulation
Save Command File
Save Input File
Save Output File
Simulation Debugger

Example
 iccap_func("ic-cap","Simulation Debugger")

Hardware

Specify using: "Hardware"

Actions allowed
Add Active Instr
Add Interface File
Change Address
Clear Active List
Close Hardware
Delete Active Instr
Delete Interface File
Diagnostics
Disable Supplies
Display Found Instrs
Read from File
Rebuild Active List
Replace Interface File
Run Self-Tests
Write to File

HPIB Analyzer

Specify using: "Hardware/HPIBAnalyzer"

Actions allowed

Bus status
Change Interface File
Check Active Address
I-O_Lock
I-O_Reset
I-O_Screen Debug ON
I-O_Screen Debug OFF
I-O_Unlock
Listen Active Address
Macro File Execute
Macro File Specify
Print Read Buffer
Read String

Read String for Experts
Search for Instruments
Send Command Byte
Send, Receive, and Print
Send String
Serial Poll
Set Active Address
Set Speed
Set Timeout
Talk Active Address
Who Are You

MODEL

Specify using: "/<name>" where <name> is the name of the model

Actions allowed

Clear Data/Both
Clear Data/Measured
Clear Data/Simulated
Close All
Copy
Create Variable Table Variable
Delete
Display Plots
Edit
Export Dataset
Import Data
Import Measured Data
Import Measured or Simulated Data

Import Simulated Data
Import Simulated or Measured Data
Open
Open DUT
Open Macro
New DUT
New Macro
Refresh Dataset
Rename
Save As
Save As No Data
Save Extracted Deck
Set Variable Table Value
Stop Simulator

Circuit

Specify using: "/<model>/Circuit" where <model> is the name of a model

Actions allowed
Copy
Import Text
Open
Parse
Save As
Save As No Data

PlotOptimizer

Specify using: "/<model>/PlotOptimizer" where <model> is the name of a model

Actions allowed

Auto Set Min Max
Auto Set Optimize or Auto Set And Optimize
Clear Plot Optimizer
Clear Table or Clear Parameter Table
Disable All
Enable All
Optimize
Recall Parameters
Reset Min Max

Reset Option Table
Set Algorithm
Set Error
Set Table Field Value
Simulate All
Simulate Plot Inputs
Store Parameters
Tune Fast
Tune Slow
Undo Optim

PlotOptions

Plot Options are associated with the root IC-CAP object, models, and plots. To name the plot options, name the object with /PlotOptions appended (e.g., /PlotOptions, /modelname/PlotOptions, or /model/DUT/setup/plot/PlotOptions).

Actions allowed

Set Table Field Value

Example
 iccap_func("myplot/PlotOptions","SetTableFieldValue",
            "<access name>","<value>")
 iccap_func("/mymodel/PlotOptions","SetTableFieldValue",
            "<access name>","<value>")
 iccap_func("/mymodel/PlotOptions","SetTableFieldValue",
            "<access name>","<value>")
where <access name> and <value> examples are listed in the following table:


Note


To see the current <access name> and <value> settings, save the plot options from the Plot Options dialog then view in a text editor.


Table 99 PlotOption Access Name and Value Examples 
Description
Access Names
Values
Setting Trace Color on white
"On White[Data 0]"
"2" (gxvt color index)
Setting Trace Color on black
"On Black[Data 3]"
"4" (gxvt color index)
Setting Symbol
"Symbol[Data 0]"
"Circle"
Selecting Multicolor Curve setting
"Multicolor"
"Display all curves with the configured trace color", "Change color with every curve", "Change color with each 2nd order curve", "Change color with each highest order curve"
Selecting Multicolor Curve color
"On White[Curve 0]"
"2" (gxvt color index)
Selecting Data Representation
"Measured Trace",
"Simulated Trace",
"Transform Result"

"Symbols Only", "Solid Line", "Dashed Line". Solid Line with Symbols"
Layout and background settings
"Show Title",
"Show Title",
"Show Header",
"Show Footer",
"Show Legend",
"White Background",
"Show Area Tools"

"Yes", "No", "Automatic"
Selecting font and size
"Font Type",
"Font Size"

"Arial for CAE", "12"
Selecting font and size of Annotation
"Annotation Font Name"
"Annotation Font Sz"

"Arial for CAE","9"
Enable/Disable Annotation
"Enable Annotation"
"Yes", "No", "Automatic"
Annotation Location
"Annotation Location"
"Upper Left", etc.
Annotation text
"Annotation Text"
"W=10" or use an IC-CAP variable. Multiline text is available, each line must be separated by the string "\012"
Control Via PEL
"PEL Control"
"Yes", "No", "Automatic"
Specify annotation macro/transform
"PEL Transform"
<name path>
Specify when updating the annotation
"PEL Call Type"
"0" Only when plot is opened
"1" Every time plot is refreshed

Parameter Set

Specify using: "/<model>/ParameterSet" where <model> is the name of a model

Actions allowed
Copy
Memory Recall
Memory Store
Open
ReadOnlyValues
Reset
Save As
Save As No Data

MACRO

Specify using: "/<model>/<macroName>" where <model> is the name of a model, and <macroName> is the name of a macro within that model

Actions allowed
Copy
Delete
Execute
Open
Rename
Save As
Save As No Data

DUT

Specify using: "/<model>/<DUT>" where <model> is the name of a model, and <DUT> is the name of a DUT within that model.

Actions allowed

Clear Data/Both
Clear Data/Measured
Clear Data/Simulated
Close All
Close Branch
Copy
Create Variable Table Variable
Delete
Display Plots
Export Dataset
Extract
Import Data
Import Measured Data
Import Measured or Simulated Data

Import Simulated Data
Import Simulated or Measured Data
Measure
New Setup
Open
Open Branch
Open Setup
Optimize
Rename
Save As
Save As No Data
Set Variable Table Value
Simulate

Test Circuit

Specify using: "/<model>/<dut>/TestCircuit" where <model> is the name of a model and <dut> is the name of a DUT within that model.

Actions allowed
Copy
Import Text
Open
Parse
Save As
Save As No Data

Device Parameter Set

Specify using: "/<model>/<dut>/DeviceParameterSet" where <model> is the name of a model and <dut> is the name of a DUT within that model.

Actions allowed
Copy
Memory Recall
Memory Store
Open
ReadOnlyValues
Reset
Save As
Save As No Data

SETUP

Specify using: "/<model>/<DUT>/<Setup>" where <model> is the name of a model, and <DUT> is the name of a DUT within that model, and <Setup> is a setup within that DUT.

Actions allowed

Calibrate
Clear Data/Both
Clear Data/Measured
Clear Data/Simulated
Close All
Copy
Create Variable Table Variable
Delete
Display Plots
Export Data Measured
Export Dataset
Export Data Simulated
Extract
Import Create
Import Create Header Only
Import Create Measured
Import Create Measured or Simulated
Import Create Simulated
Import Create Simulated or Measured

Import Data
Import Delete
Import Measured Data
Import Measured or Simulated Data
Import Simulated Data
Import Simulated or Measured Data
Measure
New Input
New Output
New Plot
New Transform
Open
Open Input
Open Output
Open Plot
Open Transform
Optimize
Rename
Save As
Save As No Data
Set Variable Table Value
Simulate

Instrument Options

Specify using: "/<model>/<DUT>/<Setup>/InstrumentOptions" where <model> is the name of a model, and <DUT> is the name of a DUT within that model, and <Setup> is a setup within that DUT.

Actions allowed
Open
Save As
Save As No Data

INPUT

Specify using: "/<model>/<DUT>/<Setup>/<Input>" where <model> is the name of a model, and <DUT> is the name of a DUT within that model, <Setup> is a setup within that DUT, and <Input> is the name of an input within the setup."

Actions allowed
Copy
Delete
Dump To Stdout
Edit
Open
Print Via Server
Redisplay
Rename
Save As
Save As No Data
Send To Printer
Set Table Field Value
View

OUTPUT

Specify using: "/<model>/<DUT>/<Setup>/<Output>" where <model> is the name of a model, and <DUT> is the name of a DUT within that model, <Setup> is a setup within that DUT, and <Output> is the name of an output within the setup.

Actions allowed
Copy
Delete
Dump To Stdout
Edit
Open
Print Via Server
Redisplay
Rename
Save As
Save As No Data
Send To Printer
Set Table Field Value
View

TRANSFORM

Specify using: "/<model>/<DUT>/<Setup>/<Transform>" where <model> is the name of a model, and <DUT> is the name of a DUT within that model, <Setup> is a setup within that DUT, and <Transform> is the name of a transform within the setup.

Actions allowed
Auto Set Min Max
Clear Table or Clear Parameter Table
Copy
Delete
Dump To Stdout
Execute
Open
Print Via Server
Recall Parameters
Redisplay
Rename
Reset Min Max
Reset Option Table
Save As
Save As No Data
Send To Printer
Set Algorithm
Set Error
Set Table Field Value
Store Parameters
Tune Fast
Tune Slow
Undo Optim
View

PLOT

Specify using: "/<model>/<DUT>/<Setup>/<Plot>" where <model> is the name of a model, and <DUT> is the name of a DUT within that model, <Setup> is a setup within that DUT, and <Plot> is the name of a plot within the setup.

Actions allowed

Add Global Region
Add Trace Region
Area Tools
Area Tools Off
Area Tools On
Autoconfigure or Autoconfigure And Enable
Autoscale
Close
Color
Copy
Copy to Clipboard
Copy to Variables
Data Markers
Delete
Delete Global Regions
Delete Trace Regions
Delete All User Regions
Display Plot
Hide Highlighted Curves
Legend Off
Legend On

Manual Rescale
Mark Curve Highlighted
Open
Open Plot Optimizer
Print Via Server
Rescale
Reset to Saved Options
Redisplay
Rename
Replot
Reset Global Region
Reset Trace Region
Save As
Save As No Data
Save Image
Scale Plot
Scale Plot Preview
Scale RI Plot
Show Highlighted Curves

Turn Off Marker
Unmark All Highlighted Curves
Unmark Highlighted Curve

Delete User Region
Disable All Traces
Disable Plot
Disable Trace
Display Plot
Display Plots
Draw Diag Line
Dump To Plotter
Dump To Printer
Dump Via Server
Dump Via Server UI
Edit
Enable Plot
Exchange Black-White
Footer
Footer Off
Footer On
Full Page Plot
Header
Header Off
Header On
Legend

Scale RI Plot Preview
Select Error Region
Select Plot
Select Whole Plot
Send To Printer
Set Table Field Value
Set Target Vs Simulated
Set Trace As Both
Set User Region
Show Absolute Error
Show Relative Error
Text Annotation
Text Annotation Off
Text Annotation On
Toggle Zoom
Undo Zoom
Unselect All
Update Annotation
View
Zoom Plot


prevnext