Adex Ls Kill Ref 610

Virtuoso ADE XL SKILL Functions
Reference
Product Version 6.1
January 2007
1999-2007 Cadence Design Systems, Inc. All rights reserved.

Printed in the United States of America.
Cadence Design Systems, Inc., 555 River Oaks Parkway, San Jose, CA 95134, USA
Trademarks: Trademarks and service marks of Cadence Design Systems, Inc. ( Cadence ) contained in
this document are attributed to Cadence with the appropriate symbol. For queries regarding Cadences
trademarks, contact the corporate legal department at the address shown above or call 1-800-862-4522.
All other trademarks are the property of their respective holders.
Restricted Print Permission: This publication is protected by copyright and any unauthorized use of this
publication may violate copyright, trademark, and other laws. Except as specified in this permission
statement, this publication may not be copied, reproduced, modified, published, uploaded, posted,
transmitted, or distributed in any way, without prior written permission from Cadence. This statement grants
you permission to print one ( 1 ) hard copy of this publication subject to the following conditions:
1. The publication may be used solely for personal, informational, and noncommercial purposes;
2. The publication may not be modified in any way;
3. Any copy of the publication or portion thereof must include all original copyright, trademark, and other
proprietary notices and this permission statement; and
4. Cadence reserves the right to revoke this authorization at any time, and any such use shall be
discontinued immediately upon written notice from Cadence.
Disclaimer: Information in this publication is subject to change without notice and does not represent a
commitment on the part of Cadence. The information contained herein is the proprietary and confidential
information of Cadence or its licensors, and is supplied subject to, and may be used only by Cadences
customer in accordance with, a written agreement between Cadence and its customer. Except as may be
explicitly set forth in such agreement, Cadence does not make, and expressly disclaims, any
representations or warranties as to the completeness, accuracy or usefulness of the information contained
in this document. Cadence does not warrant that use of such information will not infringe any third party
rights, nor does Cadence assume any liability for damages or costs of any kind that may result from use of
such information.
Restricted Rights: Use, duplication, or disclosure by the Government is subject to restrictions as set forth
in FAR52.227-14 and DFAR252.227-7013 et seq. or its successor.
Virtuoso ADE XL SKILL Functions Reference
Contents
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Related Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Typographic and Syntax Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
1
Session-Related SKILL Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
axlCloseSession . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlCloseSessionInWindow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlCreateSession . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetAssociatedWindow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetMainSetupDB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetSessionHasGui . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetSyncFlag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlIsValidAXLSession . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlNewSession . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlNoSession . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlRegisterCustomDeviceFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlSetAssociatedWindow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlSetDefaultVariables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlSetMainSetupDB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlSetSyncFlag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlStopAll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlToolSetOriginalSetupOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlToolSetSetupOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlViewResDB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
35
37
2
Setup Database SKILL Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
axlCommitSetupDB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
axlCommitSetupDBAndHistoryAs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
January 2007
Product Version 6.1
axlCommitSetupDBas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetActiveSetup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetDescription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetElementParent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetEnabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetLocations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetParameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetParameterName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetParameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetParameterValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetResultsLocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetScript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetScriptPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetScripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetSetupDB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetSetupDBBaseName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetSetupDBDir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetTopLevel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetVar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetVars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetVarValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlIsDirty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlIsElement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlIsReadOnly . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlIsSetupDB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlNewSetupDB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlPutParameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlPutScript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlPutTest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlPutVar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlRemoveElement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlResetActive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlSaveAs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlSaveSetup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlSaveSetupToLib . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlSetDescription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
January 2007
44
45
46
47
48
49
50
51
52
53
54
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
Product Version 6.1
axlSetElementValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlSetEnabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlSetParameterName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlSetParameterValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlSetScriptPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlSetSetupDBName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlSetVarValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlWriteDatasheet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlWriteDatasheetForm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
81
82
84
85
86
87
88
89
91
3
Model-Related SKILL Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
axlGetModel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
axlGetModelBlock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
axlGetModelFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
axlGetModelGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
axlGetModelGroupName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
axlGetModelGroups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
axlGetModelSection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
axlGetModelTest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
axlGetModels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
axlPutModel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
axlPutModelGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
axlSetModelBlock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
axlSetModelFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
axlSetModelGroupName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
axlSetModelSection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
axlSetModelTest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
4
SKILL Functions for Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
axlAddOutputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
axlOutputResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
January 2007
Product Version 6.1
5
Test-Related SKILL Functions
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
axlGetOrigTestToolArgs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetTest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetTestName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetTestOceanScripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetTests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetTestToolArgs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetTestToolName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlInitialTestStateChanged . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlSaveResValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlSaveTestState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlSetTestName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlSetTestOceanScripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlSetTestToolArgs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlSetTestToolName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
117
118
119
120
121
122
124
125
126
127
128
129
130
132
6
Specification-Related SKILL Functions . . . . . . . . . . . . . . . . . . . . . . . 133
axlGetSpec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetSpecs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetSpecWeight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlNewSpecComp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlOpenResDB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlPutSpec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlSetSpecDescription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlSetSpecMax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlSetSpecMin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlSetSpecName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlSetSpecResultName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlSetSpecTarget . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlSetSpecTestName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlSetSpecTol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlSetSpecTolType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
January 2007
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
Product Version 6.1
axlSetSpecType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
axlSetSpecWeight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
7
Corners-Related SKILL Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
axlGetAllCornersEnabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetCorner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetCornerName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetCorners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetDefaultCornerEnabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetDisabledCorner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetDisabledCorners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetNominalCornerEnabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlPutCorner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlPutDisabledCorner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlSetCornerName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlSetDefaultCornerEnabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
8
Run-Related SKILL Functions
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
axlGetAllActiveRuns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetAllFinishedRuns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetAllSweepsEnabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetPercentComplete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetRunData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetRunMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetRunModes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetRunOption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetRunOptionName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetRunOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetRunOptionValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlIsActiveRun . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlIsPausedRun . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlPauseRun . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlPutRunOption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
January 2007
155
156
157
158
159
160
161
162
163
164
165
166
169
170
171
172
173
174
175
176
179
180
181
182
183
184
185
Product Version 6.1
axlRun . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlRunAllTests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlRunAllTestsWithCallback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlRunWithCallback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlSetRunCompleteCallback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlSetRunOptionName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlSetRunOptionValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
188
190
191
193
195
196
197
9
History-Related SKILL Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
axlGetCurrentHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetHistoryCheckpoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetHistoryEntry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetHistoryGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetHistoryMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetHistoryName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetHistoryResults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetHistoryResultsDir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetHistoryTest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlLoadHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlPutHistoryEntry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlSetHistoryMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlSetHistoryTest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlSetHistoryResults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
10
Job Policy SKILL Functions
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
axlAddJobPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlAttachJobPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlDeleteJobPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetAttachedJobPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetJobPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlGetJobPolicyTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
axlIsICRPProcess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
January 2007
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
220
223
226
227
228
229
230
Product Version 6.1
axlSetJobPolicyProperty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
axlStopAllJobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
axlStopJob . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
11
Design Characterization and Modeling
SKILL Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
dcmAppendToFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
dcmCreateLibertyKFactor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
dcmCreateLibertyOperatingConditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
dcmCreateLibertyTables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
dcmCreateResultTable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
dcmDone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
dcmExportToComposerams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
dcmExportToComposerspectre . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
dcmExportToComposerultrasim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
dcmExportToComposerverilog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
dcmGetFileContents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
dcmGetResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
dcmInit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
dcmMeasDelay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
dcmMeasLkgpwr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
dcmMeasNocpwr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
dcmMeasTim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
dcmMeasTimpwr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
dcmMeasVCO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
dcmReadMeas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
dcmSetAllTestsLibCellView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
dcmStartGUI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
dcmStartOpenDCMGUI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
dcmWriteToFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
238
239
240
243
245
246
247
248
249
250
251
252
253
254
256
257
259
262
265
267
268
269
270
271
Index. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
January 2007
Product Version 6.1
January 2007
10
Product Version 6.1
Preface
The files containing the SKILL functions provided for use with ADE XL and ADE GXL are
installed in various subdirectories under
your_install_dir/tools/dfII/group/davinci/src. You can check the
introductory paragraph of each chapter for specific directory locations.
Related Documents
You can find more information in the following related books:
Virtuoso ADE XL User Guide describes the ADE XL environment.
Virtuoso ADE GXL User Guide describes ADE GXL product features.
Virtuoso Design Environment SKILL Functions Reference provides detailed

information about the SKILL functions that interface to applications in the Virtuoso
Design Environment.
SKILL Language User Guide introduces the SKILL language.
Typographic and Syntax Conventions

This list describes the syntax conventions used in this manual.
literal
Nonitalic words indicate keywords that you must enter literally.

These keywords represent command ( function, routine ) or
option names.
argument ( z_argument )
Words in italics indicate user-defined arguments for which you
must substitute a name or a value. ( The characters before the
underscore ( _ ) in the word indicate the data types that this
argument can take. Names are case sensitive. Do not type the
underscore ( z_ ) before your arguments. )
[ ]
January 2007
Brackets denote optional arguments.
11
Product Version 6.1

Preface
Three dots ( ... ) indicate that you can repeat the previous
argument. If you use them with brackets, you can specify zero or
more arguments. If they are used without brackets, you must
specify at least one argument, but you can specify more.
argument
Specify at least one, but more are possible.
[argument]
Specify zero or more.
A comma and three dots together indicate that if you specify

more than one argument, you must separate those arguments by
commas.
If a command line or SKILL expression is too long to fit inside the paragraph margins of this
document, the remainder of the expression is put on the next line, indented.
When writing the code, put a backslash ( \ ) at the end of any line that continues on to the next
line.
January 2007
12
Product Version 6.1

Preface
SKILL Syntax Examples

The following examples show typical syntax characters used in SKILL.
Example 1
list( g_arg1 [g_arg2] ... ) => l_result
Example 1 illustrates the following syntax characters.
list
Plain type indicates words that you must enter literally.
g_arg1
Words in italics indicate arguments for which you must substitute

a name or a value.
( )
Parentheses separate names of functions from their arguments.
An underscore separates an argument type ( left ) from an

argument name ( right ).
[ ]
Brackets indicate that the enclosed argument is optional.
=>
A right arrow points to the return values of the function. Also used
in code examples in SKILL manuals.
...
Three dots indicate that the preceding item can appear any
number of times.
Example 2
needNCells(
s_cellType | st_userType
x_cellCount
)
=> t / nil
Example 2 illustrates two additional syntax characters.
|
Vertical bars separate a choice of required options.
Slashes separate possible return values.
January 2007
13
Product Version 6.1

Preface
January 2007
14
Product Version 6.1
1
Session-Related SKILL Functions

Function
Description
axlCloseSession
Closes the named ADE XL session.
axlCloseSessionInWindow
Closes the ade session in the current window if there is one.
axlCreateSession
Creates a new ADE XL session with the specified name.
axlGetAssociatedWindow
Returns the schematic editor window associated with the ADE
XL session, or nil if there is no window.
axlGetMainSetupDB
Returns a handle to the working setup database of the named

ADE XL session.
axlGetSessionHasGui
Returns t if the named ADE XL session is a graphical one;

returns nil if it is not.
axlGetSyncFlag
Gets the sync-flag status ( either true or false ) for an ADE XL

session.
axlIsValidAXLSession
Returns t if the named ADE XL session is valid ( exists ); returns

nil if it is not.
axlNewSession
Creates a new ADE XL session.
axlNoSession
Returns t if there is no ADE XL session in the current window.
axlRegisterCustomDeviceFilter
Adds a custom filter for device instance parameters on the
Parameters, Sweeps, and Corners Setup assistant pane. The
standard filters are Default, CDF, and CDF Editable.
January 2007
15
Product Version 6.1

Session-Related SKILL Functions, continued
Function
Description
axlSetAssociatedWindow
Sets the window associated with the named ADE XL session.
axlSetDefaultVariables
Creates a set of default variables (in the Global Variables tree
on the Parameters, Sweeps, and Corners assistant pane) for an
ADE XL session.
axlSetMainSetupDB
Sets the working setup database on an ADE XL session. Returns

a handle to the database.
axlSetSyncFlag
Sets the sync-flag status for an ADE XL session.
axlStopAll
Stops all runs currently evaluating in the session.
axlToolSetOriginalSetupOptions
Sets options to their original values for the tool instance
associated with the specified session and test.
axlToolSetSetupOptions Sets the option values for the tool instance associated with the
specified session and test.
axlViewResDB
January 2007
Opens the results viewer window for post-processing.
16
Product Version 6.1

axlCloseSession
axlCloseSession(
t_session
)
=> t / nil
Description
Closes the named ADE XL session.
Argument
t_session
Name of session you want to close.
Value Returned
t
Successful close operation.
nil
Unsuccessful close operation.
Example
axlCloseSession( "session0" )
t
January 2007
17
Product Version 6.1

axlCloseSessionInWindow
axlCloseSessionInWindow(
)
=> t / nil
Description
Closes the ade session in the current window if there is one.
Argument
None.
Value Returned
t
Successful operation.
nil
Unsuccessful operation.
Example
axlCloseSessionInWindow( )
t
January 2007
18
Product Version 6.1

axlCreateSession
axlCreateSession(
t_session
)
=> t_name / nil
Description
Creates a new ADE XL session with the specified name.
Argument
t_session
Session name you want to create.
Value Returned
t_name
Session name.
nil
Examples
axlCreateSession ( "data_session" )
data_session = ( axlCreateSession "data_session" )
"session1"
January 2007
19
Product Version 6.1

axlGetAssociatedWindow
axlGetAssociatedWindow(
t_session
)
=> x_window / nil
Description
Returns the schematic editor window associated with the ADE XL session, or nil if there is
no window.
Arguments
t_session
Session name.
Value Returned
x_window
Handle to schematic editor window associated with this ADE XL

session.
nil
No schematic editor window associated with this ADE XL

session.
Example
axlGetAssociatedWindow( "mySession" )
4
January 2007
20
Product Version 6.1

axlGetMainSetupDB
axlGetMainSetupDB(
t_session
)
=> x_database / nil
Description
Returns a handle to the working setup database of the named ADE XL session.
Argument
t_session
Session name.
Value Returned
x_database
Setup database handle.
nil
Example
axlGetMainSetupDB( "session0" )
1001
January 2007
21
Product Version 6.1

axlGetSessionHasGui
axlGetSessionHasGui(
t_session
)
=> t / nil
Description
Returns t if the named ADE XL session is a graphical one; returns nil if it is not.
Argument
t_session
Session name you want to query.
Value Returned
t
Graphical ADE XL session.
nil
Non-graphical ADE XL session.
Example
axlGetSessionHasGui( "session0" )
t
January 2007
22
Product Version 6.1

axlGetSyncFlag
axlGetSyncFlag(
)
=> t / nil
Description
Gets the sync-flag status ( either true or false ) for an ADE XL session.
Value Returned
t
Sync-flag status is true.
nil
Sync-flag status is false.
Example
axlGetSyncFlag( )
t
January 2007
23
Product Version 6.1

axlIsValidAXLSession
axlIsValidAXLSession(
t_session
)
=> t / nil
Description
Returns t if the named ADE XL session is valid ( exists ); returns nil if it is not.
Argument
t_session
Session name.
Value Returned
t
Valid ADE XL session.
nil
Not a valid ADE XL session.
Example
axlIsValidAXLSession( "session0" )
t
January 2007
24
Product Version 6.1

axlNewSession
axlNewSession(
)
=> t_session / nil
Description
Creates a new ADE XL session.
Value Returned
t_session
Session name.
nil
Example
axlNewSession( )
"session1"
January 2007
25
Product Version 6.1

axlNoSession
axlNoSession(
)
=> t / nil
Description
Returns t if there is no ADE XL session in the current window.
Argument
None.
Value Returned
t
There is no ADE XL session in the current window.
nil
There is an ADE XL session in the current window.
Example
axlNoSession( )
t
January 2007
26
Product Version 6.1

axlRegisterCustomDeviceFilter
axlRegisterCustomDeviceFilter(
t_name
s_function
)
=> t / nil
Description
Adds a custom filter for device instance parameters on the Parameters, Sweeps, and Corners
Setup assistant pane. The standard filters are Default, CDF, and CDF Editable.
Arguments
t_name
Device instance parameter filter name. This is the name that

appears in the Filter drop-down combo box on the Parameters,
Sweeps, and Corners Setup assistant pane.
Valid Values: Any string.
s_function
Symbol for a function that takes db:inst and t_simulator as

arguments and returns a list of (property name, property value)
lists.
Value Returned
t
Successful registration.
nil
Unsuccessful registration.
Example
First, define a custom filter. For example:
(procedure (myCustomFilter inst simulator)
(list (list "l" "1u") (list "m" "1"))
)
Then, call axlRegisterCustomDeviceFilter as follows:

axlRegisterCustomDeviceFilter "My Filter" 'myCustomFilter
The function returns t if the registration is successful; otherwise, nil.

January 2007
27
Product Version 6.1

axlSetAssociatedWindow
axlSetAssociatedWindow(
t_session
x_window
)
=> t / nil
Description
Sets the window associated with the named ADE XL session.
Arguments
t_session
Session name.
x_window
Schematic editing window.
Value Returned
t
Successful set operation.
nil
Unsuccessful set operation.
Example
axlSetAssociatedWindow "session0" 4
t
January 2007
28
Product Version 6.1

axlSetDefaultVariables
axlSetDefaultVariables(
l_variables
[t_libName]
)
=> t / nil
Description
Creates a set of default variables (in the Global Variables tree on the Parameters, Sweeps,
and Corners assistant pane) for an ADE XL session.
Arguments
l_variables
Disembodied property list of default variables and their values.
t_libName
Optional library name.

