Adex Ls Kill Ref 610

8/17/2019 Adex Ls Kill Ref 610

1/276

Virtuoso ® ADE XL SKILL Functions

Reference

Product Version 6.1

January 2007


2/276

© 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 inthis document are attributed to Cadence with the appropriate symbol. For queries regarding Cadence’s

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 thispublication 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 copyof 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 bediscontinued 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 confidentialinformation of Cadence or its licensors, and is supplied subject to, and may be used only by Cadence’scustomer 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, anyrepresentations 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 partyrights, 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.


3/276

Virtuoso ADE XL SKILL Functions Reference

January 2007 3 Product Version 6.1

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Related Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Typographic and Syntax Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

1

Session-Related SKILL Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15axlCloseSession . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

axlCloseSessionInWindow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

axlCreateSession . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

axlGetAssociatedWindow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

axlGetMainSetupDB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

axlGetSessionHasGui . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

axlGetSyncFlag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

axlIsValidAXLSession . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

axlNewSession . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

axlNoSession . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

axlRegisterCustomDeviceFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

axlSetAssociatedWindow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

axlSetDefaultVariables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

axlSetMainSetupDB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

axlSetSyncFlag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

axlStopAll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

axlToolSetOriginalSetupOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

axlToolSetSetupOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

axlViewResDB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

2

Setup Database SKILL Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39axlCommitSetupDB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

axlCommitSetupDBAndHistoryAs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Contents


4/276



axlCommitSetupDBas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

axlGetActiveSetup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

axlGetDescription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

axlGetElementParent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47axlGetEnabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

axlGetLocations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

axlGetParameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

axlGetParameterName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

axlGetParameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

axlGetParameterValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

axlGetResultsLocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

axlGetScript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

axlGetScriptPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57axlGetScripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

axlGetSetupDB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

axlGetSetupDBBaseName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

axlGetSetupDBDir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

axlGetTopLevel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

axlGetVar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

axlGetVars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

axlGetVarValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

axlIsDirty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66axlIsElement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

axlIsReadOnly . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

axlIsSetupDB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

axlNewSetupDB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

axlPutParameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

axlPutScript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

axlPutTest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

axlPutVar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

axlRemoveElement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75axlResetActive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

axlSaveAs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

axlSaveSetup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

axlSaveSetupToLib . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

axlSetDescription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80


5/276



axlSetElementValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

axlSetEnabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

axlSetParameterName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

axlSetParameterValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85axlSetScriptPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

axlSetSetupDBName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

axlSetVarValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

axlWriteDatasheet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

axlWriteDatasheetForm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

3

Model-Related SKILL Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

axlGetModel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

axlGetModelBlock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

axlGetModelFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

axlGetModelGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

axlGetModelGroupName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

axlGetModelGroups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

axlGetModelSection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

axlGetModelTest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

axlGetModels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103axlPutModel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

axlPutModelGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

axlSetModelBlock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

axlSetModelFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

axlSetModelGroupName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

axlSetModelSection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

axlSetModelTest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

4SKILL Functions for Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111axlAddOutputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

axlOutputResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113


6/276



5

Test-Related SKILL Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

axlGetOrigTestToolArgs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117axlGetTest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118

axlGetTestName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

axlGetTestOceanScripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120

axlGetTests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

axlGetTestToolArgs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

axlGetTestToolName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124

axlInitialTestStateChanged . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125

axlSaveResValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

axlSaveTestState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127axlSetTestName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128

axlSetTestOceanScripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

axlSetTestToolArgs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

axlSetTestToolName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

6

Specification-Related SKILL Functions . . . . . . . . . . . . . . . . . . . . . . . 133axlGetSpec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134

axlGetSpecs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135

axlGetSpecWeight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136

axlNewSpecComp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137

axlOpenResDB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

axlPutSpec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

axlSetSpecDescription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140

axlSetSpecMax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

axlSetSpecMin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

axlSetSpecName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

axlSetSpecResultName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144

axlSetSpecTarget . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

axlSetSpecTestName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

axlSetSpecTol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

axlSetSpecTolType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148


7/276



axlSetSpecType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149

axlSetSpecWeight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

7Corners-Related SKILL Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153axlGetAllCornersEnabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

axlGetCorner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156

axlGetCornerName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157

axlGetCorners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

axlGetDefaultCornerEnabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159

