User Manual
Welcome
Introduction
About SIMetrix/SIMPLIS Documentation
What is Simetrix?
What is SIMPLIS?
Why Simulate?
System Requirements
Acknowledgements
Quick Start
Introduction
Tutorial 1 - A Simple Ready to Run Circuit
Tutorial 2 - A Simple SMPS Circuit
Tutorial 3 - Installing Third Party Models
Getting Started
Getting Started
Simulation Modes - SIMetrix or SIMPLIS
Using the Schematic Editor
Circuit Rules
Analysis Modes
Running the Simulator
Plotting Simulation Results
SIMetrix GUI Environment
Overview
Interaction
Directory Viewer
Interface Styles
Schematic Editor
Fundamentals
Hierarchical Schematic Entry
Schematic Annotations
Schematic Styles
Schematic Grouping
Schematic Printing
File Operations
Properties
Template Property
PSpice Schematics Translation
Load Component Values
Using Schematic Editor for CMOS IC Design
Further Information
Symbol Editor and Library
Creating Schematic Symbols - Overview
Graphical Symbol Editor
Creating a Symbol from a Script
Symbol Library Manager
Parts
Parts
How to Find and Place Parts
Part Selector
Part Search
Model Library Browser
Numbered Parts in SIMPLIS
Circuit Stimulus
Generic Parts
Creating Models
Subcircuits
Special Parts
Parameters and Expressions
Analog Behavioural Modelling
Introduction
Non-linear Transfer Function
Laplace Transfer Function
Device Library and Parts Management
Device Library and Parts Management
Using Model Library Browser
Parts Management - Installing Models
Parts Management - Configuring the Part Selector
Parts Management - Advanced Topics
Sundry Topics
Analysis Modes
Analysis Modes
Running Simulations
Transient Analysis
Operating Point
Sweep Modes
DC Sweep
AC Sweep
Noise Analysis
Real Time Noise
Transfer Function
Sensitivity
Convergence
Data Handling and Keeps
Simulator Options
Multi-step Analyses
Safe Operating Area Testing
SIMPLIS Analysis Modes
SIMPLIS Analysis Modes
Transient Analysis
Periodic Operating Point (POP)
AC Analysis
SIMPLIS Options
Multi-step and Monte Carlo Analyses
Initial Condition Back-annotation
Graphs, Probes and Data Analysis
Graphs, Probes and Data Analysis
Elements of the Graph Window
Probes: Fixed vs. Random
Fixed Probes
Random Probes
Plot Journals and Updating Curves
Graph Layout
Curve Operations
Graph Cursors
Curve Measurements
Efficiency Calculator
Graph Zooming and Scrolling
Annotating a Graph
Exporting/Importing Graphs and Data
Saving Graphs
Saving Data
Viewing DC Operating Point Results
Performance Analysis and Histograms
The Command Shell
Command Line
Editing the Menu System
User Defined Toolbars and Buttons
Message Window
Command and Function Reference
Introduction
Command Summary
Reference
Function Summary
Function Reference
Monte Carlo Analysis
Monte Carlo Analysis
An Example
Part Tolerance Specification
Running Monte Carlo
Analysing Monte-Carlo Results
Verilog-HDL Simulation
Overview
Documentation
Supported Verilog Simulators
Basic Operation
Using Verilog-HDL in SIMetrix Schematics
Module Cache
Simulation Options
Tutorial
Verilog Simulator Interface
Sundry Topics
Saving and Restoring Sessions
Symbolic Path Names
SIMetrix Command Line Parameters
Configuration Settings
Options
Startup Auto Configuration
Colours and Fonts
Startup Script
International Character Sets
Installation and Licensing
Simulator Reference
Introduction
Overview
The SIMetrix Simulator - What is it?
What is in This Manual
Running the Simulator
Using the Simulator with the Schematic Editor
Running in non-GUI Mode
Configuration Settings
Netlist Format
Simulator Output
Data Handling - Controlling Data Saved
Simulator Devices
Overview
Using XSPICE Devices
Using Expressions
Subcircuits
Model Binning
Language Differences
Customising Device Configuration
Initial Conditions
Analog Device Reference
Overview
Further Documentation
AC Table Lookup (including S-Parameters)
Arbitrary Source
Bipolar Junction Transistor (SPICE Gummel Poon)
Bipolar Junction Transistor ( VBIC without self heating)
Bipolar Junction Transistor (VBIC with self heating)
Bipolar Junction Transistor (MEXTRAM)
Bipolar Junction Transistor (HICUM)
Capacitor
Current Controlled Current Source
Current Controlled Voltage Source
Current Source
Diode - Level 1 and Level 3
Diode - Soft Recovery
GaAsFET
Inductor (Ideal)
Inductor (Saturable)
Inductor (Table lookup)
Insulated Gate Bipolar Transistor
Junction FET
Laplace Transfer Function - Lumped Implementation
Laplace Transfer Function - Convolution Implementation
Lossy Transmission Line
MOSFET
BSIM3 MOSFETs
BSIM4 MOSFETs
HiSim HV MOSFET
MOSFET GMIN Implementation
PSP MOSFET
Resistor
Resistor - Hspice Compatible
CMC Resistor
Subcircuit Instance
Transmission Line
Voltage Controlled Current Source
Voltage Controlled Switch
Voltage Controlled Voltage Source
Voltage Source
Mutual Inductor
Verilog-HDL Interface (VSXA)
NXP Compact Models
Digital/Mixed Signal Device Reference
Digital Device Overview
And Gate
D-type Latch
D-type Flip Flop
Buffer
Frequency Divider
Digital Initial Condition
Digital Pulse
Digital Signal Source
Inverter
JK Flip Flop
Arbitrary Logic Block
Nand Gate
Nor Gate
Open-Collector Buffer
Open-Emitter Buffer
Or Gate
Pulldown Resistor
Pullup Resistor
Random Access Memory
Set-Reset Flip-Flop
SR Latch
State Machine
Toggle Flip Flop
Tri-State Buffer
Exclusive NOR Gate
Exclusive OR Gate
Analog-Digital Converter
Analog-Digital Interface Bridge
Digital-Analog Converter
Digital-Analog Interface Bridge
Controlled Digital Oscillator
Analog-Digital Schmitt Trigger
Command Reference
Overview
General Sweep Specification
Multi Step Analyses
.AC
.ALIAS
.DC
.FILE and .ENDF
.FUNC
.GLOBAL
.GRAPH
.IC
.INC
.KEEP
.LOAD
.LIB
.MAP
.MODEL
.NOCONV
.NODESET
.NOISE
.OP
.OPTIONS
.PARAM
.POST_PROCESS
.PRINT
.SENS
.SETSOA
.SUBCKT and .ENDS
.TEMP
.TF
.TRACE
.TRAN
Real Time Noise Analysis
Monte Carlo Analysis
Overview
Specifying a Monte Carlo Run
Specifying a Single Step Monte Carlo Sweep
Log File
Seeding the Random Number Generator
Specifying Tolerances
Convergence, Accuracy and Performance
Overview
DC Operating Point
Transient Analysis
DC Sweep
DC Operating Point Algorithms
Singular Matrix Errors
Transient Analysis - `Time step too small' Error
Accuracy and Integration Methods
Using Multiple Core Systems
Matrix Solver
Digital Simulation
Overview
Logic States
Analog to Digital Interfaces
Logic Families
Load Delay
Digital Model Libraries
Arbitrary Logic Block - User Defined Models
Mixed-mode Simulator - How it Works
Enhancements over XSPICE
SIMetrix Script Manual
Introduction
The SIMetrix Script Language
A Tutorial
Variables, Constants and Types
Expressions
Statements and Commands
Accessing Simulation Data
User Interface to Scripts
Errors
Executing Scripts
Unsupported Functions and Commands
Function Summary
Functions by Application
abs Function
ACSourceDialog Function
ACSourceDialogStr Function
AddConfigCollection Function
AddGraphCrossHair Function
AddModelFiles Function
AddPropertyDialog Function
AddRemoveDialog Function
AddRemoveDialogNew Function
AddSymbolFiles Function
area Function
arg Function
arg_rad Function
Ascii Function
AssociateModel Function
atan Function
atan_deg Function
avg Function
BoolSelect Function
Branch Function
BuildParameterString Function
CanOpenFile Function
ChangeDir Function
Char Function
CheckLaplaceExpression Function
ChooseDir Function
ChooseDirectory Function
Chr Function
CloseEchoFile Function
CloseFile Function
CloseSchematic Function
CloseSchematicTab Function
CollateVectors Function
CommandStatus Function
CompareSymbols Function
ComposeDigital Function
ConvertFromBase64 Function
ConvertIsoTimeToUnix Function
ConvertLocalToUnix Function
ConvertNumberFromBase64 Function
ConvertNumberToBase64 Function
ConvertToBase64 Function
ConvertUnixTimeToIso Function
ConvertUnixToLocal Function
CopyTree Function
CopyURL Function
cos Function
cos_deg Function
cosh Function
CountChars Function
CreateDiodeDialog Function
CreateLockFile Function
CreateNewTitleBlockDialog Function
CreateShortcut Function
CreateTimer Function
cv Function
CyclePeriod Function
Date Function
db Function
DCSourceDialog Function
DCSourceDialogStr Function
DefineADCDialog Function
DefineArbSourceDialog Function
DefineBusPlotDialog Function
DefineCounterDialog Function
DefineCurveDialog Function
DefineDACDialog Function
DefineFourierDialog Function
DefineFourierProbeDialog Function
DefineIdealTxDialog Function
DefineLaplaceDialog Function
DefineLogicGateDialog Function
DefinePerfAnalysisDialog Function
DefineRegisterDialog Function
DefineRipperDialog Function
DefineSaturableTxDialog Function
DefineShiftRegDialog Function
DefineSimplisMultiStepDialog Function
DeleteConfigCollection Function
DeleteTimer Function
DeleteTree Function
DeleteTreeProgress Function
DescendDirectories Function
DescendHierarchy Function
DialogDesigner Function
diff Function
DirectoryIsWriteable Function
Distribution Function
EditArcDialog Function
EditAxisDialog Function
EditBodePlotProbeDialog Function
EditCrosshairDimensionDialog Function
EditCurveMarkerDialog Function
EditDeviceDialog Function
EditDigInitDialog Function
EditFileDefinedPWLDialog Function
EditFreeTextDialog Function
EditGraphTextBoxDialog Function
EditLegendBoxDialog Function
EditObjectPropertiesDialog Function
EditPinDialog Function
EditPotDialog Function
EditProbeDialog Function
EditPropertyDialog Function
EditReactiveDialog Function
EditSelect Function
EditSimplisMosfetDriverDialog Function
EditStylesDialog Function
EditTimer Function
EditWaveformDialog Function
EditWaveformStrDialog Function
ElementProps Function
EncodeImageToBase64 Function
EnterTextDialog Function
EpochTime Function
erf Function
erfc Function
EscapeString Function
EscapeStringEncode Function
ev Function
Execute Function
ExistCommand Function
ExistDir Function
ExistFile Function
ExistFunction Function
ExistSymbol Function
ExistVec Function
exp Function
fft Function
Field Function
FilterEditMenu Function
FilterFile Function
FindModel Function
FIR Function
Floor Function
floorv Function
FormatNumber Function
Fourier Function
FourierOptionsDialog Function
FourierWindow Function
FullPath Function
gamma Function
Gauss Function
GaussLim Function
GaussTrunc Function
GenPrintDialog Function
GetActualPath Function
GetAllCurves Function
GetAllSimulatorDevices Function
GetAllSymbolPropertyNames Function
GetAllYAxes Function
GetAnalysisInfo Function
GetAnalysisLines Function
GetAnnotationText Function
GetAxisCurves Function
GetAxisLimits Function
GetAxisType Function
GetAxisUnits Function
GetChildModulePorts Function
GetCodecNames Function
GetColours Function
GetColourSpec Function
GetCompatiblePathName Function
GetComponentValue Function
GetConfigLoc Function
GetConnectedPins Function
GetConvergenceInfo Function
GetCurDir Function
GetCurrentGraph Function
GetCurrentStepValue Function
GetCursorCurve Function
GetCurveAxis Function
GetCurveName Function
GetCurves Function
GetCurveVector Function
GetDatumCurve Function
GetDeviceDefinition Function
GetDeviceInfo Function
GetDeviceParameterNames Function
GetDevicePins Function
GetDeviceStats Function
GetDotParamNames Function
GetDotParamValue Function
GetDriveType Function
GetEmbeddedFileName Function
GetEnvVar Function
GetEthernetAddresses Function
GetF11Lines Function
GetFile Function
GetFileCD Function
GetFileDir Function
GetFileExtensions Function
GetFileInfo Function
GetFileSave Function
GetFileVersionStamp Function
GetFileViewerSelectedFiles Function
GetFirstSelectedElementOfType Function
GetFonts Function
GetFontSpec Function
GetFreeDiskSpace Function
GetGraphObjects Function
GetGraphObjects Function
GetGraphObjPropNames Function
GetGraphObjPropValue Function
GetGraphObjPropValues Function
GetGraphTabs Function
GetGraphTitle Function
GetGroupInfo Function
GetGroupStepParameter Function
GetGroupStepVals Function
GetHighlightedWidgetId Function
GetHostId Function
GetInstanceBounds Function
GetInstanceParamValues Function
GetInstancePinLocs Function
GetInstsAtPoint Function
GetInternalDeviceName Function
GetKeyDefs Function
GetKnownFolderPath Function
GetLaplaceErrorMessage Function
GetLastCommand Function
GetLastError Function
GetLastGraphObjectAdded Function
GetLegendProperties Function
GetLibraryModels Function
GetLicenseInfo Function
GetLicenseStats Function
GetLine Function
GetListSelected Function
GetListUnselected Function
GetLongPathName Function
GetMaxCores Function
GetMD5 Function
GetMD5String Function
GetMenuItems Function
GetModelFiles Function
GetModelLibraryErrors Function
GetModelName Function
GetModelParameterNames Function
GetModelParameters Function
GetModelParameterValues Function
GetModelType Function
GetModifiedStatus Function
GetNamedSymbolPins Function
GetNamedSymbolPropNames Function
GetNamedSymbolPropValue Function
GetNearestNet Function
GetNextDefaultStyleName Function
GetNodeNames Function
GetNonDefaultOptions Function
GetNumCurves Function
GetOpenSchematics Function
GetOption Function
GetPath Function
GetPlatformFeatures Function
GetPrinterInfo Function
GetPrintValues Function
GetReadOnlyStatus Function
GetRegistryClassesRootKeys Function
GetSchematicFileVersion Function
GetSchematicTabs Function
GetSchematicVersion Function
GetSchemTitle Function
GetSelectedAnnotationText Function
GetSelectedCurves Function
GetSelectedGraphAnno Function
GetSelectedStyleNames Function
GetSelectedYAxis Function
GetShortPathName Function
GetSimConfigLoc Function
GetSimetrixFile Function
GetSIMPLISExitCode Function
GetSimulationErrors Function
GetSimulationInfo Function
GetSimulationSeeds Function
GetSimulatorEvents Function
GetSimulatorMode Function
GetSimulatorOption Function
GetSimulatorOptionInfo Function
GetSimulatorOptions Function
GetSimulatorStats Function
GetSimulatorStatus Function
GetSoaDefinitions Function
GetSoaMaxMinResults Function
GetSoaOverloadResults Function
GetSoaResults Function
GetSymbolArcInfo Function
GetSymbolFiles Function
GetSymbolInfo Function
GetSymbolOrigin Function
GetSymbolPropertyInfo Function
GetSymbolPropertyNames Function
GetSymbols Function
GetSystemInfo Function
GetTempFile Function
GetTextEditorText Function
GetThreadTimes Function
GetTimerInfo Function
GetTitleBlockInfo Function
GetToolBarDefinition Function
GetToolButtons Function
GetUncPath Function
GetUserFile Function
GetVecStepParameter Function
GetVecStepVals Function
GetWidgetInfo Function
GetWindowNames Function
GetXAxis Function
GraphImageCapture Function
GraphLimits Function
GroupDelay Function
Groups Function
GuiType Function
Hash Function
HashAdd Function
HashCreate Function
HashDelete Function
HashSearch Function
HasLogSpacing Function
HasProperty Function
HaveFeature Function
HaveInternalClipboardData Function
HierarchyHighlighting Function
HighlightedNets Function
Histogram Function
Iff Function
IffV Function
IIR Function
im Function
imag Function
InitRandom Function
InputGraph Function
InputSchem Function
Instances Function
InstNets Function
InstNets2 Function
InstPins Function
InstPoints Function
InstProps Function
integ Function
Interp Function
IsComplex Function
IsComponent Function
IsDocumented Function
IsFileOfType Function
IsFullPath Function
IsImageFile Function
IsModelFile Function
IsNum Function
IsOptionMigrateable Function
IsSameFile Function
IsScript Function
IsStr Function
IsTextEditor Function
IsTextEditorModified Function
JoinStringArray Function
JoinVectors Function
length Function
ListDirectory Function
ListSchemProps Function
ln Function
LoadFile Function
Locate Function
log Function
log10 Function
mag Function
magnitude Function
makecomplexvec Function
MakeDir Function
MakeLogicalPath Function
MakeString Function
makevec Function
ManageDataGroupsDialog Function
ManageMeasureDialog Function
MapArray Function
max Function
maxidx Function
Maxima Function
Maximum Function
mean Function
Mean1 Function
MeasureDialog Function
MessageBox Function
Mid Function
min Function
minidx Function
Minima Function
Minimum Function
MkVec Function
MLRidgeRegressionFit Function
MLSplineFit Function
MLVector Function
ModelLibsChanged Function
Navigate Function
NearestInst Function
NetName Function
NetNames Function
NetWires Function
NewPassiveDialog Function
NewValueDialog Function
norm Function
NumberSelectedAnnotations Function
NumDivisions Function
NumElems Function
OpenEchoFile Function
OpenFile Function
OpenPDFPrinter Function
OpenPrinter Function
OpenSchem Function
OpenSchematic Function
Parse Function
ParseAnalysis Function
ParseEscape Function
ParseLaplace Function
ParseParameterString Function
ParseParameterString2 Function
ParseProbeExpression Function
ParseSIMPLISInit Function
PathEqual Function
PerCycleTiming Function
PerCycleValue Function
ph Function
phase Function
phase_rad Function
PhysType Function
PinName Function
PrepareSetComponentValue Function
PreProcessNetlist Function
Probe Function
ProcessingAccelerator Function
ProcessingDragAndDrop Function
ProcessingGuiAction Function
Progress Function
PropFlags Function
PropFlags2 Function
PropFlagsAll Function
PropFlagsAnnotations Function
PropFlagsWires Function
PropOverrideStyle Function
PropValue Function
PropValues Function
PropValues2 Function
PropValuesAll Function
PropValuesAnnotations Function
PropValuesWires Function
PutEnvVar Function
PWLDialog Function
QueryData Function
RadioSelect Function
Range Function
re Function
ReadClipboard Function
ReadConfigCollection Function
ReadConfigSetting Function
ReadF11Analyses Function
ReadF11Options Function
ReadFile Function
ReadIniKey Function
ReadRegSetting Function
ReadSchemProp Function
ReadSIMPLISF11Data Function
ReadSpiceFile Function
ReadTextEditorProp Function
real Function
Ref Function
RefName Function
RegExp Function
RelativePath Function
RemapDevice Function
RemoveConfigCollection Function
RemoveModelFile Function
RemoveSymbolFiles Function
ResolveGraphTemplate Function
ResolveTemplate Function
RestartTranDialog Function
Rms Function
RMS1 Function
rnd Function
RootSumOfSquares Function
rt Function
SaveSpecialDialog Function
Scan Function
ScanEscape Function
ScriptName Function
Search Function
SearchModels Function
Seconds Function
Select2Dialog Function
SelectAnalysis Function
SelectColourDialog Function
SelectColumns Function
SelectCount Function
SelectDevice Function
SelectDialog Function
SelectedProperties Function
SelectedStyleInfo Function
SelectedWires Function
SelectFontDialog Function
SelectRows Function
SelectSIMPLISAnalysis Function
SelectSymbolDialog Function
SelGraph Function
SelSchem Function
SetComponentValue Function
SetDifference Function
SetInstanceParamValue Function
SetIntersect Function
SetModelParamValue Function
SetPropertyStyles Function
SetReadOnlyStatus Function
SetSymmetricDifference Function
SetUnion Function
Shell Function
ShellExecute Function
ShiftRef Function
sign Function
SimetrixFileInfo Function
SIMPLISRunStatus Function
SIMPLISSearchIdx Function
SimulationHasErrors Function
sin Function
sin_deg Function
sinh Function
Sleep Function
Sort Function
SortIdx Function
SourceDialog Function
SpectrumUniv Function
SplitPath Function
SplitString Function
SprintfNumber Function
sqrt Function
Str Function
StringLength Function
StringStartsWith Function
StrStr Function
StyleInfo Function
StyleLineTypes Function
StyleNames Function
SubstChar Function
SubstProbeExpression Function
SubstString Function
sum Function
SumNoise Function
SupportedReadFormats Function
SupportedWriteFormats Function
SymbolInfoDialog Function
SymbolLibraryManagerDialog Function
SymbolName Function
SymbolNames Function
SymbolPinOrder Function
SymbolPinPoints Function
SystemValue Function
SystemValuePath Function
SystemWidgetExistsInSelectedWindow Function
TableDialog Function
TableEditor Function
tan Function
tan_deg Function
tanh Function
TemplateGetPropValue Function
TemplateResolve Function
TextEditorHasComments Function
ThdWeight Function
TickCount Function
Time Function
ToLower Function
TransformerDialog Function
TranslateLogicalPath Function
TreeListDialog Function
True Function
Truncate Function
TwoFileSelectionDialog Function
UD Function
Unif Function
Units Function
unitvec Function
UpDownDialog Function
UserParametersDialog Function
Val Function
ValueDialog Function
Vec Function
vector Function
VectorsInGroup Function
VersionInfo Function
ViewFormattedText Function
WC Function
WirePoints Function
Wires Function
WM_CanRevertToSaved Function
WM_GetCentralWidgetGeometry Function
WM_GetContentWidgetNames Function
WM_GetContentWidgetSessionInfo Function
WM_GetContentWidgetsLayout Function
WM_GetContentWidgetTypes Function
WM_GetCurrentWindowName Function
WM_GetNumberModifiedEditors Function
WM_GetPrimaryWindowName Function
WM_GetSystemWidgetSessionInfo Function
WM_GetSystemWidgetsLayout Function
WM_GetWindowGeometry Function
WM_GetWindowNames Function
WM_NumberContentWidgets Function
WM_NumberSystemWidgets Function
WriteConfigSetting Function
WriteF11Lines Function
WriteF11Options Function
WriteIniKey Function
WriteRawData Function
WriteRegSetting Function
WriteSchemProp Function
XCursor Function
XDatum Function
XFromY Function
XMLCountElements Function
XMLGetAttribute Function
XMLGetElements Function
XMLGetText Function
XMLToString Function
XY Function
YCursor Function
YDatum Function
YFromX Function
Command Summary
Abort Command
AbortSIMPLIS Command
About Command
AddAnnotationText Command
AddArc Command
AddCirc Command
AddCurveMarker Command
AddDoubleClickAction Command
AddFileViewMenuItem Command
AddFloodFill Command
AddFreeText Command
AddGlobalStyle Command
AddGraphDimension Command
AddImage Command
AddImageScript Command
AddLegend Command
AddLegendProp Command
AddPin Command
AddProp Command
AddProperty Command
AddSeg Command
AddSymbolProperty Command
AddTextBox Command
AddTitleBlock Command
AlignText Command
Anno Command
AppendGroup Command
AppendTextWindow Command
Arguments Command
BuildDefaultOptions Command
Cancel Command
CaptureWaveformImage Command
Cd Command
ChangeArcAttributes Command
ChangeSelectedStyleNames Command
ChangeStyle Command
ChangeSymbolProperty Command
ClearMessageWindow Command
Close Command
CloseGraphSheet Command
ClosePrinter Command
CloseSchem Command
CloseSheet Command
CloseSimplisStatusBox Command
CloseTextEditor Command
CollectGarbage Command
CombineMenu Command
CompareSymbolLibs Command
CompressXML Command
Copy Command
CopyClipGraph Command
CopyClipSchem Command
CopyFile Command
CopyLocalSymbol Command
CreateFont Command
CreateGroup Command
CreateRunningDialog Command
CreateSym Command
CreateToolBar Command
CreateToolButton Command
CursorMode Command
Curve Command
CurveEditCopy Command
DecompressXML Command
DefButton Command
DefineToolBar Command
DefKey Command
DefMenu Command
Del Command
DelCrv Command
Delete Command
DeleteAxis Command
DeleteGraphAnno Command
DeleteSymbolProperty Command
DeleteToolBar Command
DelGroup Command
DelLegendProp Command
DelMenu Command
DelProp Command
DelSym Command
DestroyRunningDialog Command
Detach Command
Discard Command
Display Command
DrawArc Command
DrawArrow Command
DrawPin Command
Echo Command
EditColour Command
EditCopy Command
EditCut Command
EditFile Command
EditFont Command
EditGroupTitle Command
EditPaste Command
EditPin Command
EndAllInteractions Command
EndSym Command
Execute Command
ExecuteMenu Command
FileViewCleanUpFileWatchers Command
FloodFillSymbol Command
Focus Command
FocusCommandShell Command
FocusShell Command
GraphZoomMode Command
GroupSelected Command
Help Command
HideCurve Command
HighlightCurve Command
HighlightWidget Command
Hint Command
HourGlass Command
ImportSymbol Command
Inst Command
KeepGroup Command
Let Command
Listing Command
ListModels Command
ListOptions Command
ListStdKeys Command
LoadModelIndex Command
LoadSimulatorStyleSheet Command
LoadStyleSheet Command
MakeAlias Command
MakeCatalog Command
MakeSymbolScript Command
MakeTree Command
MCD Command
MD Command
Message Command
MessageBox Command
Move Command
MoveCurve Command
MoveFile Command
MoveMenu Command
MoveProperty Command
Netlist Command
NewAnnotation Command
NewAxis Command
NewBasicTextEditor Command
NewFileView Command
NewGraphWindow Command
NewGrid Command
NewLabel Command
NewLogicDefinitionEditor Command
NewNetlist Command
NewPartSelector Command
NewPrinterPage Command
NewSchem Command
NewScript Command
NewStyle Command
NewSymbol Command
NewVerilogA Command
NewVerilogHDL Command
NoPaint Command
NoUndo Command
OpenAsciiFile Command
OpenBasicTextEditor Command
OpenDirectory Command
OpenExternalFile Command
OpenGraph Command
OpenGroup Command
OpenLogicDefinitionEditor Command
OpenNetlist Command
OpenPrinter Command
OpenRawFile Command
OpenSchem Command
OpenScript Command
OpenSimplisStatusBox Command
OpenVerilogA Command
OpenVerilogHDL Command
OpenWebPage Command
OptionsDialog Command
Pan Command
PasteGraphImageToSchematic Command
Pause Command
PlaceCursor Command
Plot Command
PreProcessNetlist Command
PrintGraph Command
PrintSchematic Command
Probe Command
Prop Command
Protect Command
Quit Command
RD Command
ReadLogicCompatibility Command
RebuildSymbols Command
Redirect Command
RedirectMessages Command
RedrawGraph Command
RegisterUserFunction Command
RenameLibs Command
RenameMenu Command
RepeatLastMenu Command
ReplayTraces Command
Reset Command
ResizeWindow Command
RestartTran Command
RestoreCommandShell Command
RestoreDefaultStyles Command
Resume Command
RotInst Command
Run Command
RunAsync Command
RunCurrentScript Command
RunSIMPLIS Command
Save Command
SaveAs Command
SaveGraph Command
SaveGroup Command
SaveRhs Command
SaveSnapShot Command
SaveSymbol Command
SaveSymlib Command
SaveTextEditor Command
SaveTextEditorAs Command
SchematicEnableFileWatcher Command
SchematicFileWatcherIgnoreChanges Command
SchematicFileWatcherWatchChanges Command
ScreenShotWindow Command
ScriptAbort Command
ScriptPause Command
ScriptResume Command
ScriptStep Command
Select Command
SelectCurve Command
SelectGraph Command
SelectLegends Command
SelectSchematic Command
SelectSimulator Command
SelectSymbolPin Command
SelectWireConnected Command
Set Command
SetAnnotationTextPosition Command
SetCurveName Command
SetDefaultEncoding Command
SetGraphAnnoProperty Command
SetGroup Command
SetHighlight Command
SetOrigin Command
SetPinPrefix Command
SetPinSuffix Command
SetReadOnly Command
SetRef Command
SetSnapGrid Command
SetStyleColour Command
SetSymbolFillStyle Command
SetSymbolOriginVisibility Command
SetUnits Command
Shell Command
ShellOld Command
Show Command
ShowCurve Command
ShowSimulatorWindow Command
SizeGraph Command
TemplateEditProperty Command
TemplateSetValue Command
TextEditorCommentLines Command
TextEditorFileWatcherIgnoreChanges Command
TextEditorFileWatcherWatchChanges Command
TextEditorFind Command
TextEditorFindNext Command
TextEditorGoToLine Command
TextEditorUncommentLines Command
TextWin Command
Title Command
TitleSchem Command
Trace Command
UndoGraphZoom Command
UngroupSelected Command
UnHighlightCurves Command
UnLet Command
Unprotect Command
Unselect Command
UnSet Command
UpdateAllSymbols Command
UpdateAnnotationText Command
UpdateDefaultStyle Command
UpdateGlobalStyle Command
UpdateProperties Command
UpdateRunningDialog Command
UpdateStyleInfo Command
UpdateSymbol Command
UpdateSystemStyleInfo Command
UpdateTitleBlock Command
ViewFile Command
WebOpen Command
Wire Command
WireMode Command
WM_CloseAllSystemWidgets Command
WM_CloseNonPrimaryWindows Command
WM_CloseSheet Command
WM_ProgressWindowClose Command
WM_ProgressWindowCloseAll Command
WM_ProgressWindowCreate Command
WM_ProgressWindowReport Command
WM_RevertToSaved Command
WM_Undock Command
WriteImportedModels Command
XMLAddAttribute Command
XMLAddElement Command
XMLClose Command
XMLGoUpLevel Command
XMLNew Command
XMLOpenElement Command
XMLOpenFile Command
XMLSaveFile Command
Zoom Command
Applications
User Interface
Custom Curve Analysis
Automating Simulations
Schematic Symbol Script Definition
Data Import and Export
Graph Objects
Event Scripts
User Defined Script Based Functions
User Defined Binary Functions
Non-interactive and Customised Printing
Schematic Template Scripts
Creating and Modifying Toolbars
Custom Dialog Boxes
Pre-defined Buttons
Verilog A Reference
Introduction
What Is Verilog-A?
Verilog-A Language Reference Manual
Using Verilog-A Compiler
Using Verilog-A with SIMetrix Schematics
Defining Verilog-A Files in Netlist
Messages
.LOAD Full Syntax
Verilog-A Cache
Permananent .SXDEV Installation
Writing Verilog-A Code
Overview
Verilog-A Text Editor
Hello World!
A Simple Device Model
A Resistor
A Soft Limiter
A Capacitor
A Voltage Controlled Oscillator
Digital Elements - Overview
Digital Gate
Butterworth Filter
RC Ladder - Loops, Vectored Nodes and genvars
Verilog-A Reference
Verilog-A Reference
Verilog-A Functions
Analog Operator Restrictions
Implementation - vs LRM
Overview
SIMetrix Verilog-A vs LRM 2.2
SIMetrix Extensions
Verilog-A Interaction with SIMetrix Features
SIMPLIS Reference
Introduction
Overview
Organization of this User Manual
Input File Organization
Overview
General Rules for the Input File
Organization of the Input File
Device Statements
Overview
SIMPLIS Device Types
Model Statements
Overview
Device Models Used in Simplis
Subcircuit Definition
Overview
Subcircuit Definition
Scope of Definition
Scope of Definition for a Device and for a Node
External and Local Nodes
Subcircuit Calls/Instantiation
Control Statements
Overview
Option Statements
Control Statements for Setting Initial Conditions
Control Statements for Printing Variables
Mapping Names to Node Numbers
Creating SIMetrix Plots
Control Statements Associated with Analyses
Running SIMPLIS
Overview
Running SIMPLIS on a SIMetrix Schematic
Running SIMPLIS for an External Netlist
Running SIMPLIS from a Script
Running SIMPLIS from a DOS Prompt
SIMPLIS Execution
Aborting a SIMPLIS Run
Automatic Program Suspension by SIMPLIS
Netlist Preprocessor
Running Monte Carlo and Multi-step Analyses
Simplis Data Files
Overview
The Listing Data File
Error Message Data File
The ``State of Exit'' Data File
Switching Instance Data File
Time-domain Data Output
The Topology Information File
Taking Advantage of Existing Files
Switching Instance Data File for the POP Analysis
Data for the Periodic Operating Point Analysis
Print/Plot File for Frequency-Domain Analysis
Simplis-TX Examples
Overview
Example 1 -- Rectifier with RC load
Example 2 -- 3-Phase Rectifier with Resistive Load
Example 3 -- Operational Amplifier with Saturation
Example 4 -- Unregulated Converter
Example 5 -- Regulated Converter
Example 6 -- Saturable Inductor
Example 7 -- SCR with RL Load
Simplis-POP
Overview
Statements Relating to POP Analysis
Synopsis of the Periodic Operating Point Analysis
Example of Applying the POP Analysis Tool
Simplis-FX
Overview
Statements Relating AC Analysis
Synopsis of Small-Signal AC Analysis
Advanced Digital Components
Overview
Advanced Digital Component Reference
Search
Home
SIMetrix Script Manual
Function Summary
GetColours Function
GetColours Function
Returns the names of built-in colour objects.
Arguments
No arguments
Returns
Return type: string array
▲Function Summary▲
◄ GetCodecNames
GetColourSpec ▶
SIMetrix Script Manual
Introduction
The SIMetrix Script Language
Function Summary
Functions by Application
abs Function
ACSourceDialog Function
ACSourceDialogStr Function
AddConfigCollection Function
AddGraphCrossHair Function
AddModelFiles Function
AddPropertyDialog Function
AddRemoveDialog Function
AddRemoveDialogNew Function
AddSymbolFiles Function
area Function
arg Function
arg_rad Function
Ascii Function
AssociateModel Function
atan Function
atan_deg Function
avg Function
BoolSelect Function
Branch Function
BuildParameterString Function
CanOpenFile Function
ChangeDir Function
Char Function
CheckLaplaceExpression Function
ChooseDir Function
ChooseDirectory Function
Chr Function
CloseEchoFile Function
CloseFile Function
CloseSchematic Function
CloseSchematicTab Function
CollateVectors Function
CommandStatus Function
CompareSymbols Function
ComposeDigital Function
ConvertFromBase64 Function
ConvertIsoTimeToUnix Function
ConvertLocalToUnix Function
ConvertNumberFromBase64 Function
ConvertNumberToBase64 Function
ConvertToBase64 Function
ConvertUnixTimeToIso Function
ConvertUnixToLocal Function
CopyTree Function
CopyURL Function
cos Function
cos_deg Function
cosh Function
CountChars Function
CreateDiodeDialog Function
CreateLockFile Function
CreateNewTitleBlockDialog Function
CreateShortcut Function
CreateTimer Function
cv Function
CyclePeriod Function
Date Function
db Function
DCSourceDialog Function
DCSourceDialogStr Function
DefineADCDialog Function
DefineArbSourceDialog Function
DefineBusPlotDialog Function
DefineCounterDialog Function
DefineCurveDialog Function
DefineDACDialog Function
DefineFourierDialog Function
DefineFourierProbeDialog Function
DefineIdealTxDialog Function
DefineLaplaceDialog Function
DefineLogicGateDialog Function
DefinePerfAnalysisDialog Function
DefineRegisterDialog Function
DefineRipperDialog Function
DefineSaturableTxDialog Function
DefineShiftRegDialog Function
DefineSimplisMultiStepDialog Function
DeleteConfigCollection Function
DeleteTimer Function
DeleteTree Function
DeleteTreeProgress Function
DescendDirectories Function
DescendHierarchy Function
DialogDesigner Function
diff Function
DirectoryIsWriteable Function
Distribution Function
EditArcDialog Function
EditAxisDialog Function
EditBodePlotProbeDialog Function
EditCrosshairDimensionDialog Function
EditCurveMarkerDialog Function
EditDeviceDialog Function
EditDigInitDialog Function
EditFileDefinedPWLDialog Function
EditFreeTextDialog Function
EditGraphTextBoxDialog Function
EditLegendBoxDialog Function
EditObjectPropertiesDialog Function
EditPinDialog Function
EditPotDialog Function
EditProbeDialog Function
EditPropertyDialog Function
EditReactiveDialog Function
EditSelect Function
EditSimplisMosfetDriverDialog Function
EditStylesDialog Function
EditTimer Function
EditWaveformDialog Function
EditWaveformStrDialog Function
ElementProps Function
EncodeImageToBase64 Function
EnterTextDialog Function
EpochTime Function
erf Function
erfc Function
EscapeString Function
EscapeStringEncode Function
ev Function
Execute Function
ExistCommand Function
ExistDir Function
ExistFile Function
ExistFunction Function
ExistSymbol Function
ExistVec Function
exp Function
fft Function
Field Function
FilterEditMenu Function
FilterFile Function
FindModel Function
FIR Function
Floor Function
floorv Function
FormatNumber Function
Fourier Function
FourierOptionsDialog Function
FourierWindow Function
FullPath Function
gamma Function
Gauss Function
GaussLim Function
GaussTrunc Function
GenPrintDialog Function
GetActualPath Function
GetAllCurves Function
GetAllSimulatorDevices Function
GetAllSymbolPropertyNames Function
GetAllYAxes Function
GetAnalysisInfo Function
GetAnalysisLines Function
GetAnnotationText Function
GetAxisCurves Function
GetAxisLimits Function
GetAxisType Function
GetAxisUnits Function
GetChildModulePorts Function
GetCodecNames Function
GetColours Function
GetColourSpec Function
GetCompatiblePathName Function
GetComponentValue Function
GetConfigLoc Function
GetConnectedPins Function
GetConvergenceInfo Function
GetCurDir Function
GetCurrentGraph Function
GetCurrentStepValue Function
GetCursorCurve Function
GetCurveAxis Function
GetCurveName Function
GetCurves Function
GetCurveVector Function
GetDatumCurve Function
GetDeviceDefinition Function
GetDeviceInfo Function
GetDeviceParameterNames Function
GetDevicePins Function
GetDeviceStats Function
GetDotParamNames Function
GetDotParamValue Function
GetDriveType Function
GetEmbeddedFileName Function
GetEnvVar Function
GetEthernetAddresses Function
GetF11Lines Function
GetFile Function
GetFileCD Function
GetFileDir Function
GetFileExtensions Function
GetFileInfo Function
GetFileSave Function
GetFileVersionStamp Function
GetFileViewerSelectedFiles Function
GetFirstSelectedElementOfType Function
GetFonts Function
GetFontSpec Function
GetFreeDiskSpace Function
GetGraphObjects Function
GetGraphObjects Function
GetGraphObjPropNames Function
GetGraphObjPropValue Function
GetGraphObjPropValues Function
GetGraphTabs Function
GetGraphTitle Function
GetGroupInfo Function
GetGroupStepParameter Function
GetGroupStepVals Function
GetHighlightedWidgetId Function
GetHostId Function
GetInstanceBounds Function
GetInstanceParamValues Function
GetInstancePinLocs Function
GetInstsAtPoint Function
GetInternalDeviceName Function
GetKeyDefs Function
GetKnownFolderPath Function
GetLaplaceErrorMessage Function
GetLastCommand Function
GetLastError Function
GetLastGraphObjectAdded Function
GetLegendProperties Function
GetLibraryModels Function
GetLicenseInfo Function
GetLicenseStats Function
GetLine Function
GetListSelected Function
GetListUnselected Function
GetLongPathName Function
GetMaxCores Function
GetMD5 Function
GetMD5String Function
GetMenuItems Function
GetModelFiles Function
GetModelLibraryErrors Function
GetModelName Function
GetModelParameterNames Function
GetModelParameters Function
GetModelParameterValues Function
GetModelType Function
GetModifiedStatus Function
GetNamedSymbolPins Function
GetNamedSymbolPropNames Function
GetNamedSymbolPropValue Function
GetNearestNet Function
GetNextDefaultStyleName Function
GetNodeNames Function
GetNonDefaultOptions Function
GetNumCurves Function
GetOpenSchematics Function
GetOption Function
GetPath Function
GetPlatformFeatures Function
GetPrinterInfo Function
GetPrintValues Function
GetReadOnlyStatus Function
GetRegistryClassesRootKeys Function
GetSchematicFileVersion Function
GetSchematicTabs Function
GetSchematicVersion Function
GetSchemTitle Function
GetSelectedAnnotationText Function
GetSelectedCurves Function
GetSelectedGraphAnno Function
GetSelectedStyleNames Function
GetSelectedYAxis Function
GetShortPathName Function
GetSimConfigLoc Function
GetSimetrixFile Function
GetSIMPLISExitCode Function
GetSimulationErrors Function
GetSimulationInfo Function
GetSimulationSeeds Function
GetSimulatorEvents Function
GetSimulatorMode Function
GetSimulatorOption Function
GetSimulatorOptionInfo Function
GetSimulatorOptions Function
GetSimulatorStats Function
GetSimulatorStatus Function
GetSoaDefinitions Function
GetSoaMaxMinResults Function
GetSoaOverloadResults Function
GetSoaResults Function
GetSymbolArcInfo Function
GetSymbolFiles Function
GetSymbolInfo Function
GetSymbolOrigin Function
GetSymbolPropertyInfo Function
GetSymbolPropertyNames Function
GetSymbols Function
GetSystemInfo Function
GetTempFile Function
GetTextEditorText Function
GetThreadTimes Function
GetTimerInfo Function
GetTitleBlockInfo Function
GetToolBarDefinition Function
GetToolButtons Function
GetUncPath Function
GetUserFile Function
GetVecStepParameter Function
GetVecStepVals Function
GetWidgetInfo Function
GetWindowNames Function
GetXAxis Function
GraphImageCapture Function
GraphLimits Function
GroupDelay Function
Groups Function
GuiType Function
Hash Function
HashAdd Function
HashCreate Function
HashDelete Function
HashSearch Function
HasLogSpacing Function
HasProperty Function
HaveFeature Function
HaveInternalClipboardData Function
HierarchyHighlighting Function
HighlightedNets Function
Histogram Function
Iff Function
IffV Function
IIR Function
im Function
imag Function
InitRandom Function
InputGraph Function
InputSchem Function
Instances Function
InstNets Function
InstNets2 Function
InstPins Function
InstPoints Function
InstProps Function
integ Function
Interp Function
IsComplex Function
IsComponent Function
IsDocumented Function
IsFileOfType Function
IsFullPath Function
IsImageFile Function
IsModelFile Function
IsNum Function
IsOptionMigrateable Function
IsSameFile Function
IsScript Function
IsStr Function
IsTextEditor Function
IsTextEditorModified Function
JoinStringArray Function
JoinVectors Function
length Function
ListDirectory Function
ListSchemProps Function
ln Function
LoadFile Function
Locate Function
log Function
log10 Function
mag Function
magnitude Function
makecomplexvec Function
MakeDir Function
MakeLogicalPath Function
MakeString Function
makevec Function
ManageDataGroupsDialog Function
ManageMeasureDialog Function
MapArray Function
max Function
maxidx Function
Maxima Function
Maximum Function
mean Function
Mean1 Function
MeasureDialog Function
MessageBox Function
Mid Function
min Function
minidx Function
Minima Function
Minimum Function
MkVec Function
MLRidgeRegressionFit Function
MLSplineFit Function
MLVector Function
ModelLibsChanged Function
Navigate Function
NearestInst Function
NetName Function
NetNames Function
NetWires Function
NewPassiveDialog Function
NewValueDialog Function
norm Function
NumberSelectedAnnotations Function
NumDivisions Function
NumElems Function
OpenEchoFile Function
OpenFile Function
OpenPDFPrinter Function
OpenPrinter Function
OpenSchem Function
OpenSchematic Function
Parse Function
ParseAnalysis Function
ParseEscape Function
ParseLaplace Function
ParseParameterString Function
ParseParameterString2 Function
ParseProbeExpression Function
ParseSIMPLISInit Function
PathEqual Function
PerCycleTiming Function
PerCycleValue Function
ph Function
phase Function
phase_rad Function
PhysType Function
PinName Function
PrepareSetComponentValue Function
PreProcessNetlist Function
Probe Function
ProcessingAccelerator Function
ProcessingDragAndDrop Function
ProcessingGuiAction Function
Progress Function
PropFlags Function
PropFlags2 Function
PropFlagsAll Function
PropFlagsAnnotations Function
PropFlagsWires Function
PropOverrideStyle Function
PropValue Function
PropValues Function
PropValues2 Function
PropValuesAll Function
PropValuesAnnotations Function
PropValuesWires Function
PutEnvVar Function
PWLDialog Function
QueryData Function
RadioSelect Function
Range Function
re Function
ReadClipboard Function
ReadConfigCollection Function
ReadConfigSetting Function
ReadF11Analyses Function
ReadF11Options Function
ReadFile Function
ReadIniKey Function
ReadRegSetting Function
ReadSchemProp Function
ReadSIMPLISF11Data Function
ReadSpiceFile Function
ReadTextEditorProp Function
real Function
Ref Function
RefName Function
RegExp Function
RelativePath Function
RemapDevice Function
RemoveConfigCollection Function
RemoveModelFile Function
RemoveSymbolFiles Function
ResolveGraphTemplate Function
ResolveTemplate Function
RestartTranDialog Function
Rms Function
RMS1 Function
rnd Function
RootSumOfSquares Function
rt Function
SaveSpecialDialog Function
Scan Function
ScanEscape Function
ScriptName Function
Search Function
SearchModels Function
Seconds Function
Select2Dialog Function
SelectAnalysis Function
SelectColourDialog Function
SelectColumns Function
SelectCount Function
SelectDevice Function
SelectDialog Function
SelectedProperties Function
SelectedStyleInfo Function
SelectedWires Function
SelectFontDialog Function
SelectRows Function
SelectSIMPLISAnalysis Function
SelectSymbolDialog Function
SelGraph Function
SelSchem Function
SetComponentValue Function
SetDifference Function
SetInstanceParamValue Function
SetIntersect Function
SetModelParamValue Function
SetPropertyStyles Function
SetReadOnlyStatus Function
SetSymmetricDifference Function
SetUnion Function
Shell Function
ShellExecute Function
ShiftRef Function
sign Function
SimetrixFileInfo Function
SIMPLISRunStatus Function
SIMPLISSearchIdx Function
SimulationHasErrors Function
sin Function
sin_deg Function
sinh Function
Sleep Function
Sort Function
SortIdx Function
SourceDialog Function
SpectrumUniv Function
SplitPath Function
SplitString Function
SprintfNumber Function
sqrt Function
Str Function
StringLength Function
StringStartsWith Function
StrStr Function
StyleInfo Function
StyleLineTypes Function
StyleNames Function
SubstChar Function
SubstProbeExpression Function
SubstString Function
sum Function
SumNoise Function
SupportedReadFormats Function
SupportedWriteFormats Function
SymbolInfoDialog Function
SymbolLibraryManagerDialog Function
SymbolName Function
SymbolNames Function
SymbolPinOrder Function
SymbolPinPoints Function
SystemValue Function
SystemValuePath Function
SystemWidgetExistsInSelectedWindow Function
TableDialog Function
TableEditor Function
tan Function
tan_deg Function
tanh Function
TemplateGetPropValue Function
TemplateResolve Function
TextEditorHasComments Function
ThdWeight Function
TickCount Function
Time Function
ToLower Function
TransformerDialog Function
TranslateLogicalPath Function
TreeListDialog Function
True Function
Truncate Function
TwoFileSelectionDialog Function
UD Function
Unif Function
Units Function
unitvec Function
UpDownDialog Function
UserParametersDialog Function
Val Function
ValueDialog Function
Vec Function
vector Function
VectorsInGroup Function
VersionInfo Function
ViewFormattedText Function
WC Function
WirePoints Function
Wires Function
WM_CanRevertToSaved Function
WM_GetCentralWidgetGeometry Function
WM_GetContentWidgetNames Function
WM_GetContentWidgetSessionInfo Function
WM_GetContentWidgetsLayout Function
WM_GetContentWidgetTypes Function
WM_GetCurrentWindowName Function
WM_GetNumberModifiedEditors Function
WM_GetPrimaryWindowName Function
WM_GetSystemWidgetSessionInfo Function
WM_GetSystemWidgetsLayout Function
WM_GetWindowGeometry Function
WM_GetWindowNames Function
WM_NumberContentWidgets Function
WM_NumberSystemWidgets Function
WriteConfigSetting Function
WriteF11Lines Function
WriteF11Options Function
WriteIniKey Function
WriteRawData Function
WriteRegSetting Function
WriteSchemProp Function
XCursor Function
XDatum Function
XFromY Function
XMLCountElements Function
XMLGetAttribute Function
XMLGetElements Function
XMLGetText Function
XMLToString Function
XY Function
YCursor Function
YDatum Function
YFromX Function
Command Summary
Applications