You can define a distinct set of default variables for each library.
You can also define one set of default variables not associated
with any library.
When you open an ADE XL setup, the program loads the set of
default variables associated with the same library as the setup
(if it exists). After that, it loads the set of default variables not
associated with any library (if it exists).
Value Returned
t
nil
Example
axlSetDefaultVariables( '(_n_len 1u _sim_time 100n) "myDemoLib" )
t
January 2007
29
Product Version 6.1

axlSetMainSetupDB
axlSetMainSetupDB(
t_session
t_setupdb
)
=> x_database / nil
Description
Sets the working setup database on an ADE XL session. Returns a handle to the database.
Arguments
t_session
Session name.
t_setupdb
Working setup database.
Value Returned
x_database
nil
Example
data_sdb = axlSetMainSetupDB( "data_session" "data.sdb" )
4001
Reference
axlCreateSession
January 2007
30
Product Version 6.1

axlSetSyncFlag
axlSetSyncFlag(
g_flag
)
=> t / nil
Description
Sets the sync-flag status for an ADE XL session.
Argument
g_flag
Sync-flag status
Valid Values:
t
Sets the sync-flag status to true.
nil
Sets the sync-flag status to false.
Value Returned
t
nil
Example
axlSetSyncFlag( t )
t
January 2007
31
Product Version 6.1

axlStopAll
axlStopAll(
t_session
)
=> t / nil
Description
Stops all runs currently evaluating in the session.
Argument
t_session
ADE XL session name.
Value Returned
t
nil
Example
axlStopAll( "session0" )
t
January 2007
32
Product Version 6.1

axlToolSetOriginalSetupOptions
axlToolSetOriginalSetupOptions(
t_session
t_test
l_toolOptions
)
=> t / nil
Description
Sets options to their original values for the tool instance associated with the specified session
and test.
Argument
t_session
Session name.
t_test
Test name.
l_toolOptions
Associative list of original option names and values for the tool
instance.
Valid Values for tool instance ADE:
lib t_libName
Library name.
cell t_cellName
Cell name.
view t_viewName
View name.
sim t_simulator
Simulator name.
state t_stateName
State name.
path t_path
January 2007
Path to ADE state.
33
Product Version 6.1

Value Returned
t
nil
Example
axlToolSetOriginalSetupOptions(
"session0"
"delayTest"
axlGetOrigTestToolArgs( 1031 ) )
t
Reference
axlGetOrigTestToolArgs, axlToolSetSetupOptions
January 2007
34
Product Version 6.1

axlToolSetSetupOptions
axlToolSetSetupOptions(
t_session
t_test
l_toolOptions
)
=> t / nil
Description
Sets the option values for the tool instance associated with the specified session and test.
Argument
t_session
Session name.
t_test
Test name.
l_toolOptions
Associative list of original option values for the tool instance.

Valid Values for tool instance ADE:
lib t_libName
Library name.
cell t_cellName
Cell name.
view t_viewName
View name.
sim t_simulator
Simulator name.
state t_stateName
State name.
path t_path
Path to ADE state.
Value Returned
t
January 2007
35
Product Version 6.1

nil
Example
axlToolSetSetupOptions( "session0" "delayTest" axlGetTestToolArgs( 1031 ) )
t
Reference
axlGetTestToolArgs, axlToolSetOriginalSetupOptions
January 2007
36
Product Version 6.1

axlViewResDB
axlViewResDB(
t_pathToResultsDB
)
=> t / nil
Description
Opens the results viewer window for post-processing.
Argument
t_pathToResultsDB Path to results database.
Value Returned
t
nil
Example
axlViewResDB( "./my_results.rdb" )
t
January 2007
37
Product Version 6.1

January 2007
38
Product Version 6.1
2
Setup Database SKILL Functions

Function
Description
axlCommitSetupDB
Saves the setup database.
axlCommitSetupDBAndHistoryAs
Saves the setup database along with history entries under a new
name.
axlCommitSetupDBas
Saves the setup database under a new name.
axlGetActiveSetup
Returns a handle to the active test setup in the specified setup

database.
axlGetDescription
Returns a description of the setup database entry.
axlGetElementParent
Returns a handle to the parent of the specified setup database

element.
axlGetEnabled
Checks whether a setup database element is enabled or not.
axlGetLocations
Returns a list containing a handle to all device instance

parameter locations for this database entry and a list of all
location names.
axlGetParameter
Finds a device instance parameter by name and location.
axlGetParameterName
Gets the name of a device instance parameter.
axlGetParameters
Returns a list containing a handle to all device instance

parameters for this database entry and a list of all device
instance parameter names.
axlGetParameterValue
Gets the value of a device instance parameter.
axlGetResultsLocation
Returns the results location for the specified setup database. The
program uses the adexl.results saveDir setting to
determine the results location.
January 2007
39
Product Version 6.1

Setup Database SKILL Functions, continued
Function
Description
axlGetScript
Finds a script by name and returns a handle to it.
axlGetScriptPath
Returns the path of a script.
axlGetScripts
Returns a list containing a handle to all scripts for this database

entry and a list of all script names.
axlGetSetupDB
Opens the named setup database and returns its handle.
axlGetSetupDBBaseName
Returns the name of specified setup database.
axlGetSetupDBDir
Returns the directory of the specified setup database.
axlGetTopLevel
Returns a handle to the setup dabase containing the specified

element.
axlGetVar
Finds a global variable by name and returns a handle to it.
axlGetVars
Returns a list containing a handle to all global variables for a

database entry and a list of all global variable names.
axlGetVarValue
Gets the value of a global variable.
axlIsDirty
Checks whether the specified setup database has been modified

since the last save operation.
axlIsElement
Checks whether the handle ( passed as an argument ) is a valid

setup database handle.
axlIsReadOnly
Checks whether the handle references a read-only branch of the

setup database.
axlIsSetupDB
Checks whether the handle ( passed as an argument ) refers to

an open setup database.
axlNewSetupDB
Opens the named setup database and returns its handle. If the
named setup database does not already exist, this function
creates one and returns a handle to it.
axlPutParameter
Inserts or finds a device instance parameter by name and

location.
axlPutScript
Inserts or finds a script by name, sets its path, and returns a

handle to that script.
axlPutTest
Finds or inserts a test into the setup database and returns a

handle to that test.
January 2007
40
Product Version 6.1

Setup Database SKILL Functions, continued
Function
Description
axlPutVar
Inserts or finds a global variable by name and sets its value.
axlRemoveElement
Removes an element and all its children from the setup

database.
axlResetActive
Resets the active setup database.
axlSaveAs
The program calls this function when you choose File Save
As in your ADE XL session window and eventually calls
axlSaveSetupToLib with the lib/cell/view information you
specify when the program prompts you for it.
axlSaveSetup
Saves the setup database and associated state information for

the current window.
axlSaveSetupToLib
Saves the setup database to the specified lib/cell/view.
axlSetDescription
Adds a description to a setup database entry.
axlSetElementValue
Sets the value of the specified element.
axlSetEnabled
Enables or disables a setup database element.
axlSetParameterName
Sets the name of a device instance parameter.
axlSetParameterValue
Sets the value of a device instance parameter.
axlSetScriptPath
Sets the path of a script.
axlSetSetupDBName
Renames the setup database.
axlSetVarValue
Sets the value of a global variable.
axlWriteDatasheet
Creates a datasheet for the specified history entry.
axlWriteDatasheetForm Causes a form to appear so that you can specify various options
for generating a datasheet.
January 2007
41
Product Version 6.1

axlCommitSetupDB
axlCommitSetupDB(
x_database
)
=> t / nil
Description
Saves the setup database.
Argument
x_database
Value Returned
t
Successful save operation.
nil
Unsuccessful save operation.
Example
data_sdb = axlSetMainSetupDB( data_session "data.sdb" )
axlCommitSetupDB( data_sdb )
t
Reference
axlCreateSession, axlSetMainSetupDB
January 2007
42
Product Version 6.1

axlCommitSetupDBAndHistoryAs
axlCommitSetupDBAndHistoryAs(
x_database
t_name
)
=> t / nil
Description
Saves the setup database along with history entries under a new name.
Arguments
x_database
t_name
New setup database name.
Value Returned
t
nil
Example
axlCommitSetupDBAndHistoryAs 1002 "newData.sdb"
t
January 2007
43
Product Version 6.1

axlCommitSetupDBas
axlCommitSetupDBas(
x_database
t_name
)
=> t / nil
Description
Saves the setup database under a new name.
Arguments
x_database
t_name
Value Returned
t
nil
Example
axlCommitSetupDBas 1002 "data.sdb"
t
January 2007
44
Product Version 6.1

axlGetActiveSetup
axlGetActiveSetup(
x_database
)
=> x_active / nil
Description
Returns a handle to the active test setup in the specified setup database.
Argument
x_database
Value Returned
x_active
Handle to the active test setup.
nil
Example
January 2007
45
Product Version 6.1

axlGetDescription
axlGetDescription(
x_element
)
=> t_description / nil
Description
Returns a description of the setup database entry.
Argument
x_element
Setup database element handle.
Value Returned
t_description
Database entry description text.
nil
Example
axlGetDescription 1021
"My description text."
January 2007
46
Product Version 6.1

axlGetElementParent
axlGetElementParent(
x_element
)
=> x_parent / nil
Description
Returns a handle to the parent of the specified setup database element.
Argument
x_element
Value Returned
x_parent
Handle to the parent of x_element.

For example, if x_element is the handle to a variables value,
x_parent is the handle to the variable; if x_element is the
handle to a variable, x_parent is the handle to the set of
variables; and so on up to the top-level setup database handle.
g_errorOrZero
Error message if input argument is invalid or zero if the element

has no parent.
Example
axlGetElementParent( axlGetHistoryEntry( data_sdb "data_design_verification" ) )
1004
Reference
axlCreateSession, axlSetMainSetupDB, axlGetHistoryEntry
January 2007
47
Product Version 6.1

axlGetEnabled
axlGetEnabled(
x_element
)
=> t / nil
Description
Checks whether a setup database element is enabled or not.
Argument
x_element
Value Returned
t
Element is enabled.
nil
Element is not enabled.
Example
axlGetEnabled 1021
nil
January 2007
48
Product Version 6.1

axlGetLocations
axlGetLocations(
x_element
)
=> l_locations / nil
Description
Returns a list containing a handle to all device instance parameter locations for this database
entry and a list of all location names.
Argument
x_element
Value Returned
l_locations
List containing a handle to all device instance parameter

locations for this database entry and a list of all location names.
nil
Example
axlGetLocations 1021
'(1027
("opamps/OpAmp_lab2/schematic/M1" "opamps/OpAmp_lab2/schematic/M2")
)
January 2007
49
Product Version 6.1

axlGetParameter
axlGetParameter(
x_element
t_location
t_parameter
)
=> x_parameter / nil
Description
Finds a device instance parameter by name and location.
Arguments
x_element
t_location
Device instance parameter location as

libraryName/cellName/viewName/instanceName.
t_parameter
Device instance parameter name.
Value Returned
x_parameter
Handle to the device instance parameter.
nil
Example
axlGetParameter 1004 "opamps/OpAmp_lab2/schematic/M1" "m"
1028
January 2007
50
Product Version 6.1

axlGetParameterName
axlGetParameterName(
x_parameter
)
=> t_name / nil
Description
Gets the name of a device instance parameter.
Argument
x_parameter
Handle to a device instance parameter.
Value Returned
t_name
nil
Example
axlGetParameterName 1005
"fingers"
January 2007
51
Product Version 6.1

axlGetParameters
axlGetParameters(
x_element
t_location
)
=> l_parameters / nil
Description
Returns a list containing a handle to all device instance parameters for this database entry
and a list of all device instance parameter names.
Arguments
x_element
t_location

libraryName/cellName/viewName/instanceName..
Value Returned
l_parameters
List containing a handle to all device instance parameters for

this database entry and a list of all device instance parameter
names.
nil
Example
axlGetParameters 1004 "opamps/OpAmp_lab2/schematic/M1"
(1034
("l" "m")
)
January 2007
52
Product Version 6.1

axlGetParameterValue
axlGetParameterValue(
x_parameter
)
=> t_value / nil
Description
Gets the value of a device instance parameter.
Argument
x_parameter
Value Returned
t_value
Device instance parameter value.
nil
Example
axlGetParameterValue 1005
"15u"
January 2007
53
Product Version 6.1

axlGetResultsLocation
axlGetResultsLocation(
x_database
)
=> t_resultsLocation / nil
Description
Returns the results location for the specified setup database. The program uses the
adexl.results saveDir setting to determine the results location.
Argument
x_database
Value Returned
t_resultsLocation Results location which includes a directory named from the
setup database name prefix.
nil
Unsuccessful get operation.
Example
If you do not set the adexl.results saveDir environment variable in your .cdsenv:
axlGetResultsLocation( data_sdb )
"myLib/myCell/adexl/results/data"
If you set the adexl.results saveDir environment variable to RESULTS as follows:

adexl.results saveDir string "RESULTS"
this function returns the following instead:

"RESULTS/myLib/myCell/adexl/results/data"
Here is another example (where adexl.results saveDir is not set):

resultsLoc = (axlGetResultsLocation (axlGetHistoryEntry (axlGetMainSetupDB
_axlGetCurrentSession() ) )
"opamplib/ampTest/adexl/results/data"
January 2007
54
Product Version 6.1

Reference
axlCreateSession, axlGetHistoryEntry, axlGetMainSetupDB, axlSetMainSetupDB
January 2007
55
Product Version 6.1

axlGetScript
axlGetScript(
x_element
t_name
)
=> x_script / nil
Description
Finds a script by name and returns a handle to it.
Arguments
x_element
t_name
Script name.
Value Returned
x_script
Script handle.
nil
Unsuccessful add operation.
Example
axlGetScript 1021 "myScript.nam"
1045
January 2007
56
Product Version 6.1

axlGetScriptPath
axlGetScriptPath(
x_script
)
=> t_path / nil
Description
Returns the path of a script.
Argument
x_script
Script handle.
Value Returned
t_path
Script path.
nil
Example
axlGetScriptPath 1045
"myData/scripts"
January 2007
57
Product Version 6.1

axlGetScripts
axlGetScripts(
x_element
)
=> l_scripts / nil
Description
Returns a list containing a handle to all scripts for this database entry and a list of all script
names.
Argument
x_element
Value Returned
l_scripts
List containing a handle to all scripts for this database entry and
a list of all script names.
nil
Example
axlGetScripts 1045
'((1001 "script1.ocn")
(1002 "script2.ocn")
)
January 2007
58
Product Version 6.1

axlGetSetupDB
axlGetSetupDB(
t_name
)
=> x_database / nil
Description
Opens the named setup database and returns its handle.
Argument
t_name
Setup database name.
Value Returned
x_database
nil
Example
axlGetSetupDB "data.sdb"
1011
January 2007
59
Product Version 6.1

axlGetSetupDBBaseName
axlGetSetupDBBaseName(
x_database
)
=> t_name / nil
Description
Returns the name of specified setup database.
Argument
x_database
Value Returned
t_name
nil
Example
axlGetSetupDBBaseName( data_sdb )
"data.sdb"
Reference
January 2007
60
Product Version 6.1

axlGetSetupDBDir
axlGetSetupDBDir(
x_database
)
=> t_dir / nil
Description
Returns the directory of the specified setup database.
Argument
x_database
Value Returned
t_dir
Setup database directory.
nil
Example
axlGetSetupDBDir( data_sdb )
"myLib/myCell/adexl"
Reference
January 2007
61
Product Version 6.1

axlGetTopLevel
axlGetTopLevel(
x_element
)
=> x_database / g_errorOrZero
Description
Returns a handle to the setup dabase containing the specified element.
Argument
x_element
Value Returned
x_database
g_errorOrZero
Error message if input argument is invalid or zero for otherwise

unsuccessful operation.
Example
axlGetTopLevel( axlGetHistoryEntry( data_sdb "data_design_verification" ) )
1004
Reference
January 2007
62
Product Version 6.1

axlGetVar
axlGetVar(
x_database
t_name
)
=> x_var / nil
Description
Finds a global variable by name and returns a handle to it.
Arguments
x_database
t_name
Variable name.
Value Returned
x_var
Handle to the global variable.
nil
Example
;; Disable variables
foreach( param cadr( axlGetVars( data_sdb ) )
axlSetEnabled( axlGetVar( data_sdb param ) nil )
1
Reference
axlCreateSession, axlSetMainSetupDB, axlSetEnabled, axlGetVars
January 2007
63
Product Version 6.1

axlGetVars
axlGetVars(
x_element
)
=> l_vars / nil
Description
Returns a list containing a handle to all global variables for a database entry and a list of all
global variable names.
Argument
x_element
Value Returned
l_vars
List containing a handle to all global variables for a database

entry and a list of all global variable names.
nil
Example
axlGetVars( data_sdb )
(1023
("CLoad" "RLoad" "VDC")
)
Reference
January 2007
64
Product Version 6.1

axlGetVarValue
axlGetVarValue(
x_var
)
=> t_value / nil
Description
Gets the value of a global variable.
Argument
x_var
Handle to a global variable.
Value Returned
t_value
Variable value.
nil
Example
axlGetVarValue 1005
"100u"
January 2007
65
Product Version 6.1

axlIsDirty
axlIsDirty(
x_element
)
=> t / nil
Description
Checks whether the specified setup database has been modified since the last save
operation.
Argument
x_element
Value Returned
t
Setup database has been modified since the last save

operation.
nil
Setup database has not been modified since the last save
operation.
Example
axlIsDirty( data_sdb )
nil
Reference
January 2007
66
Product Version 6.1

axlIsElement
axlIsElement(
x_database
)
=> t / nil
Description
Checks whether the handle ( passed as an argument ) is a valid setup database handle.
Argument
x_database
Value Returned
t
Valid setup database handle.
nil
Not a valid setup database handle.
Example
axlIsElement( data_sdb )
t
Reference
January 2007
67
Product Version 6.1

axlIsReadOnly
axlIsReadOnly(
x_element
)
=> t / nil
Description
Checks whether the handle references a read-only branch of the setup database.
Argument
x_element
Value Returned
t
Handle references a read-only branch of the setup database.
nil
Handle does not reference a read-only branch of the setup

database.
Example
axlIsReadOnly 1
nil
January 2007
68
Product Version 6.1

axlIsSetupDB
axlIsSetupDB(
x_database
)
=> t / nil
Description
Checks whether the handle ( passed as an argument ) refers to an open setup database.
Argument
x_database
Handle to open setup database.
Value Returned
t
Handle refers to an open setup datbase.
nil
Handle does not refer to an open setup database.
Example
axlIsSetupDB( data_sdb )
t
Reference
January 2007
69
Product Version 6.1

axlNewSetupDB
axlNewSetupDB(
t_name
)
=> x_database / nil
Description
Opens the named setup database and returns its handle. If the named setup database does
not already exist, this function creates one and returns a handle to it.
Argument
t_name
Value Returned
x_database
nil
Unsuccessful open/create operation.
Example
axlNewSetupDB( "data" )
1
January 2007
70
Product Version 6.1

axlPutParameter
axlPutParameter(
x_element
t_location
t_parameter
)
=> x_parameter / nil
Description
Inserts or finds a device instance parameter by name and location.
Arguments
x_element
t_location

libraryName/cellName/viewName/instanceName..
t_parameter
Value Returned
x_parameter
Handle to the device instance parameter.
nil
Example
axlPutParameter 1004 "opamp/opamp1/schematic/M1" "l")
1005
January 2007
71
Product Version 6.1