axlGetDisabledCorner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160

axlGetDisabledCorners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161axlGetNominalCornerEnabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162

axlPutCorner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

axlPutDisabledCorner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164

axlSetCornerName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165

axlSetDefaultCornerEnabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

8

Run-Related SKILL Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167axlGetAllActiveRuns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169

axlGetAllFinishedRuns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170

axlGetAllSweepsEnabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171

axlGetPercentComplete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172

axlGetRunData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173

axlGetRunMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174

axlGetRunModes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175

axlGetRunOption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176

axlGetRunOptionName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

axlGetRunOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180

axlGetRunOptionValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181

axlIsActiveRun . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182

axlIsPausedRun . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183

axlPauseRun . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184

axlPutRunOption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185


8/276


9/276



axlSetJobPolicyProperty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231

axlStopAllJobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232

axlStopJob . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233

11

Design Characterization and Modeling

SKILL Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235dcmAppendToFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238

dcmCreateLibertyKFactor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239

dcmCreateLibertyOperatingConditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240

dcmCreateLibertyTables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243

dcmCreateResultTable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245dcmDone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246

dcmExportToComposerams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247

dcmExportToComposerspectre . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248

dcmExportToComposerultrasim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249

dcmExportToComposerverilog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250

dcmGetFileContents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251

dcmGetResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252

dcmInit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253

dcmMeasDelay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254dcmMeasLkgpwr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256

dcmMeasNocpwr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257

dcmMeasTim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259

dcmMeasTimpwr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262

dcmMeasVCO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265

dcmReadMeas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267

dcmSetAllTestsLibCellView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268

dcmStartGUI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269

dcmStartOpenDCMGUI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270dcmWriteToFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271

Index. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273


10/276




11/276



Preface

The files containing the SKILL functions provided for use with ADE XL and ADE GXL areinstalled in various subdirectories underyour_install_dir /tools/dfII/group/davinci/src. You can check theintroductory 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 detailedinformation about the SKILL functions that interface to applications in the VirtuosoDesign 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 ) oroption names.

argument ( z_argument )

Words in italics indicate user-defined arguments for which youmust substitute a name or a value. ( The characters before theunderscore ( _ ) in the word indicate the data types that thisargument can take. Names are case sensitive. Do not type theunderscore ( z_ ) before your arguments. )

[ ] Brackets denote optional arguments.

http://%24adexl.pdf/http://%24adegxl.pdf/http://%24adexl.pdf/http://%24adegxl.pdf/http://%24skdfref.pdf/http://%24sklanguser.pdf/http://%24adegxl.pdf/http://%24adexl.pdf/http://%24sklanguser.pdf/http://%24skdfref.pdf/http://%24adegxl.pdf/http://%24adexl.pdf/


12/276

Virtuoso ADE XL SKILL Functions ReferencePreface


… Three dots ( ... ) indicate that you can repeat the previousargument. If you use them with brackets, you can specify zero ormore 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 specifymore than oneargument, you must separate those argumentsbycommas.

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 nextline.


13/276



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 whichyou must substitutea name or a value.

( ) Parentheses separate names of functions from their arguments.

_ An underscore separates an argument type ( left ) from anargument name ( right ).

[ ] Brackets indicate that the enclosed argument is optional.

=> A right arrow points to the return values of the function. Also usedin code examples in SKILL manuals.

... Three dots indicate that the preceding item can appear anynumber 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.


14/276




15/276



1

Session-Related SKILL Functions

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 ADEXL 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 XLsession.

axlIsValidAXLSession Returns t if the named ADE XL session is valid ( exists ); returnsnil 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 theParameters, Sweeps, and Corners Setup assistant pane. Thestandard filters are Default, CDF, and CDF Editable.

http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-


16/276

Virtuoso ADE XL SKILL Functions ReferenceSession-Related SKILL Functions


axlSetAssociatedWindow

Sets the window associated with the named ADE XL session.

axlSetDefaultVariables

Creates a set of default variables (in the Global Variables treeon the Parameters, Sweeps, and Corners assistant pane) for anADE XL session.

axlSetMainSetupDB Sets the working setup database on an ADE XL session. Returnsa 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 instanceassociated with the specified session and test.

axlToolSetSetupOptions Sets the option values for the tool instance associated with thespecified session and test.

axlViewResDB Opens the results viewer window for post-processing.

Session-Related SKILL Functions, continued


http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-


17/276



axlCloseSession

axlCloseSession(

t_session)

=> t / nil

Description

Closes the named ADE XL session.

Argument

Value Returned

ExampleaxlCloseSession( "session0" )t

t_session Name of session you want to close.

t Successful close operation.

nil Unsuccessful close operation.


18/276



axlCloseSessionInWindow

axlCloseSessionInWindow(

)=> t / nil

Description

Closes the ade session in the current window if there is one.

Argument

None.

Value Returned

Example

axlCloseSessionInWindow( )t

t Successful operation.

nil Unsuccessful operation.


19/276



axlCreateSession

axlCreateSession(

t_session)

=> t_name / nil

Description

Creates a new ADE XL session with the specified name.

Argument

Value Returned

ExamplesaxlCreateSession ( "data_session" )data_session = ( axlCreateSession "data_session" )"session1"

t_session Session name you want to create.

t_name Session name.



20/276



axlGetAssociatedWindow

axlGetAssociatedWindow(

t_session)

=> x_window / nil

Description

Returns the schematic editor window associated with the ADE XL session, or nil if there isno window.

Arguments

Value Returned

Example

axlGetAssociatedWindow( "mySession" )4

t_session Session name.

x_window Handle to schematic editor window associated with this ADE XLsession.

nil No schematic editor window associated with this ADE XL

session.


21/276



axlGetMainSetupDB

axlGetMainSetupDB(

t_session)

=> x_database / nil

Description

Returns a handle to the working setup database of the named ADE XL session.

Argument

Value Returned

ExampleaxlGetMainSetupDB( "session0" )1001


x_database Setup database handle.



22/276



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

Value Returned

ExampleaxlGetSessionHasGui( "session0" )t

t_session Session name you want to query.

t Graphical ADE XL session.

nil Non-graphical ADE XL session.


23/276



axlGetSyncFlag

axlGetSyncFlag(

)=> t / nil

Description

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

Value Returned

Example

axlGetSyncFlag( )t

t Sync-flag status is true.nil Sync-flag status is false.


24/276



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

Value Returned

ExampleaxlIsValidAXLSession( "session0" )t


t Valid ADE XL session.

nil Not a valid ADE XL session.


25/276



axlNewSession

axlNewSession(

)=> t_session / nil

Description

Creates a new ADE XL session.

Value Returned

Example

axlNewSession( )"session1"

t_session Session name.nil Unsuccessful operation.


26/276



axlNoSession

axlNoSession(

)=> t / nil

Description

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

Argument

None.

Value Returned

Example

axlNoSession( )t

t There is no ADE XL session in the current window.

nil There is an ADE XL session in the current window.


27/276



axlRegisterCustomDeviceFilter

axlRegisterCustomDeviceFilter(

t_names_function

)

=> t / nil

Description

Adds a custom filter for device instance parameters on the Parameters,Sweeps, and CornersSetup assistant pane. The standard filters are Default , CDF , and CDF Editable .

Arguments

Value Returned

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.

t_name Device instance parameter filter name. This is the name thatappears 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 asarguments and returns a list of (property name, property value)lists.

t Successful registration.

nil Unsuccessful registration.

http://%24adexl.pdf/http://%24adexl.pdf/http://%24adexl.pdf/http://%24adexl.pdf/http://%24adexl.pdf/http://%24adexl.pdf/http://%24adexl.pdf/http://%24adexl.pdf/


28/276



axlSetAssociatedWindow

axlSetAssociatedWindow(

t_sessionx_window

)

=> t / nil

Description

Sets the window associated with the named ADE XL session.

Arguments

Value Returned

Example

axlSetAssociatedWindow "session0" 4t


x_window Schematic editing window.

t Successful set operation.

nil Unsuccessful set operation.


29/276



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

Value Returned

Example