axlPutScript
axlPutScript(
x_element
t_name
t_path
)
=> x_script / nil
Description
Inserts or finds a script by name, sets its path, and returns a handle to that script.
Arguments
x_element
t_name
Script name.
t_path
Path.
Value Returned
x_script
Script handle.
nil
Example
axlPutScript 1004 "scriptname" "/path/to/script/file")
1005
January 2007
72
Product Version 6.1

axlPutTest
axlPutTest(
x_database
t_test
)
=> x_test / nil
Description
Finds or inserts a test into the setup database and returns a handle to that test.
Arguments
x_database
t_test
Test name.
Value Returned
x_test
Test handle.
nil
Example
axlPutTest( data_sdb "data_dead_band" )
2201
Reference
January 2007
73
Product Version 6.1

axlPutVar
axlPutVar(
x_element
t_name
t_value
)
=> x_var / nil
Description
Inserts or finds a global variable by name and sets its value.
Arguments
x_element
t_name
Variable name.
t_value
Variable value.
Value Returned
x_var
Handle to the global variable.
nil
Example
c1 = axlPutCorner( data_sdb "c1" )
axlPutVar( c1 "data_dcm_temperature" "1" )
1089
Reference
axlCreateSession, axlPutCorner, axlSetMainSetupDB
January 2007
74
Product Version 6.1

axlRemoveElement
axlRemoveElement(
x_element
)
=> t / nil
Description
Removes an element and all its children from the setup database.
Argument
x_element
Value Returned
t
Successful remove operation.
nil
Unsuccessful remove operation.
Example
axlRemoveElement( axlGetHistoryEntry( data_sdb "data_design_verification" ) )
t
Reference
January 2007
75
Product Version 6.1

axlResetActive
axlResetActive(
x_database
)
=> t / nil
Description
Resets the active setup database.
Argument
x_database
Value Returned
t
nil
Example
axlResetActive( 1003 )
t
January 2007
76
Product Version 6.1

axlSaveAs
axlSaveAs(
w_windowID
t_libName
t_cellName
t_viewName
)
=> t / nil
Description
The program calls this function when you choose File Save As in your ADE XL session
window and eventually calls axlSaveSetupToLib with the lib/cell/view information you
specify when the program prompts you for it.
Arguments
w_windowID
Window ID of an ADE XL session.
t_libName
Library name.
t_cellName
Cell name.
t_viewName
View name.
Value Returned
t
nil
Example
axlSaveAs( window:3 "testlib" "testcell" "adexl" )
t
January 2007
77
Product Version 6.1

axlSaveSetup
axlSaveSetup(
)
=> t / nil
Description
Saves the setup database and associated state information for the current window.
Argument
None.
Value Returned
t
nil
Example
axlSaveSetup( )
t
January 2007
78
Product Version 6.1

axlSaveSetupToLib
axlSaveSetupToLib(
x_database
t_libName
t_cellName
t_viewName
)
=> t / nil
Description
Saves the setup database to the specified lib/cell/view.
Arguments
x_database
t_libName
Library name.
t_cellName
Cell name.
t_viewName
View name.
Value Returned
t
nil
Example
axlSaveSetupToLib( 1001, "lib", "cell", "view" )
t
Reference
axlSaveAs
January 2007
79
Product Version 6.1

axlSetDescription
axlSetDescription(
x_element
t_description
)
=> t / nil
Description
Adds a description to a setup database entry.
Arguments
x_element
t_description
Description text.
Value Returned
t
nil
Example
axlSetDescription ( axlGetHistoryEntry 1045 "Interactive.0" ) "Description text."
t
January 2007
80
Product Version 6.1

axlSetElementValue
axlSetElementValue(
x_element
t_value
)
=> t / nil
Description
Sets the value of the specified element.
Arguments
x_element
t_value
Value.
Value Returned
t
nil
Example
axlSetElementValue 1058 "100u"
t
January 2007
81
Product Version 6.1

axlSetEnabled
axlSetEnabled(
x_element
g_enable
)
=> t / nil
Description
Enables or disables a setup database element.
Arguments
x_element
g_enable
Enable flag
Valid Values:
nil
Disabled
any other value
Enabled
Value Returned
t
nil
Example
;; Enable a test
data_dead_band = axlGetTest( data_sdb "data_dead_band" )
axlSetEnabled( data_dead_band t )
;; Disable tests
foreach( test cadr( axlGetTests( data_sdb ) )
axlSetEnabled( axlGetTest( data_sdb test ) nil )
;; Disable variables
foreach( param cadr( axlGetVars( data_sdb ) )
axlSetEnabled( axlGetVar( data_sdb param ) nil )
January 2007
82
Product Version 6.1

Reference
axlCreateSession, axlSetMainSetupDB, axlGetTests, axlGetTest, axlGetVars,
axlGetVar
January 2007
83
Product Version 6.1

axlSetParameterName
axlSetParameterName(
x_parameter
t_name
)
=> t / nil
Description
Sets the name of a device instance parameter.
Arguments
x_parameter
t_name
Value Returned
t
nil
Example
axlSetParameterName 1050 "sdMtlWidth"
t
January 2007
84
Product Version 6.1

axlSetParameterValue
axlSetParameterValue(
x_parameter
t_value
)
=> t / nil
Description
Sets the value of a device instance parameter.
Arguments
x_parameter
t_value
Device instance parameter value.
Value Returned
t
nil
Example
axlSetParameterValue 1050 "120n"
t
January 2007
85
Product Version 6.1

axlSetScriptPath
axlSetScriptPath(
x_script
t_path
)
=> t / nil
Description
Sets the path of a script.
Arguments
x_script
Script handle.
t_path
Script path.
Value Returned
t
nil
Example
axlSetScriptPath 1045 "myData/myScripts"
t
January 2007
86
Product Version 6.1

axlSetSetupDBName
axlSetSetupDBName(
x_database
t_name
)
=> t / nil
Description
Renames the setup database.
Arguments
x_database
t_name
Value Returned
t
Successful rename operation.
nil
Unsuccessful rename operation.
Example
axlSetSetupDBName 1090 "data.sdb"
t
January 2007
87
Product Version 6.1

axlSetVarValue
axlSetVarValue(
x_var
t_value
)
=> t / nil
Description
Sets the value of a global variable.
Arguments
x_var
Handle to a global variable.
t_value
Variable value.
Value Returned
t
nil
Example
axlSetVarValue 1085 "100u"
t
January 2007
88
Product Version 6.1

axlWriteDatasheet
axlWriteDatasheet(
x_axlSession
x_historyEntry
[ t_directory ]
[ g_resultsSummary t ]
[ t_testsSummary t ]
[ g_detailedResults t ]
[ g_launchBrowser t ]
)
=> t / nil
Description
Creates a datasheet for the specified history entry.
Argument
x_axlSession
Integer value representing the session.
x_historyEntry
Integer value representing the history entry.
t_directory
Target directory for the datasheet.

Default Value: libName/cellName/adexl/datasheets
g_resultsSummary
Boolean to specify whether or not you want to print a results

summary sheet containing specification sheet pass/fail table.
Default Value: t
g_testsSummary
Boolean to specify whether or not you want to print a tests

summary sheet containing details about the tests, sweeps, and
corners.
Default Value: t
g_detailedResults Boolean to specify whether or not you want to generate results

for all points.
Default Value: t
g_launchBrowser
January 2007
Boolean to specify whether or not you want to launch a browser

window to view the generated datasheet.
Default Value: t
89
Product Version 6.1

Value Returned
t
nil
Example
tagit:still need example (devendra); also, which chapter?
January 2007
90
Product Version 6.1

axlWriteDatasheetForm
axlWriteDatasheetForm(
x_axlSession
x_historyEntry
)
=> t / nil
Description
Causes a form to appear so that you can specify various options for generating a datasheet.
Argument
x_axlSession
Integer value representing the session.
x_historyEntry
Integer value representing the history entry.
Value Returned
t
nil
Example
axlWriteDatasheetForm 1001 1089
t
January 2007
91
Product Version 6.1

January 2007
92
Product Version 6.1
3
Model-Related SKILL Functions

Function
Description
axlGetModel
Returns a handle to the model file for the specified model.
axlGetModelBlock
Returns the name of the block for the specified model. (A model
file can be associated with a test and block in MTS mode.)
axlGetModelFile
Returns the model file path for the specified model.
axlGetModelGroup
Returns a handle to a model group in the setup database.
axlGetModelGroupName
Returns the name of the model group associated with the
specified corner.
axlGetModelGroups
Returns a list of the model group names in a setup database.
axlGetModelSection
Returns the section name for the specified model.
axlGetModelTest
Returns the name of the test associated with the specified

model. (A model file can be associated with a test and block in
MTS mode.)
axlGetModels
Returns a list of model files in the setup database.
axlPutModel
Adds a model file to the setup database.
axlPutModelGroup
Adds a model group to the setup database. Returns the handle

to the model group if it already exists.
axlSetModelBlock
Sets the name of the block for the specified model. (A model file
can be associated with a test and block in MTS mode.)
axlSetModelFile
Sets the model file for the specified model.
axlSetModelGroupName
January 2007
93
Product Version 6.1

Model-Related SKILL Functions, continued
Function
Description
Sets the name of the model group associated with the specified
corner.
axlSetModelSection
Sets the section name for the specified model.
axlSetModelTest
Sets the name of the test associated with the specified model. (A
model file can be associated with a test and block in MTS mode.)
January 2007
94
Product Version 6.1

axlGetModel
axlGetModel(
x_database
t_modelName
)
=> x_modelFile / nil
Description
Returns a handle to the model file for the specified model.
Arguments
x_database
t_modelName
Model file name.
Value Returned
x_modelFile
Model file handle.
nil
Example
axlGetModel(sdb_corner "fastModel")
1319
January 2007
95
Product Version 6.1

axlGetModelBlock
axlGetModelBlock(
x_model
)
=> t_blockName / nil
Description
Returns the name of the block for the specified model. (A model file can be associated with
a test and block in MTS mode.)
Argument
x_model
Handle to a model.
Value Returned
t_blockName
Name of block associated with the specified model.
nil
Example
model = axlGetModel(sdb_corner "model1.scs")
1311
axlGetModelBlock(model)
"blockName"
Reference
axlGetModel, axlSetModelBlock
January 2007
96
Product Version 6.1

axlGetModelFile
axlGetModelFile(
x_model
)
=> t_modelFile / nil
Description
Returns the model file path for the specified model.
Argument
x_model
Handle to a model.
Value Returned
t_modelFile
Model file name with full path.
nil
Example
1311
axlGetModelFile(model)
"/hm/user/model/model1.scs"
Reference
axlGetModel, axlSetModelFile
January 2007
97
Product Version 6.1

axlGetModelGroup
axlGetModelGroup(
x_database
t_modelGroupName
)
=> x_modelGroup / nil
Description
Returns a handle to a model group in the setup database.
Arguments
x_database
t_modelGroupName
Model group name.
Value Returned
x_modelGroup
Model group handle.
nil
Example
axlGetModelGroup(sdb_corner, "FF")
1321
Reference
axlPutModelGroup
January 2007
98
Product Version 6.1

axlGetModelGroupName(
x_corner
)
=> t_modelGroupName / nil
Description
Returns the name of the model group associated with the specified corner.
Argument
x_corner
Corner handle.
Value Returned
t_modelGroupName
Model group name associated with the specified corner.
nil
Example
axlGetModelGroupName(sdb_corner)
"FF"
Reference
January 2007
99
Product Version 6.1

axlGetModelGroups
axlGetModelGroups(
x_database
)
=> l_modelGroups / nil
Description
Returns a list of the model group names in a setup database.
Argument
x_database
Value Returned
l_modelGroups
List of model group names in the setup database.
nil
Example
axlGetModelGroups(sdb)
(1478
("FF" "SS" "SF")
)
Reference
January 2007
100
Product Version 6.1

axlGetModelSection
axlGetModelSection(
x_model
)
=> t_sectionName / nil
Description
Returns the section name for the specified model.
Argument
x_model
Model handle.
Value Returned
t_sectionName
Section name associated with the specified model.
nil
Example
1311
axlGetModelSection(model)
"FF"
Reference
axlGetModel, axlSetModelSection
January 2007
101
Product Version 6.1

axlGetModelTest
axlGetModelTest(
x_model
)
=> t_testName / nil
Description
Returns the name of the test associated with the specified model. (A model file can be
associated with a test and block in MTS mode.)
Argument
x_model
Handle to a model.
Value Returned
t_testName
Name of the test associated with the specified model.
nil
Example
1311
axlGetModelTest(model)
"ampTest:1"
Reference
axlGetModel, axlSetModelTest
January 2007
102
Product Version 6.1

axlGetModels
axl(
x_database
)
=> l_modelFiles / nil
Description
Returns a list of model files in the setup database.
Argument
x_database
Value Returned
l_modelFiles
List of model file names in the setup database.
nil
Example
axlGetModels(sdb_corner)
(1310
("model1.scs" "model2.scs" "model3.scs")
)
January 2007
103
Product Version 6.1

axlPutModel
axlPutModel(
x_database
t_modelName
)
Description
Adds a model file to the setup database.
Arguments
x_database
t_modelName
Model file name.
Value Returned
x_modelFile
Model file handle.
nil
Example
axlPutModel(sdb_corner "fastModel")
1319
Reference
axlGetModel
January 2007
104
Product Version 6.1

axlPutModelGroup
axlPutModelGroup(
x_database
t_modelGroupName
)
=> x_modelGroup / nil
Description
Adds a model group to the setup database. Returns the handle to the model group if it already
exists.
Arguments
x_database
t_modelGroupName
Model group name.
Value Returned
x_modelGroup
Model group handle.
nil
Example
axlPutModelGroup(sdb, "FF")
1435
Reference
axlGetModelGroup
January 2007
105
Product Version 6.1

axlSetModelBlock
axlSetModelBlock(
x_model
t_blockName
)
=> x_modelBlock / nil
Description
Sets the name of the block for the specified model. (A model file can be associated with a test
and block in MTS mode.)
Arguments
x_model
Handle to a model.
t_blockName
Block name.
Use Global to apply the model to all MTS blocks.
Value Returned
x_modelBlock
Handle to the model block element.
nil
Example
1311
axlSetModelBlock(model "blockName")
Reference
axlGetModel, axlGetModelBlock
January 2007
106
Product Version 6.1

axlSetModelFile
axlSetModelFile(
x_model
t_modelFile
)
Description
Sets the model file for the specified model.
Arguments
x_model
Handle to a model.
t_modelFile
Model file name, can include full path.
Value Returned
x_modelFile
Handle to the model file element.
nil
Example
1311
axlSetModelFile(model "/hm/user/models/model1.scs")
Reference
axlGetModel, axlGetModelFile
January 2007
107
Product Version 6.1

axlSetModelGroupName(
x_corner
t_modelGroupName
)
=> x_modelGroupName / nil
Description
Sets the name of the model group associated with the specified corner.
Arguments
x_corner
Corner handle.
t_modelGroupName
Model group name.
Value Returned
x_modelGroupName
Handle to the model group name element.
nil
Example
axlSetModelGroupName(sdb_corner "FF")
1457
Reference
January 2007
108
Product Version 6.1

axlSetModelSection
axlSetModelSection(
x_model
t_sectionName
)
=> x_modelSection / nil
Description
Sets the section name for the specified model.
Arguments
x_model
Model handle.
t_sectionName
Section name associated with the specified model.
Value Returned
x_modelSection
Handle to the model section element.
nil
Example
1311
axlSetModelSection(model "Fast")
Reference
axlGetModel, axlGetModelSection
January 2007
109
Product Version 6.1

axlSetModelTest
axlSetModelTest(
x_model
t_testName
)
=> x_modelTest / nil
Description
Sets the name of the test associated with the specified model. (A model file can be associated
with a test and block in MTS mode.)
Arguments
x_model
Handle to a model.
t_testName
Name of the test associated with the specified model.

Use All to use this model with all tests.
Value Returned
x_modelTest
Handle to the model test element.
nil
Example
1311
axlSetModelTest(model "ampTest:1")
Reference
axlGetModel, axlGetModelTest
January 2007
110
Product Version 6.1
4
SKILL Functions for Outputs

Function
Description
axlAddOutputs
Defines one or more outputs from an OCEAN script. If you use

this function, you must place the call on the first line of the
OCEAN script file.
axlOutputResult
Specifies the value of an output in an OCEAN script file. You

must first define the output using axlAddOutputs.
January 2007
111
Product Version 6.1

axlAddOutputs
axlAddOutputs(
l_outputNames
)
=> t / nil
Description
Defines one or more outputs from an OCEAN script. If you use this function, you must place
the call on the first line of the OCEAN script file.
Argument
l_outputNames
List of output names.
Value Returned
t
nil
Example
The following command defines two outputs, maxOfOut and minOfOut. You can set the
values of these outputs using axlOutputResult.
axlAddOutputs( '("maxOfOut" "minOfOut"))
t
Reference
axlOutputResult
January 2007
112
Product Version 6.1

axlOutputResult
axlOutputResult(
g_value
[t_outputName]
)
=> t / nil
Description
Specifies the value of an output in an OCEAN script file. You must first define the output using
axlAddOutputs.
Arguments
g_value
Output value.
t_outputName
(Optional) Name of output, which must be defined first using

axlAddOutputs.
Value Returned
t
nil
Example
The following OCEAN script sets the value of the maxOfOut output to 110 and minOfOut
to 0. The last line in this script assigns a value of 2.2 to the output name you typed in the
Name field on the Setting Outputs form when you specified the OCEAN script file.
The axlAddOutputs command must be on the first line of the file.
$ cat myMeas.ocn
axlAddOutputs( '( "maxOfOut" "minOfOut" ) )
aVar = 55
axlOutputResult( aVar*2 "maxOfOut" )
axlOutputResult( 0 "minOfOut" )
axlOutputResult( 2.2 )
January 2007
113
Product Version 6.1

Reference
axlAddOutputs
January 2007
114
Product Version 6.1
5

Function
Description
axlGetOrigTestToolArgs Returns an associative list of original tool options set for the test
before you ran the simulation after modifying the test setup.
axlGetTest
Finds a test in the setup database and returns its handle.
axlGetTestName
Returns the name of a test.
axlGetTestOceanScripts Gets the OCEAN script for the test.

axlGetTests
Returns a list containing a handle to all tests in the setup

database and a list of all test names.
axlGetTestToolArgs
Returns an associative list of tool option names and values for a

test.
axlGetTestToolName
Gets the tool used for the test.
axlInitialTestStateChanged
Returns t if the initial ADE state for the named test is newer than
the latest ADE XL test data; otherwise nil.
axlSaveResValue
Adds a name and value to the results database for the current
point. You can use this function to specify an OCEAN
measurement that you want to appear on the Outputs assistant
pane.
axlSaveTestState
Saves the current ADE setup for a test to the state from which
the test was initialized.
axlSetTestName
Renames a test.
axlSetTestOceanScripts Sets the OCEAN script to run with a test.
January 2007
115
Product Version 6.1

Test-Related SKILL Functions, continued
Function
Description
axlSetTestToolArgs
Sets the tool options for the test.
axlSetTestToolName
Sets the tool for a test.
January 2007
116
Product Version 6.1

axlGetOrigTestToolArgs
axlGetOrigTestToolArgs(
x_database
)
=> l_toolOptions / nil
Description
Returns an associative list of original tool options set for the test before you ran the simulation
after modifying the test setup.
Argument
x_database
Value Returned
l_toolOptions
Associative list of original tool options set for the test before you
ran a simulation after modifying the test setup.
nil
Example
axlGetOrigTestToolArgs( 1031 )
'(("lib"
"opamplib")
("cell" "ampTest")
("view" "schematic")
("sim"
"spectre")
("path" "./aState")
("state" "tran_state")
)
Reference
axlGetTestToolArgs, axlToolSetOriginalSetupOptions
January 2007
117
Product Version 6.1

axlGetTest
axlGetTest(
x_database
t_test
)
=> x_test / nil
Description
Finds a test in the setup database and returns its handle.
Arguments
x_database
t_test
Test name.
Value Returned
x_test
Test handle.
nil
Example
;; Enable a test
axlSetEnabled( data_dead_band t )
;; Disable tests
3
Reference
axlCreateSession, axlSetMainSetupDB, axlGetTests, axlSetEnabled
January 2007
118
Product Version 6.1

axlGetTestName
axlGetTestName(
x_test
)
=> t_name / nil
Description
Returns the name of a test.
Argument
x_test
Test handle.
Value Returned
t_name
Test name.
nil
Example
axlGetTestName 1002
"Trans_12u"
January 2007
119
Product Version 6.1

axlGetTestOceanScripts
axlGetTestOceanScripts(
x_test
)
=> t_script / nil
Description
Gets the OCEAN script for the test.
Argument
x_test
Test handle.
Value Returned
t_script
OCEAN script.
nil
Example
axlGetTestOceanScripts 1002
"myScript.ocn"
January 2007
120
Product Version 6.1

axlGetTests
axlGetTests(
x_database
)
=> l_tests / nil
Description
Returns a list containing a handle to all tests in the setup database and a list of all test names.
Argument
x_database
Value Returned
l_tests
List containing a handle to all tests in the setup database and a

list of all test names.
nil
Example
;; Disable tests
'((1011 "Trans_12u")
(1021 "dc_ac10G_2")
)
Reference
axlSetMainSetupDB, axlCreateSession, axlSetEnabled, axlGetTest
January 2007
121
Product Version 6.1

axlGetTestToolArgs
axlGetTestToolArgs(
x_database
)
=> l_toolOptions / nil
Description
Returns an associative list of tool option names and values for a test.
Argument
x_database
Value Returned
l_toolOptions
Associative list of tool option names and values for the test.
Valid Values when the tool is ADE:
lib t_libName
Library name.
cell t_cellName
Cell name.
view t_viewName
View name.
sim t_simulator
Simulator name.
state t_stateName
State name.
path t_path
nil
January 2007
Path to ADE state.
122
Product Version 6.1

Example
axlGetTestToolArgs( 1031 )
'(("lib"
"opamplib")
("cell" "ampTest")
("sim"
"spectre")
("path" "./artist_state")
("state" "tran_state")
)
Reference
axlGetOrigTestToolArgs, axlToolSetSetupOptions
January 2007
123
Product Version 6.1

axlGetTestToolName
axlGetTestToolName(
x_test
)
=> t_tool / nil
Description
Gets the tool used for the test.
Argument
x_test
Test handle.
Value Returned
t_tool
Tool used for the test.
nil
Example
axlGetTestToolName 1002
"ADE"
January 2007
124
Product Version 6.1

axlInitialTestStateChanged
axlInitialTestStateChanged(
t_session
t_test
)
=> t / nil
Description
Returns t if the initial ADE state for the named test is newer than the latest ADE XL test data;
otherwise nil.
Arguments
t_session
Session name.
t_test
Test name.
Value Returned
t
ADE state for named test is newer than latest ADE XL test data.
nil
Latest ADE XL test data for named test is newer than ADE
state.
Example
axlInitialTestStateChanged( "session0" "delayTest" )
t
January 2007
125
Product Version 6.1

axlSaveResValue
axlSaveResValue(
t_resultName
g_resultValue
)
=> t / nil
Description
Adds a name and value to the results database for the current point. You can use this function
to specify an OCEAN measurement that you want to appear on the Outputs assistant pane.
Arguments
t_resultName
Result name.
g_resultValue
Result value (number, list, or waveform).
Value Returned
t
nil
Example
axlSaveResValue( "PhaseMargin" result )
t
January 2007
126
Product Version 6.1

axlSaveTestState
axlSaveTestState(
t_session
t_test
)
=> t_adeSession / nil
Description
Saves the current ADE setup for a test to the state from which the test was initialized.
Arguments
t_session
Session name.
t_test
Test name.
Value Returned
t_adeSession
Classic ADE session name.
nil
Example
axlSaveTestState( "session0" "delayTest" )
"classicSession0"
January 2007
127
Product Version 6.1

axlSetTestName
axlSetTestName(
x_test
t_name
)
=> t / nil
Description
Renames a test.
Arguments
x_test
Test handle.
t_name
New test name.
Value Returned
t
Successful rename operation.
nil
Unsuccessful rename operation.
Example
axlSetTestName( axlPutTest( data_sdb "data_dead_band" ) "deadBand" )
t
Reference
axlCreateSession, axlPutTest, axlSetMainSetupDB
January 2007
128
Product Version 6.1

axlSetTestOceanScripts
axlSetTestOceanScripts(
x_test
t_script
)
=> t / nil
Description
Sets the OCEAN script to run with a test.
Arguments
x_test
Test handle.
t_script
OCEAN script.
Value Returned
t
nil
Example
axlSetTestOceanScripts( axlPutTest( data_sdb "data_dead_band" ) "./measures" )
t
Reference
axlCreateSession, axlSetMainSetupDB, axlPutTest
January 2007
129
Product Version 6.1

axlSetTestToolArgs
axlSetTestToolArgs(
x_database
l_toolOptions
)
=> x_database / nil
Description
Sets the tool options for the test.
Arguments
x_database
l_toolOptions
Associative list of tool option names and values for the test.
Valid Values when the tool is ADE:
lib t_libName
Library name.
cell t_cellName
Cell name.
view t_viewName
View name.
sim t_simulator
Simulator name.
state t_stateName
State name.
path t_path
Path to ADE state.
Value Returned
x_database
nil
January 2007
130
Product Version 6.1

Example
axlSetTestToolArgs( 1031
'(("lib"
"opamplib")
("cell" "ampTest")
("sim"
"spectre")
("path" "./artist_state")
("state" "tran_state"))
)
1031
January 2007
131
Product Version 6.1

axlSetTestToolName
axlSetTestToolName(
x_test
t_tool
)
=> t / nil
Description
Sets the tool for a test.
Arguments
x_test
Test handle.
t_tool
Tool name.
Valid Value:
ADE
Cadences Analog Design Environment
Value Returned
t
nil
Example
axlSetTestToolName( axlPutTest( data_sdb "data_dead_band" ) "ADE" )
t
Reference
axlCreateSession, axlPutTest, axlSetMainSetupDB
January 2007
132
Product Version 6.1
6
Specification-Related SKILL Functions

Function
Description
axlGetSpec
Finds the named specification in the setup database and returns

its handle.
axlGetSpecs
Returns a list containing a handle to all specifications in the

setup database and a list of all specification names.
axlGetSpecWeight
Returns the weight value for a specification.
axlNewSpecComp
Creates a new comparison object.
axlOpenResDB
Opens the database file specified by t_fileName. If the file

does not exist, it is created.
axlPutSpec
Finds or inserts a specification into the setup database and

returns a handle to that specification.
axlSetSpecDescription
Adds a description to the specification item.
axlSetSpecMax
Sets the maximum value allowed for the specification.
axlSetSpecMin
Sets the minimum value allowed for the specification.
axlSetSpecName
Adds a name to the specification item.
axlSetSpecResultName Associates a result name with a specification item.

axlSetSpecTarget
Sets the target value for a specification item.
axlSetSpecTestName
Sets the test name for a specification item.
axlSetSpecTol
Sets the tolerance for a specification item.
axlSetSpecTolType
Sets the tolerance type for a specification item.
axlSetSpecType
Sets the type for a specfication.
axlSetSpecWeight
Sets the weight for a specification.
January 2007
133
Product Version 6.1

axlGetSpec
axlGetSpec(
x_database
t_name
)
=> x_spec / 0
Description
Finds the named specification in the setup database and returns its handle.
Arguments
x_database
t_name
Specification name.
Value Returned
x_spec
Specification handle.
Example
axlGetSpec(1001,"opamplib:ampTest:1.gain")
1002
January 2007
134
Product Version 6.1

axlGetSpecs
axlGetSpecs(
x_database
)
=> l_list / nil
Description
Returns a list containing a handle to all specifications in the setup database and a list of all
specification names.
Argument
x_database
Value Returned
l_list
List containing a handle to all specifications in the setup

database and a list of all specification names.
nil
Example
axlGetSpecs( 1001 )
(1002 ( "opamplib:ampTest:1.gain" "opamplib:ampTest:1.bandwidth") )
January 2007
135
Product Version 6.1

axlGetSpecWeight
axlGetSpecWeight(
x_spec
)
=> t_weight / nil
Description
Returns the weight value for a specification.
Argument
x_spec
Value Returned
t_weight
Weight value.
nil
Example
spec = axlGetSpec( 1004 "gain" )
axlGetSpecWeight( spec )
1
Reference
axlGetSpec
January 2007
136
Product Version 6.1

axlNewSpecComp
axlNewSpecComp(
[ t_name ]
)
=> o_compObj / nil
Description
Creates a new comparison object.
Argument
t_name
(Optional) Name of new comparison object. If you specify a

comparision name that already exists in the setup database,
the program overwrites it.
Value Returned
o_compObj
Comparison object.
nil
Example
pfd_spec = axlNewSpecComp()
January 2007
137
Product Version 6.1

axlOpenResDB
axlOpenResDB(
t_fileName
)
=> o_obj / nil
Description
Opens the database file specified by t_fileName. If the file does not exist, it is created.
Argument
t_fileName
Database file to be opened.
Value Returned
o_obj
Object handle to the database.
nil
Example
resDB=axlGetHistoryResults(axlGetRunData(session runid))
obj = axlOpenResDB(resDB)
Reference
axlGetHistoryResults, axlGetRunData
January 2007
138
Product Version 6.1

axlPutSpec
axlPutSpec(
x_database
t_name
)
=> x_spec / 0
Description
Finds or inserts a specification into the setup database and returns a handle to that
specification.
Arguments
x_database
t_name
Specification name.
Value Returned
x_spec
Example
axlPutSpec(1001,"opamplib:ampTest:1.gain")
1002
January 2007
139
Product Version 6.1

axlSetSpecDescription
axlSetSpecDesc(
x_spec
t_desc
)
=> t / nil
Description
Adds a description to the specification item.
Arguments
x_spec
t_desc
Quoted description/title text.
Value Returned
t
nil
Example
spec = axlGetSpec( 1004 "olg" )
axlSetSpecDescription( spec "open loop gain" )
January 2007
140
Product Version 6.1

axlSetSpecMax
axlSetSpecMax(
x_spec
t_value
)
=> t / nil
Description
Sets the maximum value allowed for the specification.
Arguments
x_spec
t_value
Maximum value.
Value Returned
t
nil
Example
axlSetSpecMax( spec "5u" )
January 2007
141
Product Version 6.1

axlSetSpecMin
axlSetSpecMin(
x_spec
t_value
)
=> t / nil
Description
Sets the minimum value allowed for the specification.
Arguments
x_spec
t_value
Minimum value.
Value Returned
t
nil
Example
axlSetSpecMin( spec "1n" )
January 2007
142
Product Version 6.1

axlSetSpecName
axlSetSpecName(
x_spec
t_specName
)
=> t / nil
Description
Adds a name to the specification item.
Arguments
x_spec
t_specName
Name of the specification.
Value Returned
t
Successful operation
nil
Example
axlSetSpecName( spec "opamplib:ampTest:1.gain" )
January 2007
143
Product Version 6.1

axlSetSpecResultName
axlSetSpecResultName(
x_spec
t_resultName
)
=> t / nil
Description
Associates a result name with a specification item.
Arguments
x_spec
t_resultName
Result name.
Value Returned
t
nil
Example
axlSetSpecResultName( spec "Gain" )
January 2007
144
Product Version 6.1

axlSetSpecTarget
axlSetSpecTarget(
x_spec
t_targetValue
)
=> t / nil
Description
Sets the target value for a specification item.
Arguments
x_spec
t_targetValue
Target value for specification.
Value Returned
t
nil
Example
axlSetSpecTarget( 1078 "500n" )
t
January 2007
145
Product Version 6.1

axlSetSpecTestName
axlSetSpectTestName(
x_spec
t_testName
)
=> t / nil
Description
Sets the test name for a specification item.
Arguments
x_spec
t_testName
Test name.
Value Returned
t
nil
Example
axlSetSpectTestName( 1078 "opamplib.ampTest:1" )
t
January 2007
146
Product Version 6.1

axlSetSpecTol
axlSetSpecTol(
x_spec
t_tolerance
)
=> t / nil
Description
Sets the tolerance for a specification item.
Arguments
x_spec
t_tolerance
Tolerance.
Value Returned
t
nil
Example
axlSetSpecTol( 1078 "<40n" )
t
January 2007
147
Product Version 6.1

axlSetSpecTolType
axlSetSpecTol(
x_spec
t_toleranceType
)
=> t / nil
Description
Sets the tolerance type for a specification item.
Arguments
x_spec
t_toleranceType
Tolerance type.
Valid Values:
%
Percent
Value Returned
t
nil
Example
axlSetSpecTol( 1078 "%" )
t
January 2007
148
Product Version 6.1

axlSetSpecType
axlSetSpecType(
x_spec
t_type
)
=> t / nil
Description
Sets the type for a specfication.
Arguments
x_spec
t_type
Specification type.
Valid Values:
min
Minimize
max
Maximize
gt
Greater than
lt
Less than
range
Range
tol
Tolerance
info
Information
Value Returned
x_spec
nil
January 2007
149
Product Version 6.1

Example
The following example defines the gain specification as type maximize:
axlSetSpecType( spec "max" )
t
Reference
axlGetSpec
January 2007
150
Product Version 6.1

axlSetSpecWeight
axlSetSpecWeight(
x_spec
t_weight
)
=> t / nil
Description
Sets the weight for a specification.
Arguments
x_spec
t_weight
Weight value.
Value Returned
t
nil
Example
The following example sets the weight value to 1 for the gain specification:
axlSetSpecWeight( spec "1" )
t
January 2007
151
Product Version 6.1

January 2007
152
Product Version 6.1
7
Corners-Related SKILL Functions

Function
Description
axlGetAllCornersEnabled
Returns t if all corners are enabled in the specified setup
database; otherwise, returns nil.
axlGetCorner
Finds a corner by name and returns a handle to that corner.
axlGetCornerName
Returns the name of a corner.
axlGetCorners
Returns a list containing a handle to all corners in the setup

database and a list of all corner names.
axlGetDefaultCornerEnabled
Returns t if the default corner is enabled in the specified setup
axlGetDisabledCorner
Finds a disabled corner on a test and returns a handle to that

disabled corner.
axlGetDisabledCorners
Returns a list containing a handle to all disabled corners for this

test and a list of all disabled corner names.
axlGetNominalCornerEnabled
Returns t if the nominal corner is enabled in the specified setup
axlPutCorner
Inserts or finds a corner by name and returns a handle to that

corner.
axlPutDisabledCorner
Inserts or finds a disabled corner on a test and returns a handle

to that disabled corner.
axlSetCornerName
Sets the name of a corner.
January 2007
153
Product Version 6.1

Corners-Related SKILL Functions, continued
Function
Description
axlSetDefaultCornerEnabled
Enables or disables the default corner for the specified test. The
program creates a default corner when you create a test. The
default corner represents the absence of corner-specific
information.
January 2007
154
Product Version 6.1

axlGetAllCornersEnabled
axlGetAllCornersEnabled(
x_database
)
=> t / nil
Description
Returns t if all corners are enabled in the specified setup database; otherwise, returns nil.
Argument
x_database
Value Returned
t
All corners enabled.
nil
All corners not enabled.
Example
axlGetAllCornersEnabled 1003
t
January 2007
155
Product Version 6.1

axlGetCorner
axlGetCorner(
x_database
t_name
)
=> x_corner / nil
Description
Finds a corner by name and returns a handle to that corner.
Arguments
x_database
t_name
Corner name.
Value Returned
x_corner
Handle to a corner.
nil
Example
;; Disable corners
foreach( corner cadr( axlGetCorners( data_sdb ) )
axlSetEnabled( axlGetCorner( data_sdb corner ) nil )
)
Reference
axlCreateSession, axlSetMainSetupDB, axlSetEnabled, axlGetCorners
January 2007
156
Product Version 6.1