axlSetDefaultVariables( '(_n_len 1u _sim_time 100n) "myDemoLib" )t

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 associatedwith any library.

When you open an ADE XL setup, the program loads the set ofdefault variables associated with the same library as the setup

(if it exists). After that, it loads the set of default variables notassociated with any library (if it exists).




30/276



axlSetMainSetupDB

axlSetMainSetupDB(

t_sessiont_setupdb

)

=> x_database / nil

Description

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

Arguments

Value Returned

Example

data_session = ( axlCreateSession "data_session" )data_sdb = axlSetMainSetupDB( "data_session" "data.sdb" )4001

Reference

axlCreateSession


t_setupdb Working setup database.




31/276



axlSetSyncFlag

axlSetSyncFlag(

g_flag )

=> t / nil

Description

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

Argument

Value Returned

Example

axlSetSyncFlag( t )t

g_flag Sync-flag statusValid Values:

t Sets the sync-flag status to true.

nil Sets the sync-flag status to false.




32/276



axlStopAll

axlStopAll(

t_session)

=> t / nil

Description

Stops all runs currently evaluating in the session.

Argument

Value Returned

ExampleaxlStopAll( "session0" )t

t_session ADE XL session name.




33/276



axlToolSetOriginalSetupOptions

axlToolSetOriginalSetupOptions(

t_sessiont_test

l_toolOptions

)

=> t / nil

Description

Sets options to their original values for the tool instance associated with the specified sessionand test.

Argument


t_test Test name.

l_toolOptions Associative list of original option names and values for the toolinstance.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.


34/276



Value Returned

Example

axlToolSetOriginalSetupOptions("session0""delayTest"axlGetOrigTestToolArgs( 1031 ) )t

ReferenceaxlGetOrigTestToolArgs, axlToolSetSetupOptions




35/276



axlToolSetSetupOptions

axlToolSetSetupOptions(

t_sessiont_test

l_toolOptions

)

=> t / nil

Description

Sets the option values for the tool instance associated with the specified session and test.

Argument

Value Returned


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.



36/276



Example

axlToolSetSetupOptions( "session0" "delayTest" axlGetTestToolArgs( 1031 ) )t

Reference

axlGetTestToolArgs, axlToolSetOriginalSetupOptions



37/276



axlViewResDB

axlViewResDB(

t_pathToResultsDB)

=> t / nil

Description

Opens the results viewer window for post-processing.

Argument

Value Returned

ExampleaxlViewResDB( "./my_results.rdb" )t

t_pathToResultsDB Path to results database.




38/276


39/276



2

Setup Database SKILL Functions

Setup Database SKILL Functions


axlCommitSetupDB Saves the setup database.

axlCommitSetupDBAndHistoryAs

Saves the setup database along with history entries under a newname.

axlCommitSetupDBas Saves the setup database under a new name.

axlGetActiveSetup Returns a handle to the active test setup in the specified setupdatabase.

axlGetDescription Returns a description of the setup database entry.

axlGetElementParent Returns a handle to the parent of the specified setup databaseelement.

axlGetEnabled Checks whether a setup database element is enabled or not.

axlGetLocations Returns a list containing a handle to all device instanceparameter locations for this database entry and a list of alllocation 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 instanceparameters for this database entry and a list of all deviceinstance parameter names.

axlGetParameterValue Gets the value of a device instance parameter.

axlGetResultsLocation Returns the results location for the specified setup database. Theprogram uses the adexl.results saveDir setting todetermine the results location.

http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-


40/276

Virtuoso ADE XL SKILL Functions ReferenceSetup Database SKILL Functions


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 databaseentry 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 adatabase 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 modifiedsince the last save operation.

axlIsElement Checks whether the handle ( passed as an argument ) is a validsetup database handle.

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

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

axlNewSetupDB Opens the named setup database and returns its handle. If thenamed setup database does not already exist, this functioncreates one and returns a handle to it.

axlPutParameter Inserts or finds a device instance parameter by name andlocation.

axlPutScript Inserts or finds a script by name, sets its path, and returns ahandle to that script.

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

Setup Database SKILL Functions, continued


http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-


41/276



axlPutVar Inserts or finds a global variable by name and sets its value.

axlRemoveElement Removes an element and all its children from the setupdatabase.

axlResetActive Resets the active setup database.

axlSaveAs The program calls this function when you choose File – SaveAs in your ADE XL session window and eventually callsaxlSaveSetupToLib with the lib/cell/view information youspecify when the program prompts you for it.

axlSaveSetup Saves the setup database and associated state information forthe 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 optionsfor generating a datasheet.

Setup Database SKILL Functions, continued


http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-


42/276



axlCommitSetupDB

axlCommitSetupDB(

x_database)

=> t / nil

Description

Saves the setup database.

Argument

Value Returned

Exampledata_session = ( axlCreateSession "data_session" )data_sdb = axlSetMainSetupDB( data_session "data.sdb" )axlCommitSetupDB( data_sdb )t

Reference

axlCreateSession, axlSetMainSetupDB


t Successful save operation.

nil Unsuccessful save operation.


43/276



axlCommitSetupDBAndHistoryAs

axlCommitSetupDBAndHistoryAs(

x_databaset_name

)

=> t / nil

Description

Saves the setup database along with history entries under a new name.

Arguments

Value Returned

Example

axlCommitSetupDBAndHistoryAs 1002 "newData.sdb"t


t_name New setup database name.




44/276



axlCommitSetupDBas

axlCommitSetupDBas(

x_databaset_name

)

=> t / nil

Description

Saves the setup database under a new name.

Arguments

Value Returned

Example

axlCommitSetupDBas 1002 "data.sdb"t






45/276



axlGetActiveSetup

axlGetActiveSetup(

x_database)

=> x_active / nil

Description

Returns a handle to the active test setup in the specified setup database.

Argument

Value Returned

Example


x_active Handle to the active test setup.



46/276



axlGetDescription

axlGetDescription(

x_element)

=> t_description / nil

Description

Returns a description of the setup database entry.

Argument

Value Returned

ExampleaxlGetDescription 1021"My description text."

x_element Setup database element handle.

t_description Database entry description text.



47/276



axlGetElementParent

axlGetElementParent(

x_element)

=> x_parent / nil

Description

Returns a handle to the parent of the specified setup database element.

Argument

Value Returned

Example

data_session = ( axlCreateSession "data_session" )data_sdb = axlSetMainSetupDB( data_session "data.sdb" )axlGetElementParent( axlGetHistoryEntry( data_sdb "data_design_verification" ) )1004

Reference

axlCreateSession, axlSetMainSetupDB, axlGetHistoryEntry


x_parent Handle to the parent of x_element.For example, if x_element is the handle to a variable’s value,x_parent is the handle to the variable; if x_element is thehandle to a variable, x_parent is the handle to the set ofvariables; and so on up to the top-level setup database handle.

g_errorOrZero Error message if input argument is invalid or zero if the elementhas no parent.


48/276



axlGetEnabled

axlGetEnabled(

x_element)

=> t / nil

Description

Checks whether a setup database element is enabled or not.

Argument

Value Returned

ExampleaxlGetEnabled 1021nil


t Element is enabled.

nil Element is not enabled.


49/276



axlGetLocations

axlGetLocations(

x_element)

=> l_locations / nil

Description

Returns a list containing a handle to all device instance parameter locations for this databaseentry and a list of all location names.

Argument

Value Returned

Example

axlGetLocations 1021'(1027("opamps/OpAmp_lab2/schematic/M1" "opamps/OpAmp_lab2/schematic/M2"))


l_locations List containing a handle to all device instance parameterlocations for this database entry and a list of all location names.



50/276



axlGetParameter

axlGetParameter(

x_elementt_location

t_parameter

)

=> x_parameter / nil

Description

Finds a device instance parameter by name and location.

Arguments

Value Returned

Example

axlGetParameter 1004 "opamps/OpAmp_lab2/schematic/M1" "m"1028


t_location Device instance parameter location aslibraryName/cellName/viewName/instanceName.

t_parameter Device instance parameter name.

x_parameter Handle to the device instance parameter.



51/276



axlGetParameterName

axlGetParameterName(

x_parameter )

=> t_name / nil

Description

Gets the name of a device instance parameter.

Argument

Value Returned

ExampleaxlGetParameterName 1005"fingers"

x_parameter Handle to a device instance parameter.

t_name Device instance parameter name.



52/276



axlGetParameters

axlGetParameters(

x_elementt_location

)

=> l_parameters / nil

Description

Returns a list containing a handle to all device instance parameters for this database entryand a list of all device instance parameter names.

Arguments

Value Returned

Example

axlGetParameters 1004 "opamps/OpAmp_lab2/schematic/M1"(1034("l" "m"))


t_location Device instance parameter location aslibraryName/cellName/viewName/instanceName..

l_parameters List containing a handle to all device instance parameters forthis database entry and a list of all device instance parameternames.



53/276



axlGetParameterValue

axlGetParameterValue(

x_parameter )

=> t_value / nil

Description

Gets the value of a device instance parameter.

Argument

Value Returned

ExampleaxlGetParameterValue 1005"15u"


t_value Device instance parameter value.



54/276



axlGetResultsLocation

axlGetResultsLocation(

x_database)

=> t_resultsLocation / nil

Description

Returns the results location for the specified setup database. The program uses theadexl.results saveDir setting to determine the results location.

Argument

Value Returned

Example

If you do not set the adexl.results saveDir environment variable in your .cdsenv:

data_session = ( axlCreateSession "data_session" )data_sdb = axlSetMainSetupDB( data_session "data.sdb" )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"


t_resultsLocation Results location which includes a directory named from thesetup database name prefix.

nil Unsuccessful get operation.

http://%24adexl.pdf/http://%24adexl.pdf/http://%24adexl.pdf/http://%24adexl.pdf/http://%24adexl.pdf/http://%24adexl.pdf/http://%24adexl.pdf/http://%24adexl.pdf/


55/276



Reference

axlCreateSession, axlGetHistoryEntry, axlGetMainSetupDB, axlSetMainSetupDB


56/276



axlGetScript

axlGetScript(

x_elementt_name

)

=> x_script / nil

Description

Finds a script by name and returns a handle to it.

Arguments

Value Returned

Example

axlGetScript 1021 "myScript.nam"1045


t_name Script name.

x_script Script handle.

nil Unsuccessful add operation.


57/276



axlGetScriptPath

axlGetScriptPath(

x_script)

=> t_path / nil

Description

Returns the path of a script.

Argument

Value Returned

ExampleaxlGetScriptPath 1045"myData/scripts"


t_path Script path.



58/276



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 scriptnames.

Argument

Value Returned

Example

axlGetScripts 1045'((1001 "script1.ocn")(1002 "script2.ocn"))


l_scripts List containing a handle to all scripts for this database entry anda list of all script names.



59/276



axlGetSetupDB

axlGetSetupDB(

t_name)

=> x_database / nil

Description

Opens the named setup database and returns its handle.

Argument

Value Returned

ExampleaxlGetSetupDB "data.sdb"1011

t_name Setup database name.




60/276



axlGetSetupDBBaseName

axlGetSetupDBBaseName(

x_database)

=> t_name / nil

Description

Returns the name of specified setup database.

Argument

Value Returned

Exampledata_session = ( axlCreateSession "data_session" )data_sdb = axlSetMainSetupDB( data_session "data.sdb" )axlGetSetupDBBaseName( data_sdb )"data.sdb"

Reference






61/276


62/276



axlGetTopLevel

axlGetTopLevel(

x_element)

=> x_database / g_errorOrZero

Description

Returns a handle to the setup dabase containing the specified element.

Argument

Value Returned

Example

data_session = ( axlCreateSession "data_session" )data_sdb = axlSetMainSetupDB( data_session "data.sdb" )axlGetTopLevel( axlGetHistoryEntry( data_sdb "data_design_verification" ) )1004

Reference




g_errorOrZero Error message if input argument is invalid or zero for otherwiseunsuccessful operation.


63/276



axlGetVar

axlGetVar(

x_databaset_name

)

=> x_var / nil

Description

Finds a global variable by name and returns a handle to it.

Arguments

Value Returned

Example

data_session = ( axlCreateSession "data_session" )data_sdb = axlSetMainSetupDB( data_session "data.sdb" );; Disable variablesforeach( param cadr( axlGetVars( data_sdb ) )

axlSetEnabled( axlGetVar( data_sdb param ) nil )1

Reference

axlCreateSession, axlSetMainSetupDB, axlSetEnabled, axlGetVars


t_name Variable name.

x_var Handle to the global variable.



64/276



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 allglobal variable names.

Argument

Value Returned

Example

data_session = ( axlCreateSession "data_session" )data_sdb = axlSetMainSetupDB( data_session "data.sdb" )axlGetVars( data_sdb )(1023("CLoad" "RLoad" "VDC"))

Reference



l_vars List containing a handle to all global variables for a databaseentry and a list of all global variable names.



65/276



axlGetVarValue

axlGetVarValue(

x_var )

=> t_value / nil

Description

Gets the value of a global variable.

Argument

Value Returned

ExampleaxlGetVarValue 1005"100u"

x_var Handle to a global variable.

t_value Variable value.



66/276



axlIsDirty

axlIsDirty(

x_element)

=> t / nil

Description

Checks whether the specified setup database has been modified since the last saveoperation.

Argument

Value Returned

Example

data_session = ( axlCreateSession "data_session" )data_sdb = axlSetMainSetupDB( data_session "data.sdb" )axlIsDirty( data_sdb )nil

Reference



t Setup database has been modified since the last saveoperation.

nil Setup database has not been modified since the last save

operation.


67/276



axlIsElement

axlIsElement(

x_database)

=> t / nil

Description

Checks whether the handle ( passed as an argument ) is a valid setup database handle.

Argument

Value Returned

Exampledata_session = ( axlCreateSession "data_session" )data_sdb = axlSetMainSetupDB( data_session "data.sdb" )axlIsElement( data_sdb )t

Reference



t Valid setup database handle.

nil Not a valid setup database handle.


68/276



axlIsReadOnly

axlIsReadOnly(

x_element)

=> t / nil

Description

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

Argument

Value Returned

Example

axlIsReadOnly 1nil


t Handle references a read-only branch of the setup database.

nil Handle does not reference a read-only branch of the setupdatabase.


69/276



axlIsSetupDB

axlIsSetupDB(

x_database)

=> t / nil

Description

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

Argument

Value Returned

Exampledata_session = ( axlCreateSession "data_session" )data_sdb = axlSetMainSetupDB( data_session "data.sdb" )axlIsSetupDB( data_sdb )t

Reference


x_database Handle to open setup database.

t Handle refers to an open setup datbase.

nil Handle does not refer to an open setup database.


70/276



axlNewSetupDB

axlNewSetupDB(

t_name)

=> x_database / nil

Description

Opens the named setup database and returns its handle. If the named setup database doesnot already exist, this function creates one and returns a handle to it.

Argument

Value Returned

Example

axlNewSetupDB( "data" )1



nil Unsuccessful open/create operation.


71/276



axlPutParameter

axlPutParameter(

x_elementt_location

t_parameter

)

=> x_parameter / nil

Description

Inserts or finds a device instance parameter by name and location.

Arguments

Value Returned

Example

axlPutParameter 1004 "opamp/opamp1/schematic/M1" "l")1005


t_location Device instance parameter location aslibraryName/cellName/viewName/instanceName..

t_parameter Device instance parameter name.

x_parameter Handle to the device instance parameter.



72/276



axlPutScript

axlPutScript(

x_elementt_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

Value Returned

Example

axlPutScript 1004 "scriptname" "/path/to/script/file")1005


t_name Script name.

t_path Path.




73/276



axlPutTest

axlPutTest(

x_databaset_test

)

=> x_test / nil

Description

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

Arguments

Value Returned

Example

data_session = ( axlCreateSession "data_session" )data_sdb = axlSetMainSetupDB( data_session "data.sdb" )axlPutTest( data_sdb "data_dead_band" )2201

Reference



t_test Test name.

x_test Test handle.



74/276



axlPutVar

axlPutVar(

x_elementt_name

t_value

)

=> x_var / nil

Description

Inserts or finds a global variable by name and sets its value.

Arguments

Value Returned

Example

data_session = ( axlCreateSession "data_session" )data_sdb = axlSetMainSetupDB( data_session "data.sdb" )c1 = axlPutCorner( data_sdb "c1" )axlPutVar( c1 "data_dcm_temperature" "1" )1089

Reference

axlCreateSession, axlPutCorner, axlSetMainSetupDB


t_name Variable name.


x_var Handle to the global variable.



75/276



axlRemoveElement

axlRemoveElement(

x_element)

=> t / nil

Description

Removes an element and all its children from the setup database.

Argument

Value Returned

Exampledata_session = ( axlCreateSession "data_session" )data_sdb = axlSetMainSetupDB( data_session "data.sdb" )axlRemoveElement( axlGetHistoryEntry( data_sdb "data_design_verification" ) )t

Reference



t Successful remove operation.

nil Unsuccessful remove operation.


76/276



axlResetActive

axlResetActive(

x_database)

=> t / nil

Description

Resets the active setup database.

Argument

Value Returned

ExampleaxlResetActive( 1003 )t





77/276



axlSaveAs

axlSaveAs(

w_windowIDt_libName

t_cellName

t_viewName

)

=> t / nil

Description

The program calls this function when you choose File – Save As in your ADE XL sessionwindow and eventually calls axlSaveSetupToLib with the lib/cell/view information you

specify when the program prompts you for it.

Arguments

Value Returned

Example

axlSaveAs( window:3 "testlib" "testcell" "adexl" )t

w_windowID Window ID of an ADE XL session.

t_libName Library name.

t_cellName Cell name.

t_viewName View name.




78/276



axlSaveSetup

axlSaveSetup(

)=> t / nil

Description

Saves the setup database and associated state information for the current window.

Argument

None.

Value Returned

Example

axlSaveSetup( )t




79/276



axlSaveSetupToLib

axlSaveSetupToLib(

x_databaset_libName

t_cellName

t_viewName

)

=> t / nil

Description

Saves the setup database to the specified lib/cell/view.

Arguments

Value Returned

Example

axlSaveSetupToLib( 1001, "lib", "cell", "view" )t

Reference

axlSaveAs


t_libName Library name.

t_cellName Cell name.

t_viewName View name.




80/276



axlSetDescription

axlSetDescription(

x_elementt_description

)

=> t / nil

Description

Adds a description to a setup database entry.

Arguments

Value Returned

Example

axlSetDescription ( axlGetHistoryEntry 1045 "Interactive.0" ) "Description text."t


t_description Description text.




81/276



axlSetElementValue

axlSetElementValue(

x_elementt_value

)

=> t / nil

Description

Sets the value of the specified element.

Arguments

Value Returned

Example

axlSetElementValue 1058 "100u"t


t_value Value.

t Successful set operation.

nil Unsuccessful set operation.


82/276



axlSetEnabled

axlSetEnabled(

x_elementg_enable

)

=> t / nil

Description

Enables or disables a setup database element.

Arguments

Value Returned

Example

data_session = ( axlCreateSession "data_session" )data_sdb = axlSetMainSetupDB( data_session "data.sdb" );; Enable a testdata_dead_band = axlGetTest( data_sdb "data_dead_band" )

axlSetEnabled( data_dead_band t );; Disable testsforeach( test cadr( axlGetTests( data_sdb ) )

axlSetEnabled( axlGetTest( data_sdb test ) nil )

;; Disable variablesforeach( param cadr( axlGetVars( data_sdb ) )

axlSetEnabled( axlGetVar( data_sdb param ) nil )


g_enable Enable flagValid Values:

nil Disabled

any other value Enabled




83/276



Reference

axlCreateSession, axlSetMainSetupDB, axlGetTests, axlGetTest, axlGetVars,axlGetVar


84/276



axlSetParameterName

axlSetParameterName(

x_parameter t_name

)

=> t / nil

Description

Sets the name of a device instance parameter.

Arguments

Value Returned

Example

axlSetParameterName 1050 "sdMtlWidth"t


t_name Device instance parameter name.




85/276



axlSetParameterValue

axlSetParameterValue(

x_parameter t_value

)

=> t / nil

Description

Sets the value of a device instance parameter.

Arguments

Value Returned

Example

axlSetParameterValue 1050 "120n"t


t_value Device instance parameter value.




86/276



axlSetScriptPath

axlSetScriptPath(

x_scriptt_path

)

=> t / nil

Description

Sets the path of a script.

Arguments

Value Returned

Example

axlSetScriptPath 1045 "myData/myScripts"t


t_path Script path.




87/276



axlSetSetupDBName

axlSetSetupDBName(

x_databaset_name

)

=> t / nil

Description

Renames the setup database.

Arguments

Value Returned

Example

axlSetSetupDBName 1090 "data.sdb"t



t Successful rename operation.

nil Unsuccessful rename operation.


88/276



axlSetVarValue

axlSetVarValue(

x_var t_value

)

=> t / nil

Description

Sets the value of a global variable.

Arguments

Value Returned

Example

axlSetVarValue 1085 "100u"t

x_var Handle to a global variable.





89/276



axlWriteDatasheet

axlWriteDatasheet(

x_axlSessionx_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 resultssummary sheet containing specification sheet pass/fail table.Default Value: t

g_testsSummary Boolean to specify whether or not you want to print a testssummary sheet containing details about the tests, sweeps, andcorners.Default Value: t

g_detailedResults Boolean to specify whether or not you want to generate resultsfor all points.Default Value: t

g_launchBrowser Boolean to specify whether or not you want to launch a browserwi

Adex Ls Kill Ref 610

Documents

Transcript of Adex Ls Kill Ref 610