axlGetCornerName
axlGetCornerName(
x_corner
)
=> t_name / nil
Description
Returns the name of a corner.
Argument
x_corner
Handle to a corner.
Value Returned
t_name
Corner name.
nil
Example
axlGetCornerName 1003
"C0"
January 2007
157
Product Version 6.1

axlGetCorners
axlGetCorners(
x_database
)
=> l_corners / nil
Description
Returns a list containing a handle to all corners in the setup database and a list of all corner
names.
Argument
x_database
Value Returned
l_corners
List containing a handle to all corners in the setup database

and a list of all corner names.
nil
Example
;; Disable corners
foreach( corner cadr( axlGetCorners( data_sdb ) )
axlSetEnabled( axlGetCorner( data_sdb corner ) nil )
)
axlGetCorners 1003
'((1100 "C0")
(1200 "C1")
(1300 "C2")
)
Reference
axlCreateSession, axlSetMainSetupDB, axlSetEnabled, axlGetCorner
January 2007
158
Product Version 6.1

axlGetDefaultCornerEnabled
axlGetDefaultCornerEnabled(
x_database
)
=> t / nil
Description
Returns t if the default corner is enabled in the specified setup database; otherwise, returns
nil.
Argument
x_test
Value Returned
t
Default corner enabled.
nil
Default corner disabled.
Example
axlGetDefaultCornerEnabled 1003
t
January 2007
159
Product Version 6.1

axlGetDisabledCorner
axlGetDisabledCorner(
x_test
t_name
)
=> x_disabledcorner / nil
Description
Finds a disabled corner on a test and returns a handle to that disabled corner.
Arguments
x_test
Test handle.
t_name
Corner name.
Value Returned
x_disabledcorner
Handle to a disabled corner.
nil
Example
axlGetDisabledCorner 1001 "C0"
1100
January 2007
160
Product Version 6.1

axlGetDisabledCorners
axlGetDisabledCorners(
x_test
)
=> l_disabledcorners / nil
Description
Returns a list containing a handle to all disabled corners for this test and a list of all disabled
corner names.
Argument
x_test
Test handle.
Value Returned
l_disabledcorners
List containing a handle to all disabled corners for this database
entry and a list of all disabled corner names.
nil
Example
axlGetDisabledCorners 1001
'((1100 "C0")
(1300 "C2")
)
January 2007
161
Product Version 6.1

axlGetNominalCornerEnabled
axlGetNominalCornerEnabled(
x_database
)
=> t / nil
Description
Returns t if the nominal corner is enabled in the specified setup database; otherwise, returns
nil.
Argument
x_database
Value Returned
t
Nominal corner enabled.
nil
Nominal corner disabled.
Example
axlGetNominalCornerEnabled 1003
t
January 2007
162
Product Version 6.1

axlPutCorner
axlPutCorner(
x_database
t_name
)
=> x_corner / nil
Description
Inserts or finds a corner by name and returns a handle to that corner.
Arguments
x_database
t_name
Corner name.
Value Returned
x_corner
Handle to a corner.
nil
Example
axlPutCorner( data_sdb "c1" )
4002
Reference
January 2007
163
Product Version 6.1

axlPutDisabledCorner
axlPutDisabledCorner(
x_test
t_name
)
=> x_disabledcorner / nil
Description
Inserts or finds a disabled corner on a test and returns a handle to that disabled corner.
Arguments
x_test
Test handle.
t_name
Corner name.
Value Returned
x_disabledcorner
Handle to a disabled corner.
nil
Example
axlPutDisabledCorner 1001 "tran1"
1020
January 2007
164
Product Version 6.1

axlSetCornerName
axlSetCornerName(
x_corner
t_name
)
=> t / nil
Description
Sets the name of a corner.
Arguments
x_corner
Handle to a corner.
t_name
Corner name.
Value Returned
t
nil
Example
axlSetCornerName 102 "myCorner"
t
January 2007
165
Product Version 6.1

axlSetDefaultCornerEnabled
axlSetDefaultCornerEnabled(
x_test
g_enable
)
=> t / nil
Description
Enables or disables the default corner for the specified test. The program creates a default
corner when you create a test. The default corner represents the absence of corner-specific
information.
Arguments
x_test
Test handle.
g_enable
Enable flag.
Valid Values:
nil
Disables the default corner for the test.
any other value
Enables the default corner for the test.
Value Returned
t
nil
Example
axlSetDefaultCornerEnabled( data_dead_band nil )
t
Reference
axlCreateSession, axlGetTest, axlSetMainSetupDB
January 2007
166
Product Version 6.1
8

Function
Description
axlGetAllActiveRuns
Returns a list of run IDs for all runs in progress.
axlGetAllFinishedRuns
Returns a list of run IDs for all runs that have completed.
axlGetAllSweepsEnabled
Returns t if all sweeps are enabled; otherwise, returns nil.
axlGetPercentComplete Returns the percent complete for the specified run.
axlGetRunData
Returns the database handle for the run details of an ADE XL

run.
axlGetRunMode
Returns a handle to the named run mode in the specified setup

database.
axlGetRunModes
Returns a list of available run modes from the specified setup

database.
axlGetRunOption
Returns a handle to the named run option (t_name) in the setup

database for the specified run mode (t_mode).
axlGetRunOptionName
Returns the run option name.
axlGetRunOptions
Returns a list containing a handle to all run options in the setup

database and a list of all run option names.
axlGetRunOptionValue
Returns the run option value.
axlIsActiveRun
Returns t if the specified run is still active ( has not yet

completed ); otherwise nil.
axlIsPausedRun
Returns t if the specified run is paused and active; otherwise

nil.
January 2007
167
Product Version 6.1

Run-Related SKILL Functions, continued
Function
Description
axlPauseRun
Returns t if the specified run is still running and the state was
changed; otherwise nil. If you set g_pause to t, the state of
the run is set to paused.
axlPutRunOption
Adds a run option to the setup database or edits an existing one

and returns the handle to the option. The list of valid option
names (t_name) depends on the run mode (t_mode).
axlRun
Starts an ADE XL run.
axlRunAllTests
Starts an ADE XL run of all enabled tests.
axlRunAllTestsWithCallback
Starts an ADE XL run of all enabled tests and specifies a SKILL
expression to call upon their completion.
axlRunWithCallback
Starts an ADE XL run and specifies a SKILL expression to call

upon its completion.
axlSetRunCompleteCallback
Sets the callback to run upon completion of the specified run,
superseding any callback set previously.
axlSetRunOptionName
Sets the run option name.
axlSetRunOptionValue
Sets the run option value.
January 2007
168
Product Version 6.1

axlGetAllActiveRuns
axlGetAllActiveRuns(
t_session
)
=> l_runs / nil
Description
Returns a list of run IDs for all runs in progress.
Argument
t_session
Session name.
Value Returned
l_runs
List of runs in progress.
nil
No runs in progress.
Example
axlGetAllActiveRuns( "session0" )
'(3 4 5)
January 2007
169
Product Version 6.1

axlGetAllFinishedRuns
axlGetAllFinishedRuns(
t_session
)
=> l_runs / nil
Description
Returns a list of run IDs for all runs that have completed.
Argument
t_session
Session name.
Value Returned
l_runs
List of runs that have completed.
nil
Example
axlGetAllFinishedRuns( "session0" )
'(0 1 2)
January 2007
170
Product Version 6.1

axlGetAllSweepsEnabled
axlGetAllSweepsEnabled(
x_database
)
=> t / nil
Description
Returns t if all sweeps are enabled; otherwise, returns nil.
Argument
x_database
Value Returned
t
All corners are enabled.
nil
Example
axlGetAllSweepsEnabled 1003
t
January 2007
171
Product Version 6.1

axlGetPercentComplete
axlGetPercentComplete(
t_session
x_runid
)
=> x_percent / nil
Description
Returns the percent complete for the specified run.
Arguments
t_session
Session name.
x_runid
Run ID.
Value Returned
x_percent
Percent complete for the specified run.
nil
Example
axlGetPercentComplete "session0" 1
50
January 2007
172
Product Version 6.1

axlGetRunData
axlGetRunData(
t_session
x_runid
)
=> x_runDetails / nil
Description
Returns the database handle for the run details of an ADE XL run.
Arguments
t_session
Session name.
x_runid
Run ID.
Value Returned
x_runDetails
Database handle for run details of ADE XL run.
nil
Example
data_session = axlCreateSession( "data_session" )
design_data = axlRunAllTestsWithCallback( data_session "Single Run, Sweeps and
Corners" "( callbackProcedure )" )
axlGetRunData( data_session design_data )
1500
Reference
axlCreateSession, axlRunAllTestsWithCallback
January 2007
173
Product Version 6.1

axlGetRunMode
axlGetRunMode(
x_database
t_mode
)
=> x_mode / nil
Description
Returns a handle to the named run mode in the specified setup database.
Argument
x_database
t_mode
Run mode.
Valid Values:
Single Run, Sweeps and Corners
Sampling
Global Optimization
Local Optimization
Monte Carlo Sampling
Value Returned
x_mode
Run mode handle.
nil
Example
axlGetRunMode( 1004 "Global Optimization" )
1058
Reference
axlGetRunModes, axlRun, axlRunAllTests, axlRunAllTestsWithCallback,
axlRunWithCallback
January 2007
174
Product Version 6.1

axlGetRunModes
axlGetRunModes(
x_database
)
=> l_modes / nil
Description
Returns a list of available run modes from the specified setup database.
Argument
t_database
Value Returned
l_mode
List of run mode handles and run mode names.
nil
Example
axlGetRunModes( 1003 )
(1182
("Global Optimization" "Monte Carlo Sampling")
)
January 2007
175
Product Version 6.1

axlGetRunOption
axlGetRunOption(
x_database
t_mode
t_name
)
=> x_runOption / nil
Description
Returns a handle to the named run option (t_name) in the setup database for the specified
run mode (t_mode).
Arguments
x_database
t_mode
Run mode.
Valid Values:
Sampling
Global Optimization
Local Optimization
t_name
Run option name.

Valid Values depend on t_mode as follows:
For Sampling:
points
Number of sampling points
For Global Optimization:

tillsatisfied
Optimization stops when all goals are met
timelimit Optimization stops when the program
reaches the time limit (in minutes)
numpoints Optimization stops when the program
reaches the number of points
January 2007
176
Product Version 6.1

ptswithnoimprovement
Optimization stops when there is no
improvement for the number of points
For Local Optimization:
effort
Optimization effort
tillsatisfied
For Monte Carlo Sampling:
mcmethod
Monte Carlo Sampling method
mcnumpoints
Number of Monte Carlo sampling points
Note: Typically, this number should be at
least the number of statistical variables.
Value Returned
x_runOption
Handle to named run option.
nil
Example
axlGetRunOption( 1004 "Sampling" "points" )
1048
January 2007
177
Product Version 6.1

Reference
axlGetRunOptionName, axlGetRunOptionValue, axlSetRunOptionName,
January 2007
178
Product Version 6.1

axlGetRunOptionName
axlGetRunOptionName(
x_runOption
)
=> t_name / nil
Description
Returns the run option name.
Argument
x_runOption
Run option handle.
Value Returned
t_name
Run option name.
nil
Example
axlGetRunOptionName( 1048 )
"points"
Reference
axlGetRunOption, axlPutRunOption
January 2007
179
Product Version 6.1

axlGetRunOptions
axlGetRunOptions(
x_database
)
=> l_list / nil
Description
Returns a list containing a handle to all run options in the setup database and a list of all run
option names.
Argument
x_database
Value Returned
l_list
List containing a handle to all run options in the setup database

and a list of all run option names.
nil
Example
axlGetRunOptions( 1004 )
'( 1042 ( "points" ) )
January 2007
180
Product Version 6.1

axlGetRunOptionValue
axlGetRunOptionName(
x_runOption
)
=> t_value / nil
Description
Returns the run option value.
Argument
x_runOption
Run option handle.
Value Returned
t_value
Run option value.
nil
Example
axlGetRunOptionValue( 1048 )
"10"
Reference
axlGetRunOption, axlGetRunOptionName, axlPutRunOption, axlSetRunOptionName,
January 2007
181
Product Version 6.1

axlIsActiveRun
axlIsActiveRun(
t_session
x_runid
)
=> t / nil
Description
Returns t if the specified run is still active ( has not yet completed ); otherwise nil.
Arguments
t_session
Session name.
x_runid
Run ID.
Value Returned
t
Run is active.
nil
Run is not active.
Example
axlIsActiveRun "session0" 1001
t
January 2007
182
Product Version 6.1

axlIsPausedRun
axlIsPausedRun(
t_session
x_runid
)
=> t / nil
Description
Returns t if the specified run is paused and active; otherwise nil.
Arguments
t_session
Session name.
x_runid
Run ID.
Value Returned
t
Run is paused and active.
nil
Otherwise.
Example
axlIsPausedRun "session0" 1001
t
January 2007
183
Product Version 6.1

axlPauseRun
axlPauseRun(
t_session
x_runid
g_pause
)
=> t / nil
Description
Returns t if the specified run is still running and the state was changed; otherwise nil. If you
set g_pause to t, the state of the run is set to paused.
Arguments
t_session
Session name.
x_runid
Run ID.
g_pause
Set to t if you want the run to pause.
Value Returned
t
Run is active and the state is changed.
nil
Otherwise.
Example
axlPauseRun "session0" 1001 nil
t
January 2007
184
Product Version 6.1

axlPutRunOption
axlPutRunOption(
x_database
t_mode
t_name
)
=> x_runOption / nil
Description
Adds a run option to the setup database or edits an existing one and returns the handle to
the option. The list of valid option names (t_name) depends on the run mode (t_mode).
Note: Any unsupported option names you specify will have unspecified effects on the
behavior of the run mode. There are no run options for the Single Run, Sweeps and
Corners run mode.
Arguments
x_database
t_mode
Run mode.
Valid Values:
Sampling
Global Optimization
Local Optimization
t_name
Run option name.

Valid Values depend on t_mode as follows:
For Sampling:
points
Number of sampling points
For Global Optimization:

tillsatisfied
January 2007
185
Product Version 6.1


For Local Optimization:
Optimization effort
effort
tillsatisfied
For Monte Carlo Sampling:
Monte Carlo Sampling method
mcmethod
mcnumpoints
Number of Monte Carlo sampling points
Note: Typically, this number should be at
least the number of statistical variables.
Value Returned
x_runOption
Handle to run option.
nil
Example
axlPutRunOption 1004 "Sampling" "points"
1048
January 2007
186
Product Version 6.1

Reference
axlGetRunOption, axlGetRunOptions, axlRun, axlRunAllTests,
axlRunAllTestsWithCallback, axlRunWithCallback
January 2007
187
Product Version 6.1

axlRun
axlRun(
t_session
t_mode
t_test
)
=> x_runid / nil
Description
Starts an ADE XL run.
Arguments
t_session
Session name.
t_mode
Run mode.
Valid Values:
Sampling
Global Optimization
Local Optimization
t_test
Test name.
Value Returned
x_runid
Run ID.
nil
Example
axlRun "session0" "Single Run, Sweeps and Corners" "test1"
1
January 2007
188
Product Version 6.1

Reference
axlRunAllTests, axlRunAllTestsWithCallback, axlRunWithCallback, axlGetRunMode,
axlGetRunModes
January 2007
189
Product Version 6.1

axlRunAllTests
axlRunAllTests(
t_session
t_mode
)
=> x_runid / nil
Description
Starts an ADE XL run of all enabled tests.
Arguments
t_session
Session name.
t_mode
Run mode.
Valid Values:
Sampling
Global Optimization
Local Optimization
Value Returned
x_runid
Run ID.
nil
Example
axlRunAllTests "session0" "Single Run, Sweeps and Corners"
1
January 2007
190
Product Version 6.1

axlRunAllTestsWithCallback
axlRunAllTestsWithCallback(
t_session
t_mode
t_callback
)
=> x_runid / nil
Description
Starts an ADE XL run of all enabled tests and specifies a SKILL expression to call upon their
completion.
Arguments
t_session
Session name.
t_mode
Run mode.
Valid Values:
Sampling
Global Optimization
Local Optimization
t_callback
SKILL expression for callback.
Value Returned
x_runid
Run ID.
nil
Example
axlRunAllTestsWithCallback( ( axlCreateSession "data_session" ) "Single Run,
Sweeps and Corners" "( "printf(\"run complete\")" )" )
1001
January 2007
191
Product Version 6.1

Reference
axlCreateSession
January 2007
192
Product Version 6.1

axlRunWithCallback
axlRunWithCallback(
t_session
t_mode
t_test
t_callback
)
=> x_runid / nil
Description
Starts an ADE XL run and specifies a SKILL expression to call upon its completion.
Arguments
t_session
Session name.
t_mode
Run mode.
Valid Values:
Sampling
Global Optimization
Local Optimization
t_test
Test name.
t_callback
Value Returned
x_runid
Run ID.
nil
January 2007
193
Product Version 6.1

Example
axlRunWithCallback "session0" "Single Run, Sweeps and Corners" "test1"
"printf(\"test done\")"
1001
January 2007
194
Product Version 6.1

axlSetRunCompleteCallback
axlSetRunCompleteCallback(
t_session
x_runid
t_callback
)
=> t / nil
Description
Sets the callback to run upon completion of the specified run, superseding any callback set
previously.
Arguments
t_session
Session name.
x_runid
Run ID.
t_callback
Value Returned
t
nil
Example
axlSetRunCompleteCallback "session0" 1005 "printf(\"run complete\")"
t
January 2007
195
Product Version 6.1

axlSetRunOptionName
axlSetRunOptionName(
x_runOption
t_name
)
=> t / nil
Description
Sets the run option name.
Arguments
x_runOption
Run option handle.
t_name
Run option name.
Value Returned
t
nil
Example
axlSetRunOptionName( 1048 "points" )
t
Reference
axlGetRunOption, axlGetRunOptionName, axlGetRunOptions, axlGetRunOptionValue,
January 2007
196
Product Version 6.1

axlSetRunOptionName(
x_runOption
t_value
)
=> t / nil
Description
Sets the run option value.
Arguments
x_runOption
Run option handle.
t_value
Run option value.

Valid Values depend on the run option mode and name as
follows.
For Sampling run mode

If the run option is
Valid Values for t_value are as follows:
points
Number of sampling points.

Valid Values: Any integer passed to the function as a string
For Global Optimization run mode

tillsatisfied
Optimization stops when all goals are met.

Valid Values:
1
On
Off
Default Value: 0 (Off)

timelimit
January 2007
Optimization stops when the program reaches the time limit (in
minutes).
197
Product Version 6.1

For Global Optimization run mode

numpoints
Optimization stops when the program reaches the number of

points.
Optimization stops when there is no improvement for the
number of points.
For Local Optimization run mode
effort
Optimization effort.
Valid Values:
tillsatisfied
coarse
Lower optimization effort.
fine
Fine grid searching around starting point.
Optimization stops when all goals are met.

Valid Values:
1
On
Off
Default Value: 0 (Off)

timelimit
Optimization stops when the program reaches the time limit (in
minutes).
numpoints
Optimization stops when the program reaches the number of

points.
Optimization stops when there is no improvement for the
number of points.
January 2007
198
Product Version 6.1

For Monte Carlo Sampling run mode

mcmethod
Monte Carlo Sampling method.

Valid Values:
global
The program varies only process/global

statistical parameters during Monte Carlo
run
mismatch
The program varies only mismatch statistical

parameters during Monte Carlo run
all
The program varies both process/global and

mismatch statistical parameters during
Monte Carlo run
Default Value: all

mcnumpoints
Number of Monte Carlo sampling points.

Typically, this number should be at least the number of
statistical variables.
Value Returned
t
nil
Example
axlSetRunOptionValue( 1048 "global" )
t
Reference
axlGetRunOption, axlGetRunOptionName, axlGetRunOptionValue, axlRun,
axlRunAllTests, axlRunAllTestsWithCallback, axlRunWithCallback,
axlSetRunOptionName
January 2007
199
Product Version 6.1

January 2007
200
Product Version 6.1
9
History-Related SKILL Functions

Function
Description
axlGetCurrentHistory
Returns the internal integer value representing the current

history entry in active use.
axlGetHistory
Returns a list containing a handle to all history entries in the

setup database and a list of all history entries.
axlGetHistoryCheckpoint
Returns a handle to the checkpoint of a history entry.
axlGetHistoryEntry
Finds a history entry in the setup database and returns a handle

to that entry.
axlGetHistoryGroup
Returns a handle to the named history group in the setup

database.
axlGetHistoryMode
Gets the run mode from a history entry.
axlGetHistoryResults
Gets the results database from a history entry. This function calls
axlGetResultsLocation to get the results location.
axlGetHistoryResultsDir Gets the results directory from a history entry. This function calls
axlGetHistoryTest
Gets the test name from a history entry.
axlLoadHistory
Copies the setup database branch and returns the handle to the
copy.
axlPutHistoryEntry
Inserts or finds a history entry in the setup database and returns

a handle to that entry.
axlSetHistoryMode
Sets the run mode for a history entry.
axlSetHistoryResults
Sets the results database for a history entry.
January 2007
201
Product Version 6.1

History-Related SKILL Functions, continued
Function
Description
axlSetHistoryTest
Sets the test name for a history entry.
January 2007
202
Product Version 6.1

axlGetCurrentHistory
axlGetCurrentHistory(
t_sessionName
)
=> x_historyHandle / nil
Description
Returns the internal integer value representing the current history entry in active use.
Argument
t_sessionName
ADE XL session name.
Value Returned
x_historyHandle
Integer value representing the handle to the currently active

history entry.
nil
Example
axlGetCurrentHistory( "session0" )
1002
January 2007
203
Product Version 6.1

axlGetHistory
axlGetHistory(
x_database
)
=> l_history / nil
Description
Returns a list containing a handle to all history entries in the setup database and a list of all
history entries.
Argument
x_database
Value Returned
l_history
List containing a handle to all history entries in the setup

database and a list of all history entries.
nil
Example
axlGetHistory 1002
'(1045
("Interactive.0" "Interactive.1" "Interactive.2")
)
January 2007
204
Product Version 6.1

axlGetHistoryCheckpoint
axlGetHistoryCheckpoint(
x_history
)
=> x_checkpoint / nil
Description
Returns a handle to the checkpoint of a history entry.
Argument
x_history
Handle to a history entry.
Value Returned
x_checkpoint
Handle to a checkpoint.
nil
Example
axlLoadHistory( data_sdb
axlGetHistoryCheckpoint( axlGetHistoryEntry( data_sdb "data_design_verification" )
) )
1203
Reference
axlCreateSession, axlSetMainSetupDB, axlLoadHistory, axlGetHistoryEntry
January 2007
205
Product Version 6.1

axlGetHistoryEntry
axlGetHistoryEntry(
x_database
t_name
)
=> x_history / nil
Description
Finds a history entry in the setup database and returns a handle to that entry.
Arguments
x_database
t_name
History entry name.
Value Returned
x_history
nil
Example
if( axlGetHistoryEntry( data_sdb "data_design_verification" )==0
error( "Failed to get history item named 'data_design_verification'" ) )
1004
Reference
axlSetMainSetupDB, axlCreateSession
January 2007
206
Product Version 6.1

axlGetHistoryGroup
axlGetHistoryGroup(
x_database
t_name
)
=> x_history / nil
Description
Returns a handle to the named history group in the setup database.
Arguments
x_database
t_name
History group name.
Value Returned
x_history
Handle to history group.
nil
Example
axlGetHistoryGroup(1048 "ImproveYield.1")
2096
January 2007
207
Product Version 6.1

axlGetHistoryMode
axlGetHistoryMode(
x_history
)
=> t_mode / nil
Description
Gets the run mode from a history entry.
Argument
x_history
Value Returned
t_mode
Run mode.
Valid Values:
Sampling
Global Optimization
Local Optimization
nil
Example
axlGetHistoryMode 2001
"Single Run, Sweeps and Corners"
January 2007
208
Product Version 6.1

axlGetHistoryName
axlGetHistoryName(
x_historyEntry
)
=> t_historyName / nil
Description
Returns the name of the history item that holds the data for the latest simulation run.
Argument
x_historyEntry
Integer argument representing the history entry.
Value Returned
t_historyName
String value representing the name of the history item.
nil
Example
axlGetHistoryName( axlGetHistoryEntry( "session0" ) )
"Interactive.0"
January 2007
209
Product Version 6.1

axlGetHistoryResults
axlGetHistoryResults(
x_history
)
=> t_results / nil
Description
Gets the results database from a history entry. This function calls
Argument
x_history
Value Returned
t_results
Results database.
nil
Example
data_session = axlCreateSession( "data_session" )
design_data = axlRunAllTestsWithCallback( data_session "Single Run, Sweeps and
Corners" "( callbackProcedure )" )
axlGetHistoryResults( axlGetRunData( data_session design_data ) )

"Interactive.0.rdb"
Reference
axlCreateSession, axlRunAllTestsWithCallback, axlGetRunData
January 2007
210
Product Version 6.1

axlGetHistoryResultsDir
axlGetHistoryResultsDir(
x_history
)
=> t_resultsDir / nil
Description
Gets the results directory from a history entry. This function calls
Argument
x_history
Value Returned
t_resultsDir
Results directory.
nil
Example
axlGetHistoryResultsDir 1002
"results/data"
January 2007
211
Product Version 6.1

axlGetHistoryTest
axlGetHistoryTest(
x_history
)
=> t_test / nil
Description
Gets the test name from a history entry.
Argument
x_history
Value Returned
t_test
Test name.
nil
Example
axlGetHistoryTest 1024
"dc_ac10G_2"
January 2007
212
Product Version 6.1

axlLoadHistory
axlLoadHistory(
x_to
x_from
)
=> x_database / nil
Description
Copies the setup database branch and returns the handle to the copy.
Arguments
x_to
Handle to target ( copied ) setup database.
x_from
Handle to source setup database branch.
Value Returned
x_database
Handle to copied setup database.
nil
Example
axlLoadHistory( data_sdb
axlGetHistoryCheckpoint( axlGetHistoryEntry( data_sdb "data_design_verification" )
) )
1050
Reference
axlCreateSession, axlGetHistoryCheckpoint, axlGetHistoryEntry, axlSetMainSetupDB
January 2007
213
Product Version 6.1

axlPutHistoryEntry
axlPutHistoryEntry(
x_database
t_name
)
=> x_history / nil
Description
Inserts or finds a history entry in the setup database and returns a handle to that entry.
Arguments
x_database
t_name
History entry name.
Value Returned
x_history
nil
Example
axlPutHistoryEntry( data_sdb "data_design_verification" )
1006
Reference
January 2007
214
Product Version 6.1

axlSetHistoryMode
axlSetHistoryMode(
x_history
t_mode
)
=> t / nil
Description
Sets the run mode for a history entry.
Arguments
x_history
t_mode
Run mode.
Valid Values:
Sampling
Global Optimization
Local Optimization
Value Returned
t
nil
Example
axlSetHistoryMode 2001 "Single Run, Sweeps and Corners"
t
January 2007
215
Product Version 6.1

axlSetHistoryTest
axlSetHistoryTest(
x_history
t_test
)
=> t / nil
Description
Sets the test name for a history entry.
Arguments
x_history
t_test
Test name.
Value Returned
t
nil
Example
axlSetHistoryTest 1003 "tran1"
t
January 2007
216
Product Version 6.1

axlSetHistoryResults
axlSetHistoryResults(
x_history
t_results
)
=> t / nil
Description
Sets the results database for a history entry.
Arguments
x_history
t_results
Results database.
Value Returned
t
nil
Example
axlSetHistoryResults 1006 "data.rdb"
t
January 2007
217
Product Version 6.1

January 2007
218
Product Version 6.1
10

Function
Description
axlAddJobPolicy
Adds a job policy to the setup.
axlAttachJobPolicy
Adds and attaches a job policy to the setup. The second

argument is a disembodied property list of job policy properties.
The function overwrites properties of the named job policy if it
already exists.
axlDeleteJobPolicy
Deletes the named job policy from the setup.
axlGetAttachedJobPolicy Returns the current job policy attached to the setup.

axlGetJobPolicy
Returns a disembodied property list containing property-value

pairs for the job policy.
axlGetJobPolicyTypes
Returns a list containing names of all available job policies.
axlIsICRPProcess
Returns t if the code is currently running in a remote child

process for ADE XL. You can use this function in your
.cdsinit file or in custom SKILL code.
axlSetJobPolicyProperty
Adds a property name/value pair to the job policy.
axlStopAllJobs
Stops all the jobs present in the system.
axlStopJob
Stops a job.
January 2007
219
Product Version 6.1

axlAddJobPolicy
axlAddJobPolicy(
t_jobPolicyName
l_jobPolicyProperties
)
=> t / nil
Description
Adds a job policy to the setup.
Arguments
t_jobPolicyName
Job policy name.
Disembodied property list ( DPL ) of job policy properties.
Valid Values:
configuretimeout "x_configureTimeout"
Integer number of seconds to wait for the
icrp process to report back to ADE XL that
it has configured the job. The wait time starts
as soon as ADE XL sends the job configure
command. See "Specifying Job Timeouts" in
the Virtuoso ADE XL User Guide for more
information.
distributionmethod t_method
Job distribution method. The job distribution
method you specify determines which
properties you can specify.
Valid Values:
LBS - The program runs simulations on the
local host.
Command - You send a command to the
distributed processing software.
January 2007
220
Product Version 6.1

Remote-Host - The program runs

simulations on the remote host that you
specify.
Local - The program runs simulations on
the local host.
jobhostname t_remoteHostName
( LBS and Remote-Host only ) Name of the
remote host on which to start the job.
jobqueue t_queueName
( LBS only ) Name of the LBS/LSF queue.
jobresourcerequirements t_LSFresources
( LBS only ) Additional job resource
requirements for LSF.
jobsubmitcommand t_command
( Command only ) Job submit command. See
"Specifying a Job Submit Command" in the
Virtuoso ADE XL User Guide for more
information.
maxjobs "x_maxJobs"
Maximum number of jobs that can be
present in the system at a time.
runtimeout "x_runTimeout"
it has run the job. The wait time starts as
soon as ADE XL sends the run command for
the job. See "Specifying Job Timeouts" in the
information.
January 2007
221
Product Version 6.1

starttimeout "x_startTimeout"
Integer number of seconds of time to wait for
the icrp process to report back to ADE XL
that it has started the job. The wait time
starts as soon as ADE XL submits the job.
See "Specifying Job Timeouts" in the
information.
Value Returned
t
Successful addition of the job policy.
nil
Unsuccessful addition of the job policy.
Example
axlAddJobPolicy( "mypolicy"
'( nil distributionmethod "LBS"
configuretimeout "300"
maxjobs "5"
name "default"
runtimeout "3600"
starttimeout "300" ) )
t
January 2007
222
Product Version 6.1

axlAttachJobPolicy
axlAttachJobPolicy(
t_jobPolicyName
)
=> t / nil
Description
Adds and attaches a job policy to the setup. The second argument is a disembodied property
list of job policy properties. The function overwrites properties of the named job policy if it
already exists.
See "Setting Up Job Policies" in the Virtuoso ADE XL User Guide for more information.
Arguments
t_jobPolicyName
Job policy name.
Valid Values:
configuretimeout "x_configureTimeout"
it has configured the job. The wait time starts
as soon as ADE XL sends the job configure
command. See "Specifying Job Timeouts" in
the Virtuoso ADE XL User Guide for more
information.
distributionmethod t_method
Job distribution method. The job distribution
method you specify determines which
properties you can specify.
Valid Values:
LBS - The program runs simulations on the
local host.
January 2007
223
Product Version 6.1

Command - You send a command to the

distributed processing software.
Remote-Host - The program runs
simulations on the remote host that you
specify.
Local - The program runs simulations on
the local host.
jobhostname t_remoteHostName
( LBS and Remote-Host only ) Name of the
remote host on which to start the job.
jobqueue t_queueName
( LBS only ) Name of the LBS/LSF queue.
jobresourcerequirements t_LSFresources
( LBS only ) Additional job resource
requirements for LSF.
jobsubmitcommand t_command
( Command only ) Job submit command. See
"Specifying a Job Submit Command" in the
information.
maxjobs "x_maxJobs"
Maximum number of jobs that can be
present in the system at a time.
runtimeout "x_runTimeout"
it has run the job. The wait time starts as
soon as ADE XL sends the run command for
the job. See "Specifying Job Timeouts" in the
information.
January 2007
224
Product Version 6.1

starttimeout "x_startTimeout"
Integer number of seconds of time to wait for
the icrp process to report back to ADE XL
that it has started the job. The wait time
starts as soon as ADE XL submits the job.
See "Specifying Job Timeouts" in the
information.
Value Returned
t
Successful addition and attachment of the job policy.
nil
Unsuccessful addition and attachment of the job policy.
Example
axlAttachJobPolicy( "mypol1"
'( nil distributionmethod "LBS"
configuretimeout "300"
maxjobs "5" name "default"
runtimeout "3600"
starttimeout "300" ) )
t
January 2007
225
Product Version 6.1

axlDeleteJobPolicy
axlDeleteJobPolicy(
t_jobPolicyName
)
=> t / nil
Description
Deletes the named job policy from the setup.
Arguments
t_jobPolicyName
Job policy name.
Value Returned
t
Successful deletion of the named job policy.
nil
Unsuccessful deletion of the named job policy.
Example
axlDeleteJobPolicy( "mypol1" )
t
January 2007
226
Product Version 6.1

axlGetAttachedJobPolicy
axlGetAttachedJobPolicy(
)
=> l_jobPolicyProperties / nil
Description
Returns the current job policy attached to the setup.
Arguments
None.
Value Returned
Disembodied property list ( DPL ) of properties of the current
attached job policies.
nil
Example
axlGetAttachedJobPolicy( )
'( nil configuretimeout "300" distributionmethod "Local" maxjobs "1" runtimeout
"3600" starttimeout "300" )
January 2007
227
Product Version 6.1

axlGetJobPolicy
axlGetJobPolicy(
t_jobPolicyName
)
=> l_jobPolicyProperties / nil
Description
Returns a disembodied property list containing property-value pairs for the job policy.
Arguments
t_jobPolicyName
Job policy name.
Value Returned
nil
Named job policy not found.
Example
axlGetJobPolicy( "default" )
'( nil configuretimeout "300" distributionmethod "Local" maxjobs "1" runtimeout
"3600" starttimeout "300" )
axlGetJobPolicy( "default1" )
nil
January 2007
228
Product Version 6.1

axlGetJobPolicyTypes
axlGetJobPolicyTypes(
)
=> l_jobPolicyNames / nil
Description
Returns a list containing names of all available job policies.
Arguments
None.
Value Returned
l_jobPolicyNames
List containing names of all job policies in the setup.
nil
No job policy is available.
Example
axlGetJobPolicyTypes( )
'( "mypolicy" "default" )
axlGetJobPolicyTypes( )
nil
January 2007
229
Product Version 6.1

axlIsICRPProcess
axlIsICRPProcess(
)
=> t / nil
Description
Returns t if the code is currently running in a remote child process for ADE XL. You can use
this function in your .cdsinit file or in custom SKILL code.
Arguments
None.
Value Returned
t
Child IC remote process is running.
nil
Child IC remote process is not running.
Example
axlIsICRPProcess( )
t
January 2007
230
Product Version 6.1

axlSetJobPolicyProperty
axlSetJobPolicyProperty(
t_jobPolicyName
t_jobPropertyName
t_jobPropertyValue
)
=> t / nil
Description
Adds a property name/value pair to the job policy.
Arguments
t_jobPolicyName
Job policy name.
t_jobPropertyName Job policy property.

t_jobPropertyValue
Job policy property value.
Value Returned
t
nil
Example
axlSetJobPolicyProperty( "mypolicy" "configuretimeout" "500" )
t
January 2007
231
Product Version 6.1

axlStopAllJobs
axlStopAllJobs(
)
=> t / nil
Description
Stops all the jobs present in the system.
Arguments
None.
Value Returned
t
nil
Example
axlStopAllJobs( )
t
January 2007
232
Product Version 6.1

axlStopJob
axlStopJob(
x_jobId
)
=> t / nil
Description
Stops a job.
Arguments
x_jobId
Job ID.
Value Returned
t
nil
Example
axlStopJob( 1 )
t
January 2007
233
Product Version 6.1

January 2007
234
Product Version 6.1
11
Design Characterization and Modeling
SKILL Functions
Note: Design characterization and modeling (DCM) is a feature of ADE GXL.
DCM SKILL Functions
Function
Description
dcmAppendToFile
Appends t_msg to file t_fileName.
dcmCreateLibertyKFactor Appends t_outFname with Liberty K factor from

t_resNames in t_resDB using name t_kName using units
of n_units.
dcmCreateLibertyOperatingConditions
Creates Liberty operating conditions file.
dcmCreateLibertyTables
Creates look-up tables of breakpoints (sweep values for each

parameter) in t_templateFname and table values (one
value for each combination of breakpoints) in t_incFname.
The breakpoints table title is t_templateTitle and the
template name is t_templateName. The program reads
results from the t_resDB results database file.
dcmCreateResultTable
Creates Verilog-A[MS] look-up table file using the specified

result from the named results database.
dcmDone
Finishes DCM run session.
January 2007
235
Product Version 6.1

Design Characterization and Modeling SKILL Functions
DCM SKILL Functions, continued
Function
Description
dcmExportToComposerams
dcmExportToComposerspectre
dcmExportToComposerultrasim
dcmExportToComposerverilog
Copies model file t_modelFile to the specified lib/cell/view,
creating the lib/cell/view if it does not already exist. You can
specify zero or more .vat look-up table files to copy with the
model file. The program verifies the syntax of the model file
before exporting it.
dcmGetFileContents
Returns the contents of the specified file, or the empty string if

the file does not exist or cannot be opened.
dcmGetResult
Returns a list of values from result t_resName in the

t_resDB results database file.
dcmInit
Starts DCM run session.
dcmMeasDelay
Measures delay from t_signal1 at threshold n_trigger1

and edge number x_edge1 of direction t_direction1 (
rising or falling or either ) to t_signal2 at threshold
n_trigger2 and edge number x_edge2 of direction
t_direction2 .
dcmMeasLkgpwr
Measures leakage power from current n_pwr and voltage

n_vdd at end of stimulus interval cycle of time n_interval.
dcmMeasNocpwr
Reports cell energy dissipated as a result of a change in input

signal t_sig in a specified direction t_dir from current
n_pwr and voltage n_vdd at end of stimulus interval cycle of
time n_interval and only when no output changes in the
interval. When the specified direction is either, the function
looks for at least one positive and one negative transition with
no output change. When more than one interval meets the
requirements, the function reports the average cell energy
dissipated.
January 2007
236
Product Version 6.1

DCM SKILL Functions, continued
Function
Description
dcmMeasTim
Measures timing from o_sig1 in the t_sig1_dir direction

to o_sig2 in the t_sig2_dir direction; n_interval is
the stimulus cycle ( where and when the function looks for input
changes ); the output low ( n_outl ) and output high (
n_outh ) voltages determine the range for the slope
measurement. Slope measurements begin at n_thr1% of full
swing and end at n_thr2%. If the output low and output high
voltages are both zero, the thresholds are calculated as min+(
max-min )*0.5 for the input and output signals, where min
and max are the voltages on the signals at the end of each
stimulus cycle ( just before the next input is applied ). The
measured slope spans the delay threshold without going into
the nonlinear region.
dcmMeasTimpwr
Reports timing and power consumption characteristics of the

design under test. Optionally writes one or all measured result
variables to the results file.
dcmMeasVCO
Reports characteristics of a VCO: last period, pulse width, rise

time, fall time, high level, low level, and start time of last period.
dcmReadMeas
Reads Verilog-A files containing measured results ( *.meas ) in

your local run directory and saves values to the results
database.
dcmSetAllTestsLibCellView
Overrides library, cell, and view with t_lib, t_cell, and
t_view for all tests in session t_session with setup
database i_db.
dcmStartGUI
Starts the Virtuoso Design Characterization and Modeling

environment.
dcmStartOpenDCMGUI
Starts the OpenDCM development environment.
dcmWriteToFile
Writes t_msg to file t_fileName.
January 2007
237
Product Version 6.1

dcmAppendToFile
dcmAppendToFile(
t_fileName
t_msg
)
=> t / nil
Description
Appends t_msg to file t_fileName.
Arguments
t_fileName
File name, optionally including relative ( to starting directory ) or

absolute path.
t_msg
Message text to append.
Value Returned
t
Successful append operation.
nil
Unsuccessful append operation.
Example
dcmAppendToFile( "dcm/data/Verilog_A.log" sprintf( nil "status_characterize_end
%L" stringToTime( getCurrentTime( ) ) ) )
January 2007
238
Product Version 6.1

dcmCreateLibertyKFactor
dcmCreateLibertyKFactor(
t_outFname
t_resDB
n_units
t_kName
t_resNames
)
=> t / nil
Description
Appends t_outFname with Liberty K factor from t_resNames in t_resDB using name
t_kName using units of n_units.
Arguments
t_outFname
Output file name, optionally including relative ( to starting

directory ) or absolute path.
t_resDB
Results database name.
n_units
Units.
t_kName
Name of K factor written to output file.
l_resNames
List of results from the results database to be used to determine

the K factor.
Value Returned
t
nil
Example
dcmCreateLibertyKFactor( strcat( modelDir,"dffr.scf" )
"dffr_Liberty_Timing_temperature_characterize.rdb" 1e-9 "k_temp_rise_transition"
list( "CLK_Q_rising:slope" "R_QB_rising:slope" "CLK_QB_rising:slope" ) )
January 2007
239
Product Version 6.1

dcmCreateLibertyOperatingConditions
dcmCreateLibertyOperatingConditions(
t_outFname
t_typName
t_typProc
t_typTemp
t_typVolt
t_typTree
t_minName
t_minProc
t_minTemp
t_minVolt
t_minTree
t_maxName
t_maxProc
t_maxTemp
t_maxVolt
t_maxTree
)
=> t / nil
Description
Creates Liberty operating conditions file.
Arguments
t_outFname
Output file name, optionally including relative ( to starting

directory ) or absolute path.
t_typName
Name of typical condition.
t_typProc
Process string that the program converts to a number and uses

as a multiplier (or scaling factor) for delay calculations.
Valid Values: Any floating point number from 0 through 100
specified as a string (that is, in quotation marks):
"1.0" or the empty string ("") for typical, less than "1.0" for
minimum, and greater than "1.0" for maximum.
Note: When t_typProc is "", the program does not write a
process multiplier to this section of the operating conditions.
t_typTemp
Temperature, in degrees C, for typical condition.
t_typVolt
Voltage, in Volts, for typical condition.
January 2007
240
Product Version 6.1

t_typTree
Liberty tree name for the typical condition.
t_minName
Name of minimum condition.
t_minProc

Note: When t_minProc is "", the program does not write a
t_minTemp
Temperature, in degrees C, for minimum condition.
t_minVolt
Voltage, in Volts, for minimum condition.
t_minTree
Liberty tree name for the minimum condition.
t_maxName
Name of maximum condition.
t_maxProc

Note: When t_maxProc is "", the program does not write a
t_maxTemp
Temperature, in degrees C, for maximum condition.
t_maxVolt
Voltage, in Volts, for maximum condition.
t_maxTree
Liberty tree name for the maximum condition.
Value Returned
t
nil
January 2007
241
Product Version 6.1

Example
dcmCreateLibertyOperatingConditions( strcat( modelDir "dffr.opc" )
"TYPICAL" "" "27"
"3"
"balanced_tree"
"BEST"
"" "0"
"90%" "best_case_tree"
"WORST"
"" "100" "90%" "worst_case_tree"
)
t
January 2007
242
Product Version 6.1

dcmCreateLibertyTables
dcmCreateLibertyTables(
t_templateFname
t_incFname
t_templateTitle
t_templateName
t_resDB
t_type
t_name
t_text
n_value
...
)
=> t / nil
Description
Creates look-up tables of breakpoints (sweep values for each parameter) in
t_templateFname and table values (one value for each combination of breakpoints) in
t_incFname. The breakpoints table title is t_templateTitle and the template name
is t_templateName. The program reads results from the t_resDB results database file.
Arguments
t_templateFname
Name of template file to contain breakpoints.
t_incFname
Name of include file to contain table values.
t_templateTitle
Breakpoints table title.
t_templateName
Template name.
t_resDB
t_type
Data type.
Valid Values:
res
Measured result
var
Parameter
t_name
Name of the result in the results database.
t_text
Name to use in the table/template.
n_units
Units used to scale result values.
January 2007
243
Product Version 6.1

Value Returned
t
nil
Example
dcmCreateLibertyTables( strcat( modelDir "dffr.ltt" )
strcat( modelDir "dffr_R_Q.inc" )
"lu_table_template" "dffr_template"
"dffr_Liberty_Timing_table_characterize.rdb"
"var" "dcm_slope" "input_net_transition" 1e-9
"res" "R_Q_falling:delay" "cell_fall" 1e-9
"res" "R_Q_falling:slope" "fall_transition" 1e-9
)
The function call above generates the following lines of code:

library(dffr_lib) {
lu_table_template(dffr_template) {
variable_1 : input_net_transition;
index_1("0.1,0.2")
}
cell(dffr) {
pin(Q) {
timing () {
fall_transition(dffr_template) {
values ("0.345255, 0.345251");
}
cell_fall(dffr_template) {
values ("0.366352, 0.379987");
}
}
}
}
January 2007
244
Product Version 6.1

dcmCreateResultTable
dcmCreateResultTable(
t_tableFilename
t_resDB
t_resName
)
=> t / nil
Description
Creates Verilog-A[MS] look-up table file using the specified result from the named results
database.
Arguments
t_tableFilename
Name of look-up table file.
t_resDB
t_resName
Result name.
Value Returned
t
nil
Example
dcmCreateResultTable( strcat( modelDir "dffr_R_Q_falling_t2.vat" )
"dffr_Verilog_A_Timing_characterize.rdb" "R_Q_falling:t2" )
t
January 2007
245
Product Version 6.1

dcmDone
dcmDone(
)
=> t / nil
Description
Finishes DCM run session.
Arguments
None.
Value Returned
t
nil
Example
dcmDone( )
t
January 2007
246
Product Version 6.1

dcmExportToComposerams
dcmExportToComposerams(
t_lib
t_cell
t_view
t_modelFile
[t_VATFile ...]
)
=> t / nil
Description
Copies model file t_modelFile to the specified lib/cell/view, creating the lib/cell/view if it
does not already exist. You can specify zero or more .vat look-up table files to copy with the
model file. The program verifies the syntax of the model file before exporting it.
Arguments
t_lib
Library name.
t_cell
Cell name.
t_view
View name.
t_modelFile
Name of model file to export.
[t_VATFile]
( Optional ) Zero or more look-up table files ( .vat ) to copy to

the lib/cell/view with the model file.
Value Returned
t
nil
Example
dcmExportToComposerams( "acvC25Lib" "dffr" "veriloga" "dcm/dffr/dcmGen/dffr.va"
"dcm/dffr/dcmGen/dffr_R_Q_falling_t1.vat" )
t
January 2007
247
Product Version 6.1

dcmExportToComposerspectre
dcmExportToComposerspectre(
t_lib
t_cell
t_view
t_modelFile
[t_VATFile ...]
)
=> t / nil
Description
Arguments
t_lib
Library name.
t_cell
Cell name.
t_view
View name.
t_modelFile
[t_VATFile]

Value Returned
t
nil
Example
dcmExportToComposerspectre( "acvC25Lib" "dffr" "veriloga"
"dcm/dffr/dcmGen/dffr.va" "dcm/dffr/dcmGen/dffr_R_Q_falling_t1.vat" )
t
January 2007
248
Product Version 6.1

dcmExportToComposerultrasim
dcmExportToComposerultrasim(
t_lib
t_cell
t_view
t_modelFile
[t_VATFile ...]
)
=> t / nil
Description
Arguments
t_lib
Library name.
t_cell
Cell name.
t_view
View name.
t_modelFile
[t_VATFile]

Value Returned
t
nil
Example
dcmExportToComposerultrasim( "acvC25Lib" "dffr" "veriloga"
"dcm/dffr/dcmGen/dffr.va" "dcm/dffr/dcmGen/dffr_R_Q_falling_t1.vat" )
t
January 2007
249
Product Version 6.1

dcmExportToComposerverilog
dcmExportToComposerverilog(
t_lib
t_cell
t_view
t_modelFile
)
=> t / nil
Description
does not already exist. The program verifies the syntax of the model file before exporting it.
Arguments
t_lib
Library name.
t_cell
Cell name.
t_view
View name.
t_modelFile
Value Returned
t
nil
Example
dcmExportToComposerverilog( "acvC25Lib" "dffr" "verilog" "dcm/dffr/dcmGen/dffr.v )
t
January 2007
250
Product Version 6.1

dcmGetFileContents
dcmGetFileContents(
t_fileName
)
=> t_fileContents / nil
Description
Returns the contents of the specified file, or the empty string if the file does not exist or cannot
be opened.
Arguments
t_fileName
Name of file.
Value Returned
t_fileContents
Contents of the specified file.
empty string
File does not exist or cannot be opened.
Example
errInfo = dcmGetFileContents( "error.log" )
January 2007
251
Product Version 6.1

dcmGetResult
dcmGetResult(
t_resDB
t_resName
)
=> l_results / nil
Description
Returns a list of values from result t_resName in the t_resDB results database file.
Arguments
t_resDB
t_resName
Result name.
Value Returned
l_results
List of result values.
nil
Example
CLK_QB_falling_delay=dcmGetResult( "dffr_Verilog_D_Timing_characterize.rdb"
"CLK_QB_falling:delay" )
CLK_QB_falling_delay=(1.25e-9 1.37e-9 1.56e-9)
January 2007
252
Product Version 6.1

dcmInit
dcmInit(
)
=> t / nil
Description
Starts DCM run session.
Arguments
None.
Value Returned
t
nil
Example
dcmInit( )
t
January 2007
253
Product Version 6.1

dcmMeasDelay
dcmMeasDelay(
o_signal1
n_trigger1
x_edge1
t_direction1
o_signal2
n_trigger2
x_edge2
t_direction2
@rest args
)
=> n_delay / nil
Description
Measures delay from t_signal1 at threshold n_trigger1 and edge number x_edge1
of direction t_direction1 ( rising or falling or either ) to t_signal2 at threshold
n_trigger2 and edge number x_edge2 of direction t_direction2 .
Arguments
o_signal1
Reference signal.
n_trigger1
Threshold of reference signal.
x_edge1
Edge number from which to measure the delay.
t_direction1
Direction of edge.
Valid Values:
rising
Rising edge.
falling
Falling edge.
either
Either rising or falling edge.
o_signal2
Second signal for delay measurement.
n_trigger2
Threshold of second signal.
x_edge2
Edge number of second signal.
t_direction2
Direction of edge.
Valid Values:
rising
January 2007
Rising edge.
254
Product Version 6.1

falling
Falling edge.
either
( Optional ) @rest args are as follows:

n=t_name
Write the specified result to the results file using this label.
errdflt=t_errorFag ( Optional ) Error flag.

Valid Values: Any number or string such as fail, 1.6e9, or 0.
Default Value: error
Value Returned
n_delay
Measured delay value.
nil
Example
dcmMeasDelay( clip( VT( "out" ),dcm_osc_domain,VAR( "dcm_interval" ) ) ( ( VAR(
"dcm_global_vdda_value" )-0 )/2.0 ) 1 "rising" clip( VT( "global_gndd"
),dcm_osc_domain,VAR( "dcm_interval" ) ) ( ( VAR( "dcm_global_vdda_value" )-0 )/2.0
) 1 "rising" "n=delay_global_gndd" "errdflt=0" )
2.3e-9
January 2007
255
Product Version 6.1

dcmMeasLkgpwr
dcmMeasLkgpwr(
n_pwr
n_vdd
n_interval
@rest args
)
=> n_lkgpwr / nil
Description
Measures leakage power from current n_pwr and voltage n_vdd at end of stimulus interval
cycle of time n_interval.
Arguments
n_pwr
Current value, in Amps.
n_vdd
Voltage value, in Volts.
n_interval
Stimulus interval, in seconds.

n=t_name

Value Returned
n_lkgpwr
Leakage power.
nil
Example
dcmMeasLkgpwr( IT( "global_vddd_source:p" ) VT( "/vddd!" ) VAR( "dcm_interval" )
"n=lkgpwr" )
January 2007
256
Product Version 6.1

dcmMeasNocpwr
dcmMeasNocpwr(
o_sig
t_dir
n_pwr
n_vdd
n_interval
o_out...
@rest args
)
=> n_nocpwr / nil
Description
Reports cell energy dissipated as a result of a change in input signal t_sig in a specified
direction t_dir from current n_pwr and voltage n_vdd at end of stimulus interval cycle of
time n_interval and only when no output changes in the interval. When the specified
direction is either, the function looks for at least one positive and one negative transition
with no output change. When more than one interval meets the requirements, the function
reports the average cell energy dissipated.
Arguments
o_sig
Input signal.
t_dir
Signal direction.
Valid Values:
rising
Rising edge.
falling
Falling edge.
either
n_pwr
Current from the supply, in Amps.
n_vdd
Supply voltage, in Volts.
n_interval
Stimulus interval, in seconds.
o_out
One or more output signals.

n=t_name
January 2007
257
Product Version 6.1

Value Returned
n_nocpwr
Cell energy dissipated, in Joules.
nil
Example
dcmMeasNocpwr( VT( "/CLK" ) "rising" IT( "global_vddd_source:p" ) VT( "/vddd!" )
VAR( "dcm_interval" ) VT( "Q" ) VT( "QB" ) "n=CLK_nocpwr_rising" )
January 2007
258
Product Version 6.1

dcmMeasTim
dcmMeasTim(
o_sig1
t_sig1_dir
o_sig2
t_sig2_dir
n_interval
n_outl
n_outh
n_thr1
n_thr2
@rest args
)
=> n_delay / nil
Description
Measures timing from o_sig1 in the t_sig1_dir direction to o_sig2 in the
t_sig2_dir direction; n_interval is the stimulus cycle ( where and when the function
looks for input changes ); the output low ( n_outl ) and output high ( n_outh ) voltages
determine the range for the slope measurement. Slope measurements begin at n_thr1%
of full swing and end at n_thr2%. If the output low and output high voltages are both zero,
the thresholds are calculated as min+( max-min )*0.5 for the input and output signals,
where min and max are the voltages on the signals at the end of each stimulus cycle ( just
before the next input is applied ). The measured slope spans the delay threshold without
going into the nonlinear region.
Arguments
o_sig1
Start measure signal.
t_sig1_dir
Start signal event direction.

Valid Values:
rising
Rising direction.
falling
Falling direction.
either
Either rising or falling direction.
o_sig2
End measure signal.
t_sig2_dir
End signal event direction.

Valid Values:
January 2007
259
Product Version 6.1

rising
Rising direction.
falling
Falling direction.
either
n_interval
Time interval between stimulus changes ( for example,

$dcm_interval ).
n_outl
Output low voltage.
n_outh
Output high voltage.
n_thr1
Threshold percentage ( of full swing ) for the start of the slope

measurement.
n_thr2
Threshold percentage ( of full swing ) for the end of the slope

measurement.

n=t_name
t_result
( Optional ) Returned result specifier ( requires that you specify

n=t_name ).
Valid Values:
delay
Measured delay.
slope
Slope found with delay.
t1
Delay from input change to thr1.
t2
domain
Time at the input edge.
end_val
Final voltage when output state has settled.
all
Writes all of the above values to the results

le.
Default Value: all

January 2007
260
Product Version 6.1

Value Returned
n_delay
Measured delay unless you specified a particular t_result (

other than all ).
nil
Examples
dcmMeasTim( VT( "/DT" )-VT( "/DTB" ) "rising" VT( "/QT" )-VT( "/QTB" ) "rising"
$dcm_interval 0 0 49 80 "n=DT_QT_rise" )
timeDelay = dcmMeasTim( VT( "/DT" )-VT( "/DTB" ) "rising" VT( "/QT" )-VT( "/QTB" )
"rising" $dcm_interval 0 0 49 80 "n=DT_QT_rise" )
timeSlope = dcmMeasTim( VT( "/DT" )-VT( "/DTB" ) "rising" VT( "/QT" )-VT( "/QTB" )
"rising" $dcm_interval 0 0 49 80 "n=DT_QT_rise" "slope" )
timeDomain = dcmMeasTim( VT( "/DT" )-VT( "/DTB" ) "rising" VT( "/QT" )-VT( "/QTB"
) "rising" $dcm_interval 0 0 49 80 "n=DT_QT_rise" "domain" "errdflt=0" )
January 2007
261
Product Version 6.1

dcmMeasTimpwr
dcmMeasTimpwr(
o_sig1
t_sig1_dir
o_sig2
t_sig2_dir
n_pwr
n_vdd
n_load_cap
n_interval
n_outl n_outh
n_thr1 n_thr2
@rest args
)
=> n_swipwr / nil
Description
Reports timing and power consumption characteristics of the design under test. Optionally
writes one or all measured result variables to the results file.
Note: Timing results reported by this measure might differ from those reported by
dcmMeasTim because one of the underlying measures looks for a simulation interval that
does not exhibit an initial high-current state and all measurements are taken in subsequent
intervals.
Arguments
o_sig1
Start measure signal.
t_sig1_dir
Start signal event direction.

Valid Values:
rising
Rising direction.
falling
Falling direction.
either
o_sig2
End measure signal.
t_sig2_dir
End signal event direction.

Valid Values:
rising
January 2007
Rising direction.
262
Product Version 6.1

falling
Falling direction.
either
n_pwr
Current from the supply, in Amps.
n_vdd
Supply voltage, in Volts.
n_load_cap
Output load capacitance on measure output pin.

Note: This value is used to subtract output current taken by the
load capacitance.
n_interval
Time interval between stimulus changes ( for example,

$dcm_interval ).
n_outl
Output low voltage.
n_outh
Output high voltage.
n_thr1
Threshold percentage ( of full swing ) for the start of the slope

measurement.
n_thr2
Threshold percentage ( of full swing ) for the end of the slope

measurement.

n=t_name
t_result
( Optional ) Returned result specifier ( requires that you specify

n=t_name ).
Valid Values:
delay
Measured delay.
slope
Slope found with delay.
t1
t2
domain
Time at the input edge.
end_val
Final voltage when output state has settled.
all
Writes all of the above values to the results

le.
Default Value: all
January 2007
263
Product Version 6.1


Value Returned
n_swipwr
Output switching power value ( the power dissipated when an

output changes/switches ).
nil
Examples
dcmMeasTimpwr( VT( "a" ) "rising" VT( "y" ) "rising" IT( "vdd_source:p" ) VT( "vdd"
) $dcm_load_cap $dcm_interval 0 $dcm_vdd_value 20 80 "n=a_y_rise" )
timpwrSwi = dcmMeasTimpwr( VT( "a" ) "rising" VT( "y" ) "rising" IT( "vdd_source:p"
) VT( "vdd" ) $dcm_load_cap $dcm_interval 0 $dcm_vdd_value 20 80 "n=a_y_rise"
"swipwr" )
timpwrDelay = dcmMeasTimpwr( VT( "a" ) "rising" VT( "y" ) "rising" IT(
"vdd_source:p" ) VT( "vdd" ) $dcm_load_cap $dcm_interval 0 $dcm_vdd_value 20 80
"n=a_y_rise" "delay" )
timpwrDomain = dcmMeasTimpwr( VT( "a" ) "rising" VT( "y" ) "rising" IT(
"vdd_source:p" ) VT( "vdd" ) $dcm_load_cap $dcm_interval 0 $dcm_vdd_value 20 80
"n=a_y_rise" "domain" "errdflt=fail" )
January 2007
264
Product Version 6.1

dcmMeasVCO
dcmMeasVCO(
o_signal
t_direction
n_swing
@rest args
)
=> n_measure / nil
Description
Reports characteristics of a VCO: last period, pulse width, rise time, fall time, high level, low
level, and start time of last period.
Arguments
o_signal
VCO output signal.
t_direction
Direction of starting edge of last period.

Valid Values:
n_swing
rising
Rising direction.
falling
Falling direction.
either
Minimum acceptable signal swing.

n=t_name
t_outputVariable
Write the specified characteristic to the output file.

If you do not specify a t_outputVariable, the program
writes all values to the output file.
Valid Values:
January 2007
period
Period.
width
Width.
rise
Rise time.
fall
Fall time.
265
Product Version 6.1

high
Output high level.
low
Output low level.
domain
Time at which the program encounters the

first measured oscillation

Value Returned
n_measure
Measured value for t_outputVariable, if specified and

valid; otherwise the domain.
nil
Example
dcm_osc_domain=dcmMeasVCO( clip( VT( "out" ),VAR( "dcm_interval" )*0.2,VAR(
"dcm_interval" ) ) "rising" ( ( VAR( "dcm_global_vdda_value" )-0 )/2.0 )
"errdflt=0" "n=my_vco_comp" "dom=dom-period-rise/2.0" )
January 2007
266
Product Version 6.1

dcmReadMeas
dcmReadMeas(
@rest args
)
=> t / nil
Description
Reads Verilog-A files containing measured results ( *.meas ) in your local run directory and
saves values to the results database.
Note: Verilog-A modules must save results to a .meas file. The format of a .meas file is
name = value\n
Arguments
n=t_name
Write values to the results database using this label instead of

the name from the .meas file.
Value Returned
t
nil
Example
dcmReadMeas( "dead_time" )
t
January 2007
267
Product Version 6.1

dcmSetAllTestsLibCellView
dcmSetAllTestsLibCellView(
t_session
x_database
t_lib
t_cell
t_view
)
=> t / nil
Description
Overrides library, cell, and view with t_lib, t_cell, and t_view for all tests in session
t_session with setup database i_db.
Arguments
t_session
Session name.
x_database
Database handle.
t_lib
Overriding library name. If blank (""), do not override.
t_cell
Overriding cell name. If blank (""), do not override.
t_view
Overriding view name.
Value Returned
t
nil
Example
dcmSetAllTestsLibCellView( dffr_session dffr_sdb "" "" "configva" )
t
January 2007
268
Product Version 6.1

dcmStartGUI
dcmStartGUI(
[t_cmd]
)
=> t / nil
Description
Starts the Virtuoso Design Characterization and Modeling environment.
Arguments
t_cmd
( Optional ) Start command.

Valid Values:
LAST
Loads last saved data.
RUN
Loads last saved data and runs simulations.
GEN
Loads last saved data and runs generate.
TD
Starts in top-down modeling mode.
DV
Starts in design verification mode.
BU
Starts in bottom-up modeling mode.
Value Returned
t
nil
Example
dcmStartGUI( "TD" )
t
January 2007
269
Product Version 6.1

dcmStartOpenDCMGUI
dcmStartOpenDCMGUI(
)
=> t / nil
Description
Starts the OpenDCM development environment.
Arguments
None.
Value Returned
t
nil
Example
dcmStartOpenDCMGUI( )
t
January 2007
270
Product Version 6.1

dcmWriteToFile
dcmWriteToFile(
t_fileName
t_msg
)
=> t / nil
Description
Writes t_msg to file t_fileName.
Arguments
t_fileName
File name.
t_msg
Text string.
Value Returned
t
nil
Example
dcmWriteToFile( "logFile.txt","Finished running" )
t
January 2007
271
Product Version 6.1

January 2007
272
Product Version 6.1
Index
Symbols
axlGetJobPolicyTypes 229
axlGetLocations 49
axlGetMainSetupDB 21
axlGetModel 95
axlGetModelBlock 96
axlGetModelFile 97
axlGetModelGroup 98
axlGetModelGroupName 99
axlGetModelGroups 100
axlGetModels 103
axlGetModelSection 101
axlGetModelTest 102
axlGetNominalCornerEnabled 162
axlGetOrigTestToolArgs 117
axlGetParameter 50
axlGetParameterName 51
axlGetParameters 52
axlGetParameterValue 53
axlGetPercentComplete 172
axlGetResultsLocation 54
axlGetRunData 173
axlGetRunMode 174
axlGetRunModes 175
axlGetRunOption 176
axlGetRunOptionName 179
axlGetRunOptions 180
axlGetRunOptionValue 181
axlGetScript 56
axlGetScriptPath 57
axlGetScripts 58
axlGetSessionHasGui 22
axlGetSetupDB 59
axlGetSetupDBBaseName 60
axlGetSetupDBDir 61
axlGetSpec 134
axlGetSpecs 135
axlGetSpecWeight 136
axlGetSyncFlag 23
axlGetTest 118
axlGetTestName 119
axlGetTestOceanScripts 120
axlGetTests 121
axlGetTestToolArgs 122
axlGetTestToolName 124
axlGetTopLevel 62
axlGetVar 63
, . . . in syntax 12
. . . in syntax 12
[ ] in syntax 11
A
axlAddJobPolicy 220
axlAddOutputs 112
axlAttachJobPolicy 223
axlCloseSession 17
axlCloseSessionInWindow 18
axlCommitSetupDB 42
axlCommitSetupDBAndHistoryAs 43
axlCommitSetupDBas 44
axlCreateSession 19
axlDeleteJobPolicy 226
axlGetActiveSetup 45
axlGetAllActiveRuns 169
axlGetAllCornersEnabled 155
axlGetAllFinishedRuns 170
axlGetAllSweepsEnabled 171
axlGetAssociatedWindow 20
axlGetAttachedJobPolicy 227
axlGetCorner 156
axlGetCornerName 157
axlGetCorners 158
axlGetCurrentHistory 203
axlGetDefaultCornerEnabled 159
axlGetDescription 46
axlGetDisabledCorner 160
axlGetDisabledCorners 161
axlGetElementParent 47
axlGetEnabled 48
axlGetHistory 204
axlGetHistoryCheckpoint 205
axlGetHistoryEntry 206
axlGetHistoryGroup 207
axlGetHistoryMode 208
axlGetHistoryName 209
axlGetHistoryResults 210
axlGetHistoryResultsDir 211
axlGetHistoryTest 212
axlGetJobPolicy 228
January 2007
273
Product Version 6.1
axlGetVars 64
axlGetVarValue 65
axlInitialTestStateChanged 125
axlIsActiveRun 182
axlIsDirty 66
axlIsElement 67
axlIsICRPProcess 230
axlIsPausedRun 183
axlIsReadOnly 68
axlIsSetupDB 69
axlIsValidAXLSession 24
axlLoadHistory 213
axlNewSession 25
axlNewSetupDB 70
axlNewSpecComp 137
axlNoSession 26
axlOpenResDB 138
axlOutputResult 113
axlPauseRun 184
axlPutCorner 163
axlPutDisabledCorner 164
axlPutHistoryEntry 214
axlPutModel 104
axlPutModelGroup 105
axlPutParameter 71
axlPutRunOption 185
axlPutScript 72
axlPutSpec 139
axlPutTest 73
axlPutVar 74
axlRegisterCustomDeviceFilter 27
axlRemoveElement 75
axlResetActive 76
axlRun 188
axlRunAllTests 190
axlRunAllTestsWithCallback 191
axlRunWithCallback 193
axlSaveAs 77
axlSaveResValue 126
axlSaveSetup 78
axlSaveSetupToLib 79
axlSaveTestState 127
axlSetAssociatedWindow 28
axlSetCornerName 165
axlSetDefaultCornerEnabled 166
axlSetDefaultVariables 29
axlSetDescription 80
axlSetElementValue 81
axlSetEnabled 82
axlSetHistoryMode 215
axlSetHistoryResults 217
January 2007
axlSetHistoryTest 216
axlSetJobPolicyProperty 231
axlSetMainSetupDB 30
axlSetModelBlock 106
axlSetModelFile 107
axlSetModelGroupName 108
axlSetModelSection 109
axlSetModelTest 110
axlSetParameterName 84
axlSetParameterValue 85
axlSetRunCompleteCallback 195
axlSetRunOptionName 196
axlSetRunOptionValue 197
axlSetScriptPath 86
axlSetSetupDBName 87
axlSetSpecDescription 140
axlSetSpecMax 141
axlSetSpecMin 142
axlSetSpecName 143
axlSetSpecResultName 144
axlSetSpecTarget 145
axlSetSpecTestName 146
axlSetSpecTol 147
axlSetSpecTolType 148
axlSetSpecType 149
axlSetSpecWeight 151
axlSetSyncFlag 31
axlSetTestName 128
axlSetTestOceanScripts 129
axlSetTestToolArgs 130
axlSetTestToolName 132
axlSetVarValue 88
axlStopAll 32
axlStopAllJobs 232
axlStopJob 233
axlToolSetOriginalSetupOptions 33
axlToolSetSetupOptions 35
axlViewResDB 37
axlWriteDatasheet 89
B
brackets in syntax
11
C
conventions
user-defined arguments 11
user-entered text 11
274
Product Version 6.1
D
dcmAppendToFile 238
dcmCreateLibertyKFactor 239
dcmCreateLibertyOperatingConditions 24
0
dcmCreateLibertyTables 243
dcmCreateResultTable 245
dcmDone 246
dcmExportToComposerams 247
dcmExportToComposerspectre 248
dcmExportToComposerultrasim 249
dcmExportToComposerverilog 250
dcmGetFileContents 251
dcmGetResult 252
dcmInit 253
dcmMeasDelay 254
dcmMeasLkgpwr 256
dcmMeasNocpwr 257
dcmMeasTim 259
dcmMeasTimpwr 262
dcmMeasVCO 265
dcmReadMeas 267
dcmSetAllTestsLibCellView 268
dcmStartGUI 269
dcmStartOpenDCMGUI 270
dcmWriteToFile 271
I
italics in syntax
11
K
keywords
11
L
literal characters
11
S
SKILL functions, syntax conventions
January 2007
13
275
Product Version 6.1
January 2007
276
Product Version 6.1

Adex Ls Kill Ref 610

Enviado por

Dados do documento

Direitos autorais

Formatos disponíveis

Compartilhar este documento

Compartilhar ou incorporar documento

Opções de compartilhamento

Você considera este documento útil?

Este conteúdo é inapropriado?

Direitos autorais:

Formatos disponíveis

Adex Ls Kill Ref 610

Enviado por

Direitos autorais:

Formatos disponíveis

Virtuoso ADE XL SKILL Functions

1999-2007 Cadence Design Systems, Inc. All rights reserved.

Virtuoso ADE XL SKILL Functions Reference

Product Version 6.1

Virtuoso ADE XL SKILL Functions Reference

Product Version 6.1

Virtuoso ADE XL SKILL Functions Reference

Product Version 6.1

Virtuoso ADE XL SKILL Functions Reference

Product Version 6.1

Virtuoso ADE XL SKILL Functions Reference

Product Version 6.1

Virtuoso ADE XL SKILL Functions Reference

Product Version 6.1

Virtuoso ADE XL SKILL Functions Reference

Product Version 6.1

Virtuoso ADE XL SKILL Functions Reference

Product Version 6.1

Virtuoso ADE XL SKILL Functions Reference

Virtuoso ADE XL User Guide describes the ADE XL environment.

Virtuoso Design Environment SKILL Functions Reference provides detailed

SKILL Language User Guide introduces the SKILL language.

Typographic and Syntax Conventions

Nonitalic words indicate keywords that you must enter literally.

Brackets denote optional arguments.

Product Version 6.1

Virtuoso ADE XL SKILL Functions Reference

Specify at least one, but more are possible.

Specify zero or more.

A comma and three dots together indicate that if you specify

Product Version 6.1

Virtuoso ADE XL SKILL Functions Reference

SKILL Syntax Examples

Plain type indicates words that you must enter literally.

Words in italics indicate arguments for which you must substitute

Parentheses separate names of functions from their arguments.

An underscore separates an argument type ( left ) from an

Brackets indicate that the enclosed argument is optional.

Vertical bars separate a choice of required options.

Slashes separate possible return values.

Product Version 6.1

Virtuoso ADE XL SKILL Functions Reference

Product Version 6.1

Virtuoso ADE XL SKILL Functions Reference

Session-Related SKILL Functions

Closes the named ADE XL session.

Creates a new ADE XL session with the specified name.

Returns a handle to the working setup database of the named

Returns t if the named ADE XL session is a graphical one;

Gets the sync-flag status ( either true or false ) for an ADE XL

Returns t if the named ADE XL session is valid ( exists ); returns

Creates a new ADE XL session.

Returns t if there is no ADE XL session in the current window.

Product Version 6.1

Virtuoso ADE XL SKILL Functions Reference

Sets the working setup database on an ADE XL session. Returns

Sets the sync-flag status for an ADE XL session.

Stops all runs currently evaluating in the session.

Opens the results viewer window for post-processing.

Product Version 6.1

Virtuoso ADE XL SKILL Functions Reference

Name of session you want to close.

Successful close operation.

Unsuccessful close operation.