1

---

Custom Constraints Functions

---

This chapter covers details about the SKILL functions available for the Constraints Manager and Circuit Prospector assistants. It contains sections on the following topics:

• Input and Output Parameters for Custom Constraints Functions
• Pre-Defined Symbols
• Constraint Manager Assistant Customization SKILL Commands
• Circuit Prospector Assistant Customization SKILL Commands
• Rapid Analog Prototype Category (Circuit Prospector) Customization SKILL Commands
• Constraint Generator Customization SKILL Commands
• Table Editor SKILL Commands

Constraint Integration and Third Party Tools

Any non-Cadence tools, that are integrated into DFII, can also register their proprietary constraints within the Constraint system using a config.xml file as discussed in the Creating Custom Constraint Types chapter of the Virtuoso Unified Custom Constraints Configuration Guide.

For more information on this feature, contact your local Cadence representative.

Constraint Cache

The constraint cache is a collection of constraint data that is built on demand for a given design and contains all the constraints related to that design.

There are two distinct APIs, ciCacheFind which only returns an already created cache, and ciCacheGet which will either return an already created cache or force one to be built.

Input and Output Parameters for Custom Constraints Functions

cache

Is defined as: u_cache | (libName cellName viewName)

u_cache

Is a SKILL user type object that references a constraint cache.

u_constraint

Is a SKILL user type object that references a constraint.

parameter_value

A parameter value is a SKILL atom or list that contains a legal value for the parameter.

• Enumerated parameters and arrays are expressed as homogeneous value type lists.
• Boolean values are evaluated to SKILL t/nil for true/false respectively (and "TRUE"/"FALSE" strings both evaluate to t, while 0/1 evaluate to t/nil respectively).

When parameter_type is specified in a parameter, the atom members are converted to the specified values using standard arithmetic conversion.

Strings are not converted to and from numerals. For example, "1" is not converted to the integer 1 and the integer 1 is not converted to the string "1".

parameter

Is defined as: (name_string [parameter_type] parameter_value)

A constraint parameter is a list that contains the parameter name and parameter_value and, optionally, a parameter_type.

parameter_list

Is defined as a list of constraint parameters:

(constraint_parameter1 constraint_parameter2 ...)

constraint_member

Is defined as: (design_object_name design_object_type [parameter_list ])

A constraint member is a list containing the member name and type and, optionally, a list of member parameter. Constraints always refer to constraint members using a name and type pair to avoid conflicts in design namespaces between design objects: the pair (name type) creates a unique namespace for any design hierarchy.

design_object

Is defined as: (design_object_name design_object_type )

• A design object is similar to a constraint_member, in that it is always a design_object_name design_object_type pair and it cannot have parameters.
• A design object is part of the constraint cache if any constraint has been set on that design object.
• A design object contains references to all constraints that refer to it as a member.

design_object_name

A member name is a legal design object name in the CDBA name space.

member_list

Is defined as a list of constraint members:

(constraint_member1 constraint_member2 ...)

design_object_list

Is defined as: member_list constraint_member

A design object list is a list of design objects.

Pre-Defined Symbols

The following is a list of constraint pre-defined symbols:

design_object_type

Is defined as: inst | net | modgen | netClass | cluster | pin | instTerm | master | terminal | boundary | netClassGroup | symmetry | diffPair | matchedLength | bus

A design object type is a symbol that describes the database object type of a design object.

The design objects type, such as inst, net, pin, instTerm, terminal, and boundary are used when specifying those types of design object as members of a constraint.

ciConCreate(cache 'diffPair ?members list( list("N1" 'net) list("N2" 'net)))

It specifies two nets N1 and N2 as members of a Diff Pair constraint.

The modgen, netClass, cluster, netClassGroup, symmetry, diffPair, matchedLength, and bus are used when specifying those type of constraints as members of another constraints. These constraints can also be members of other constraints. For example, Symmetry (on Modgens), Guardring (on Clusters) or to create hierarchical relationships like a Cluster comprising of other Clusters.

ciConCreate(cache 'symmetry ?members list( list("Moden_1" 'modgen)))

It specifies Modgen constraint Modgen_1 as a member of a Symmetry constraint.

ciConCreate(cache 'cluster ?members list( list("I0" 'inst) list("Cluster_2" 'cluster)))

It specifies instance I0 and cluster Cluster_2 as members of a Cluster constraint.

parameter_type

Is defined as: int | float | string | intrange | floatrange | enum | enumset | stringset

constraint_type

A list of default constraint types corresponding to SKILL names is illustrated below:

For information on the current list of Constraint Manager constraints, see Default Constraint Types in the Virtuoso Unified Custom Constraints User Guide.

parameter_key

Is defined as: ?params

member_key

Is defined as: ?members

name_key

Is defined as: ?name

axis_key

Is defined as: ?axis

axis

Is defined as: axis_name_string [parameter_list]

Constraint Manager Assistant Customization SKILL Commands

The following SKILL commands are available for customizing the Constraint Manager assistant:

ciAddHierarchicalNotes

ciAddHierarchicalNotes( 
t_libName
t_cellName
t_viewName
[ g_hierarchical ]
)
=> t / nil

Description

Adds notes to the templates and constraints for a single cellview or all along the hierarchy beginning from the given cellview.

See also ciUpdateHierarchicalNotes and ciRemoveHierarchicalNotes.

Arguments

Value Returned

Examples

To add notes to the entire hierarchy starting from the specified cellview:

ciAddHierarchicalNotes("myLib" "myCellName" "myView" t)

ciAddLeadingSlash

ciAddLeadingSlash( 
t_name
[ ?skipEmpty g_skipEmpty ]
)
=> t_name

Description

Adds a forward slash (/) to the beginning of the passed string if it does not already have one.

Arguments

Value Returned

Examples

ciAddLeadingSlash("NM1") 

=> "/NM1"

ciAddLeadingSlash("/I1/NM1") 

=> "/I1/NM1"

ciAddLeadingSlash("")       

=> ""

ciAddLeadingSlash("" ?skipEmpty nil) 

=> "/"

ciAddProcessRules

ciAddProcessRules( 
d_Id
l_rules
[ t_parameterType ]
)
=> t / nil

Description

Adds the specified process rules to the front of the rules associated with the given object.

By default, the process rules for all objects are derived from the foundry constraint group in the technology database. These rules can however be overridden for specific objects or for a given design.

Process rule overrides on any object apply to other objects following a hierarchical precedence. For example, when applied to nets they will affect all routes and shapes that belong to that net, and when applied to routes they will affect all the shapes (paths, pathSegs) on that route. In Virtuoso, applications follow the precedence of: wires (paths/pathSegs/vias/guides) -> routes -> nets -> net classes -> design, when looking up constraints on objects (defaulting to foundry). The lookup is further guided by the ordering of constraints within any one constraintGroup (hard lookup) and the precedence ordering of the constraint groups themselves (soft lookup).

See also:

• The process rule overrides constraint in the Virtuoso Unified Custom Constraints User Guide.
• Process Rules for Objects in the Virtuoso Unified Custom Constraints User Guide.

Arguments

(type list(layers as strings) value_as_appropriate_type)

ciAddProcessRules(net list( list(‘group ‘tech “MyConstraintGroup”)))

Value Returned

Example

To add a spacing to Group to Outside Group on a netclass:

ciAddProcessRules(netClassCon list(list("minSpacing" "Metal1" .2 )) "TransReflexive")

To define default values for the top and bottom layers of a constraint group called myRG1:

ciAddProcessRules(myRG1 '( ("minWidth" "Metal1" 1.0) ("minWidth" "Metal2" 1.2) ("validLayers" nil ("Metal1" "Metal2" "Metal3"))))

ciAddRuleGroup

ciAddRuleGroup( 
[ d_techID | d_cellViewID ]
t_name
)
=> t / nil

Description

Creates an oaConstraint group, with a given name, for technology or design files.

The first argument given should be either d_techID or d_cellViewID, followed by t_name.

Arguments

Value Returned

Example

tf = techGetTechFile(geGetEditCellView ())
cg1 = ciAddRuleGroup(tf "cg1")

To create a new constraint group called myRG1:

cv=geGetEditCellView()

myRG1=ciAddRuleGroup(cv "myRG1")

The new constraint group can now be selected as the Default Group (Constraint Group) on the Constraint Parameter Editor. Default values for the myRG1 parameters can be defined using the ciAddProcessRules command.

ciAddTrailingSlash

ciAddTrailingSlash( 
t_name
[ ?skipEmpty g_skipEmpty ]
)
=> t_name

Description

Adds a forward slash (/) to the end of the passed string if it does not already have one.

Arguments

Value Returned

Examples

ciAddTrailingSlash("NM1")            

=> "NM1/"

ciAddTrailingSlash("/I1/NM1/")        

=> "/I1/NM1/"

ciAddTrailingSlash("")                

=> ""

ciAddTrailingSlash("" ?skipEmpty nil) 

=> "/" 

ciAllCellViewsInHierarchy

ciAllCellViewsInHierarchy( 
d_cellViewDBId
[ t_pathToCurrentCellView ]
[ t_pathFilter ]
[ t_depth ]
[ s_predicate ]
)
=> list / nil

Description

Returns a list of disembodied property lists containing the path and database ID of each cellview in the hierarchy, or to a specific depth starting from a given cellview and path to that cellview.

Arguments

Value Returned

Example

allCVs = ciAllCellViewsInHierarchy(geGetEditCellView())

((nil hierPath "" cellView db:0xf0f1e492) 

 (nil hierPath "/I16" cellView db:0xf0f1b192) 

 (nil hierPath "/I18" cellView db:0xf0f1b192) 

 (nil hierPath "/I17" cellView db:0xf0f1b192)

 (nil hierPath "/I17/I22" cellView db:0xf0f1b194) 

 (nil hierPath "/I17/I23" cellView db:0xf0f1b198)

 (nil hierPath "/I15" cellView db:0xf0f1ac12)

)

I17cv = nthelem(4 allCVs)

I17CVs = ciAllCellViewsInHierarchy(I17cv "/I17")

((nil hierPath "/I17" cellView db:0xf0f1b192)

 (nil hierPath "/I17/I22" cellView db:0xf0f1b194) 

 (nil hierPath "/I17/I23" cellView db:0xf0f1b198)

)

allCVsI17 = ciAllCellViewsInHierarchy(geGetEditCellView() "" "/I17")

((nil hierPath "" cellView db:0xf0f1e492) 

 (nil hierPath "/I17" cellView db:0xf0f1b192)

 (nil hierPath "/I17/I22" cellView db:0xf0f1b194) 

 (nil hierPath "/I17/I23" cellView db:0xf0f1b198)

)

allCVsDepth1 = ciAllCellViewsInHierarchy(geGetEditCellView() "" "" 1)

((nil hierPath "" cellView db:0xf0f1e492) 

 (nil hierPath "/I16" cellView db:0xf0f1b192) 

 (nil hierPath "/I18" cellView db:0xf0f1b192) 

 (nil hierPath "/I17" cellView db:0xf0f1b192)

 (nil hierPath "/I15" cellView db:0xf0f1ac12)

)

;;Only look into cellview which are part of the library AnalogLib.

procedure(myPredicate(libName cellName viewName depth)

!exists(x '(("ether_adcflash_RAD90" "adc_sample_hold" "schematic")

("ether_adcflash_RAD90" "adcflash_comparator_actr" "schematic")

("ether_adcflash_RAD90" "and2_1x_hv" "schematic")

("ether_adcflash_RAD90" "clkbuf_2x_hv" "schematic")

("ether_adcflash_RAD90" "inv_2x_hv" "schematic")

("ether_adcflash_RAD90" "nand2_2x_hv" "schematic")

("ether_adcflash_RAD90" "or2_2x_hv" "schematic")

("ether_adcflash_RAD90" "sheet_a" "symbol")

("ether_adcflash_RAD90" "sheet_aa" "symbol")

("ether_adcflash_RAD90" "sheet_b" "symbol"))

equal(x list(l c v)))

)

ciAllCellViewsInHierarchy(cv currentHierPath pathFilter depth 'myPredicate)

ciAllCellViewsInHierarchy(geGetEditCellView(window(3)) "" "" -1 'testPredicate)

((nil hierPath "" cellView db:0x17f0b69a) 

(nil hierPath "/ADCFLASH_REF_LADDER" cellView db:0x17f0711a) 

(nil hierPath "/ADCFLASH_REF_LADDER/I2" cellView db:0x17f0af1a) 

(nil hierPath "/ADCFLASH_REF_LADDER/R1" cellView db:0x17f0949a) 

(nil hierPath "/ADCFLASH_REF_LADDER/R11" cellView db:0x17f0949a)

(nil hierPath "/ADCFLASH_REF_LADDER/R12<4:0>" cellView db:0x17f09a9a) 

(nil hierPath "/ADCFLASH_REF_LADDER/R13<1:0>" cellView db:0x17f09a9a) 

(nil hierPath "/ADCFLASH_REF_LADDER/R17<1:0>" cellView db:0x17f09a9a) 

(nil hierPath "/ADCFLASH_REF_LADDER/R18<4:0>" cellView db:0x17f09a9a) 

(nil hierPath "/ADCFLASH_REF_LADDER/R19<4:0>" cellView db:0x17f09a9a)

(nil hierPath "/ADCFLASH_REF_LADDER/R20<1:0>" cellView db:0x17f09a9a) 

(nil hierPath "/ADCFLASH_REF_LADDER/R21<1:0>" cellView db:0x17f09a9a) 

(nil hierPath "/ADCFLASH_REF_LADDER/R3<1:0>" cellView db:0x17f09a9a) 

(nil hierPath "/ADCFLASH_REF_LADDER/R7<1:0>" cellView db:0x17f09a9a) 

(nil hierPath "/ADCFLASH_REF_LADDER/R8<4:0>" cellView db:0x17f09a9a)

)

ciAllCellViewsInHierarchy(cv currentHierPath pathFilter depth)

ciAllCellViewsInHierarchy(geGetEditCellView(window(3)) "" "" -1 )

((nil hierPath "" cellView db:0x17f0b69a) 

(nil hierPath "/ADCFLASH_REF_LADDER" cellView db:0x17f0711a) 

(nil hierPath "/ADCFLASH_SAMPLE_HOLD" cellView db:0x17f06a1a) 

(nil hierPath "/I22" cellView db:0x17f0619a) 

(nil hierPath "/I37" cellView db:0x17f0531a)

(nil hierPath "/I38" cellView db:0x17f04d1a) 

(nil hierPath "/I39" cellView db:0x17f04d1a) 

(nil hierPath "/I4" cellView db:0x17f0619a) 

(nil hierPath "/I40" cellView db:0x17f0499a) 

(nil hierPath "/I41" cellView db:0x17f0499a)

(nil hierPath "/I42" cellView db:0x17f0531a) 

(nil hierPath "/I5" cellView db:0x17f0619a) 

(nil hierPath "/I6" cellView db:0x17f0619a) 

(nil hierPath "/I7" cellView db:0x17f0619a) 

(nil hierPath "/I8" cellView db:0x17f0619a)

(nil hierPath "/I9" cellView db:0x17f0619a) 

(nil hierPath "/ADCFLASH_REF_LADDER/I2" cellView db:0x17f0af1a) 

(nil hierPath "/ADCFLASH_REF_LADDER/R1" cellView db:0x17f0949a) 

(nil hierPath "/ADCFLASH_REF_LADDER/R11" cellView db:0x17f0949a) 

(nil hierPath "/ADCFLASH_REF_LADDER/R12<4:0>" cellView db:0x17f09a9a)

(nil hierPath "/ADCFLASH_REF_LADDER/R13<1:0>" cellView db:0x17f09a9a) 

(nil hierPath "/ADCFLASH_REF_LADDER/R17<1:0>" cellView db:0x17f09a9a) 

(nil hierPath "/ADCFLASH_REF_LADDER/R18<4:0>" cellView db:0x17f09a9a) 

(nil hierPath "/ADCFLASH_REF_LADDER/R19<4:0>" cellView db:0x17f09a9a) 

(nil hierPath "/ADCFLASH_REF_LADDER/R20<1:0>" cellView db:0x17f09a9a)

(nil hierPath "/ADCFLASH_REF_LADDER/R21<1:0>" cellView db:0x17f09a9a) 

(nil hierPath "/ADCFLASH_REF_LADDER/R3<1:0>" cellView db:0x17f09a9a) 

(nil hierPath "/ADCFLASH_REF_LADDER/R7<1:0>" cellView db:0x17f09a9a) 

(nil hierPath "/ADCFLASH_REF_LADDER/R8<4:0>" cellView db:0x17f09a9a) 

(nil hierPath "/ADCFLASH_SAMPLE_HOLD/I58" cellView db:0x17f04d1a)

(nil hierPath "/I22/I12" cellView db:0x17f0431a) 

(nil hierPath "/I22/I13" cellView db:0x17f0431a) 

(nil hierPath "/I22/I16" cellView db:0x17f03d9a) 

(nil hierPath "/I22/I17" cellView db:0x17f03d9a) 

(nil hierPath "/I22/R2" cellView db:0x17f09a9a)

(nil hierPath "/I22/R3" cellView db:0x17f09a9a) 

(nil hierPath "/I4/I12" cellView db:0x17f0431a) 

(nil hierPath "/I4/I13" cellView db:0x17f0431a) 

(nil hierPath "/I4/I16" cellView db:0x17f03d9a) 

(nil hierPath "/I4/I17" cellView db:0x17f03d9a)

(nil hierPath "/I4/R2" cellView db:0x17f09a9a) 

(nil hierPath "/I4/R3" cellView db:0x17f09a9a) 

(nil hierPath "/I5/I12" cellView db:0x17f0431a) 

(nil hierPath "/I5/I13" cellView db:0x17f0431a) 

(nil hierPath "/I5/I16" cellView db:0x17f03d9a)

(nil hierPath "/I5/I17" cellView db:0x17f03d9a) 

(nil hierPath "/I5/R2" cellView db:0x17f09a9a) 

(nil hierPath "/I5/R3" cellView db:0x17f09a9a) 

(nil hierPath "/I6/I12" cellView db:0x17f0431a) 

(nil hierPath "/I6/I13" cellView db:0x17f0431a)

(nil hierPath "/I6/I16" cellView db:0x17f03d9a) 

(nil hierPath "/I6/I17" cellView db:0x17f03d9a) 

(nil hierPath "/I6/R2" cellView db:0x17f09a9a) 

(nil hierPath "/I6/R3" cellView db:0x17f09a9a) 

(nil hierPath "/I7/I12" cellView db:0x17f0431a)

(nil hierPath "/I7/I13" cellView db:0x17f0431a) 

(nil hierPath "/I7/I16" cellView db:0x17f03d9a) 

(nil hierPath "/I7/I17" cellView db:0x17f03d9a) 

(nil hierPath "/I7/R2" cellView db:0x17f09a9a) 

(nil hierPath "/I7/R3" cellView db:0x17f09a9a)

(nil hierPath "/I8/I12" cellView db:0x17f0431a) 

(nil hierPath "/I8/I13" cellView db:0x17f0431a) 

(nil hierPath "/I8/I16" cellView db:0x17f03d9a) 

(nil hierPath "/I8/I17" cellView db:0x17f03d9a) 

(nil hierPath "/I8/R2" cellView db:0x17f09a9a)

(nil hierPath "/I8/R3" cellView db:0x17f09a9a) 

(nil hierPath "/I9/I12" cellView db:0x17f0431a) 

(nil hierPath "/I9/I13" cellView db:0x17f0431a) 

(nil hierPath "/I9/I16" cellView db:0x17f03d9a) 

(nil hierPath "/I9/I17" cellView db:0x17f03d9a)

(nil hierPath "/I9/R2" cellView db:0x17f09a9a) 

(nil hierPath "/I9/R3" cellView db:0x17f09a9a)

)

ciAxisCreate

ciAxisCreate( 
u_cache
t_axisName
[ l_parameterList ]
)
=> t / nil

Description

Creates a new axis.

Arguments

direction = "horizontal" | "vertical"

axisLocation = "any" | "fixed"

coordinate (only valid if location is "fixed")

Examples:

; Create a movable horizontal axis.

ciAxisCreate(cache

              "hAxis"

              '(("direction" "horizontal") ("axisLocation" "any")))

; Create a fixed, vertical axis.

ciAxisCreate(cache

              "vAxis"

              '(("direction" "vertical")

                ("axisLocation" "fixed")

                ("coordinate" 10)))

Value Returned

ciAxisDelete

ciAxisDelete( 
u_cache
t_axisName
[ g_forceDelete ]
)
=> t / nil

Description

Deletes an axis from the specified cache.

Arguments

Value Returned

ciAxisExists

ciAxisExists( 
u_cache
t_axisName
)
=> t / nil

Description

Returns t (true) if the named axis exists in the cache. Access to axes is only provided through the axis name. No direct reference to an axis object is provided.

Arguments

Value Returned

ciAxisListCon

ciAxisListCon( 
u_cache
t_axisName
)
=> u_constraint / nil

Description

Lists all the constraints that are attached to a given axis.

Arguments

Value Returned

ciAxisListParams

ciAxisListParams( 
u_cache
t_axisName
[ g_includeDefaults ]
)
=> parameterList / nil

Description

Lists the parameters associated with an axis.

Arguments

Value Returned

ciAxisReplaceParams

ciAxisReplaceParams( 
u_cache
t_axisName
l_parameterList
)
=> t / nil

Description

Replaces all axis constraint parameters with a new set of parameters.

Arguments

direction = "horizontal" | "vertical"

axisLocation = "any" | "fixed"

coordinate (only valid if location is "fixed")

Examples:

; Replace a movable horizontal axis.

ciAxisReplaceParams(cache

              "hAxis"

              '(("direction" "horizontal") ("axisLocation" "any")))

; Replace a fixed, vertical axis.

ciAxisReplaceParams(cache

              "vAxis"

              '(("direction" "vertical")

                ("axisLocation" "fixed")

                ("coordinate" 10)))

Value Returned

ciCacheCallbackRegister

ciCacheCallbackRegister( 
l_callbackPropList
)
=> t / nil

Description

Registers a callback.

Arguments

'(nil 
callback callbackName 
type ciPreSaveCallback|ciPostSaveCallback 
enable t|nil)

Value Returned

Examples

;; Definition of a pre-save callback:

(defun myPreSaveCallback (cache)

;; Do something useful with the cache here.

;; Do not call any save function here.

(printf "Cache for design %L is about to be saved." cache->design))

;;Definition of a post-save callback:

(defun myPostSaveCallback (cache saved)

;; Do something useful with the saved cache.

;; Do not call any save function here.

;; For the time being 'saved' always retuns 't' 

(printf "Cache for design %L has been saved [%L].\n" cache->design saved))

;; Definition of the callback lists

preSaveCB  = '(nil callback myPreSaveCallback  type ciPreSaveCallback  enable t)

postSaveCB = '(nil callback myPostSaveCallback type ciPostSaveCallback)

;; Register the callbacks

(mapcar 'ciCacheCallbackRegister (list preSaveCB postSaveCB)) 

;; If the callbacks were not registered already, this call returns (t t)

;; In this case, a second call will return (nil nil) because the callback

;; registry will not be changed.

;; Currently only the preSaveCB will be called on saved, because the postSaveCB is disabled

;; To enable it, we need to call ciCacheCallbackUpdate.

postSaveCB->enable = t

(ciCacheCallbackUpdate postSaveCB) 

;; returns 't'. Now the callback is enabled. A second call returns 'nil' because the callback registry will not be changed.

;; To unregister the callbacks

(mapcar 'ciCacheCallbackUnregister (list preSaveCB postSaveCB))

;; returns (t t). A second call returns (nil nil), because the callback registy

;; will not be changed.

;; Calls to ciCacheCallbackUpdate for these callbacks will return nil.

;; These callbacks need to be registered again to be re-enabled.

ciCacheCallbackUnregister

ciCacheCallbackUnregister( 
l_callbackPropList
)
=> t / nil

Description

Unregisters a previously registered callback.

Arguments

'(nil 
callback callbackName 
type ciPreSaveCallback|ciPostSaveCallback 
enable t|nil)

Value Returned

Example

Refer to the Examples given in the ciCacheCallbackRegister section.

ciCacheCallbackUpdate

ciCacheCallbackUpdate( 
l_callbackPropList
)
=> t / nil

Description

Updates a registered callback.

Arguments

'(nil 
callback callbackName 
type ciPreSaveCallback|ciPostSaveCallback 
enable t|nil)

Value Returned

Example

Refer to the Examples given in the ciCacheCallbackRegister section.

ciCacheCellName

ciCacheCellName( 
u_cache
)
=> t_cellName

Description

Returns the cell name of the specified constraint cache. The cache library, cell, and view refers to the schematic, configuration, physical configuration, or layout view that the constraint cache is associated with.

Arguments

Value Returned

Example

Return the cell name of the current constraint cache:

ciCacheCellName(ciGetCellView())

=> "block1"

ciCacheConstraintCellName

ciCacheConstraintCellName( 
u_cache
)
=> t_cellName

Description

Returns the constraint cell name of the specified constraint cache. The constraint library, cell, and view refers to the storage location of the constraints, which might be a constraint view or layout.

Arguments

Value Returned

Example

Return the constraint cell name of the current constraint cache:

ciCacheConstraintCellName(ciGetCellView())

=> "block1"

ciCacheConstraintLibName

ciCacheConstraintLibName( 
u_cache
)
=> t_libName

Description

Returns the constraint library name of the specified constraint cache. The constraint library, cell, and view refers to the storage location of the constraints, which might be a constraint view or layout.

Arguments

Value Returned

Example

Return the constraint library name of the current constraint cache:

ciCacheConstraintLibName(ciGetCellView())

=> "overview"

ciCacheConstraintViewName

ciCacheConstraintViewName( 
u_cache
)
=> t_viewName

Description

Returns the constraint view name of the specified constraint cache. The constraint library, cell, and view refers to the storage location of the constraints, which might be a constraint view or layout.

Arguments

Value Returned

Example

Return the constraint view name of the current constraint cache:

ciCacheConstraintViewName(ciGetCellView())

=> "constrBlock"

ciCacheDiscardEdits

ciCacheDiscardEdits( 
u_cache
)
=> u_cache / nil

Description

Discards changes made to the constraint cache in the memory and returns a new constraint cache ID. This function does not apply to layout constraint caches.

Arguments

Value Returned

Example

Discard the memory changes made to the current constraint cache:

cache = ciGetCellView()

  when( ciCacheIsModified(cache)

    cache = ciCacheDiscardEdits(cache)

  )

ciCacheFind

ciCacheFind( 
d_dbCellViewId | t_libName t_cellName t_viewName
)
=> u_cache / nil

Description

Finds an existing constraint cache for a given design specified using library, cell, and view names. Alternatively, pass the dbCellViewId of the required design.

Arguments

Value Returned

Examples

Find a cache using lib/cell/view names:

cache = ciCacheFind("myLib" "myDesign" "schematic")

Find a cache using the cellview in the current editor window:

cache = ciCacheFind(geGetEditCellView())

ciCacheGet

ciCacheGet( 
d_dbCellViewId | t_libName t_cellName t_viewName
)
=> u_cache / nil

Description

Finds an existing constraint cache. If it cannot find an existing cache, it creates and populates a cache for the given design, using library, cell, and view names. Alternatively, pass the dbCellViewId of the required design.

Arguments

Value Returned

Example

cv = geGetEditCellView()

ciCacheGet(cv)

ci:0x252c2d90

ciCacheGet(cv->libName cv->cellName cv->viewName)

ci:0x252c2d90

ciCacheGetAllNetNames

ciCacheGetAllNetNames( 
g_cache
[ ?expandNames g_expandNames ]
)
=> l_result

Description

Returns a sorted list of all the net names in the cellview associated with the constraints cache. By default, the iterated net names are expanded.

Arguments

Value Returned

Examples

• To get a list of all net names in the cellview and expand the iterated net names:
  

  cache = ciGetCellView()

  ciCacheGetAllNetNames(cache)

  ( "netA" "netB" "netC<0>" "netC<1>" "netD" )

• To get a list of all net names in the cellview and not expanded iterated net names:
  

  ciCacheGetAllNetNames(cache ?expandNames nil) 

  ( "netA" "netB" "netC<0:1>" "netD" )

ciCacheGetCellView

ciCacheGetCellView( 
g_cache
)
=> d_cellviewID / nil

Description

Returns the cellview associated to the specified cache.

Arguments

Value Returned

Examples

cv = ciCacheGetCellView(ciGetCellView())

dbFindAnyInstByName(cv "instanceName")

ciCacheGetEnabledNotifications

ciCacheGetEnabledNotifications( 
)
=> t_listNotifications / nil

Description

Returns a list of cache notifications that ciCacheNotifications enabled.

Arguments

None

Value Returned

Examples

ciCacheNotifications('disable '(NotifyAll))

t

ciCacheGetEnabledNotifications()

nil

Returns nil because all notifications are disabled.

ciCacheNotifications('enable '(WarnDesignInfoUpdates InfoOnCacheEditModeChanges))

t

ciCacheGetEnabledNotifications()

(InfoOnCacheEditModeChanges WarnDesignInfoUpdates)

Returns a list of notification symbols that are enabled.

ciCacheIsLayout

ciCacheIsLayout( 
g_cache
)
=> t / nil

Description

Returns t if the passed cache is a layout cache.

Arguments

Value Returned

Example

schCache = ciCacheGet("amsPLL" "vco" "schematic")

         layCache = ciCacheGet("amsPLL" "vco" "layout") 

         ciCacheIsLayout(schCache)

         nil

Retuns nil as the passed cache is not a layout cache.

         ciCacheIsLayout(layCache)

         t

Returns t as the passed cache is a layout cache.

ciCacheIsModified

ciCacheIsModified( 
u_cache
)
=> t / nil

Description

Checks whether a constraint cache has been modified.

Arguments

Value Returned

Example

The following saves a constraint cache if it has been modified:

cache = ciGetCellView()

  when( ciCacheIsModified(cache)

    ciCacheSave(cache)

  )

ciCacheIsWritable

ciCacheIsWritable( 
u_cache
)
=> t / nil

Description

Checks whether a constraint cache is writable.

Arguments

Value Returned

Example

cache = ciGetCellView()

  unless( ciCacheIsWritable(cache)

    cache = ciCacheMakeEditable(cache)

  )

Makes a constraint cache editable if it is read only.

ciCacheLCV

ciCacheLCV( 
u_cache
)
=> l_libCellViewNames

Description

Returns a list containing the library, cell, and view names of the specified constraint cache. The cache library, cell, and view refers to the schematic, configuration, physical configuration, or layout view that the constraint cache is associated with.

Arguments

Value Returned

( t_libName t_cellName t_viewName )

( "overview" "block1" "schematic" )

Example

ciCacheLCV(ciGetCellView())

=> ("overview" "block1" "physConfig")

Gets the library, cell, and view names of the current constraint cache.

ciCacheLibName

ciCacheLibName( 
u_cache
)
=> t_libName

Description

Returns the library name of the specified constraint cache. The cache library, cell, and view refers to the schematic, configuration, physical configuration, or layout view that the constraint cache is associated with.

Arguments

Value Returned

Example

Return the library name of the current constraint cache:

ciCacheLibName(ciGetCellView())

=> "overview"

ciCacheListAxesNames

ciCacheListAxesNames( 
u_cache
)
=> t_axesNames / nil

Description

Lists all axes names in a cache. Access to axes is only provided through the axis name, no direct reference to an axis object is provided.

Arguments

Value Returned

ciCacheListCon

ciCacheListCon( 
u_cache
[ g_includeOutOfContext ]
)
=> l_constraintList / nil

Description

Lists all the constraints from a given cache.

Arguments

Value Returned

ciCacheListConstrainedObjects

ciCacheListConstrainedObjects( 
u_cache
[ g_includeOutOfContext ]
)
=> l_designObjectList / nil

Description

Lists the name and type of all constrained objects.

Arguments

Value Returned

ciCacheListConstrainedObjectNames

ciCacheListConstrainedObjectNames( 
u_cache
[ g_includeOutOfContext ]
)
=> l_objectNameList / nil

Description

Lists the names of the constrained objects (without the type of object).

Arguments

Value Returned

ciCacheListTemplates

ciCacheListTemplates( 
u_cache
[ t_templateType ]
)
=> l_templateIdList / nil

Description

Lists all templates, of an optional given type, from a cache.

Arguments

Value Returned

ciCacheListTypeNames

ciCacheListTypeNames( 
u_cache
)
=> l_constraintTypeList / nil

Description

Lists all the names of the constraint types that are legal for the given cache.

Arguments

Value Returned

ciCacheListTypes

ciCacheListTypes( 
u_cache
)
=> l_constraintTypeList / nil

Description

Lists all constraint types in a cache.

Arguments

Value Returned

ciCacheMakeEditable

ciCacheMakeEditable( 
u_cache
)
=> u_cache / nil

Description

Reopens the constraint cache for edit and returns a new constraint cache ID. This function does not apply to layout constraint caches.

Arguments

Value Returned

Example

cache = ciGetCellView()

  when( null(ciCacheIsWritable(cache))

    cache = ciCacheMakeEditable(cache)

  )

Reopens the current constraint cache for editing.

ciCacheMakeReadOnly

ciCacheMakeReadOnly( 
u_cache
)
=> u_cache / nil

Description

Reopens the constraint cache in read-only mode and returns a new constraint cache ID. Any in modifications to the memory are discarded. This function does not apply to layout constraint caches.

Arguments

Value Returned

Example

cache = ciGetCellView()

  when( ciCacheIsWritable(cache)

    cache = ciCacheMakeReadOnly(cache)

  )

Reopens the current constraint cache in read mode.

ciCacheNeedRefresh

ciCacheNeedRefresh( 
u_cache
)
=> t / nil

Description

Checks if the constraint cache has changed on the disk and needs to be refreshed.

Arguments

Value Returned

Example

The following reports if the current constraint cache needs to be refreshed from the disk:

cache = ciGetCellView()

  when( ciCacheNeedRefresh(cache)

    info("Cache %L constraint view %L need refresh\n" ciCacheLCV(cache) ciConstraintLCV(cache))

  )

Cache ("overview" "block1" "physConfig") constraint view ("overview" "block1" "constrBlock") need refresh

The following reports how many contraint caches need to be refreshed from the disk:

  needrefresh = setof(c ciGetOpenCellViews() ciCacheNeedRefresh(c))

  when( needrefresh

    info("%d constraint caches need refresh\n" length(needrefresh))

  )

  2 constraint caches need refresh

ciCacheNotifications

ciCacheNotifications( 
s_enable
l_notifications
)
=> t / nil

Description

Enables or disables notifications related to the constraint cache. This function helps CAD teams in debugging.

Arguments

Value Returned

Examples

ciCacheNotifications('enable '(WarnDesignInfoUpdates InfoOnCacheEditModeChanges))

t

Enables notifications for the edit and read mode switches in cache and any updates to the schematic cache design information excluding the config views.

ciCacheNotifications('enable '(WarnDesignInfoUpdates ))

nil

Returns nil because WarnDesignInfoUpdates is already enabled.

ciCacheNotifications('disable '(WarnDesignInfoUpdates ))

t

Returns t after disabling WarnDesignInfoUpdates notifications.

ciCacheNotifications('disable '(WarnDesignInfoUpdates ))

nil

Returns nil because WarnDesignInfoUpdates notifications are already disabled.

ciCacheNotifications('enable '(NotifyAll))

t

Enables all notifications and returns t.

ciCacheNotifications('disable '(NotifyAll))

t

Disables all notifications and returns t.

ciCachep

ciCachep( 
g_value
)
=> t / nil

Description

Checks if an object is a valid constraint cache ID.

Arguments

Value Returned

Example

ciCachep(
       obj
       )

=> t

As shown in the example above, the object, obj is a valid constraint cache.

ciCachePurge

ciCachePurge( 
u_cache
)
=> t / nil

Description

Purges a constraint cellview from virtual memory.

Arguments

Value Returned

ciCacheSave

ciCacheSave( 
u_cache
)
=> t / nil

Description

Saves a constraint cellview.

Arguments

Value Returned

Example

ciCacheSave(ciGetCellView())

Saves the constraint cache associated with the current window.

ciCacheTopCellName

ciCacheConstraintCellName( 
u_cache
)
=> t_cellName

Description

Returns the top cell name of the specified constraint cache. The top library, cell, and view refers to the schematic or layout cellview. If the cache is associated with a configuration or physical configuration, it is the top cell specified by the configuration.

Arguments

Value Returned

Example

Return the top cell name of the current constraint cache:

ciCacheTopCellName(ciGetCellView())

=> "block1"

ciCacheTopLibName

ciCacheTopLibName( 
u_cache
)
=> t_libName

Description

Returns the top library name of the specified constraint cache. The top library, cell, and view refers to the schematic or layout cellview. If the cache is associated with a configuration or physical configuration, it is the top cell specified by the configuration.

Arguments

Value Returned

Example

Return the top library name of the current constraint cache:

ciCacheTopLibName(ciGetCellView())

=> "overview"

ciCacheTopViewName

ciCacheTopViewName( 
u_cache
)
=> t_viewName

Description

Returns the top view name of the specified constraint cache. The top library, cell, and view refers to the schematic or layout cellview. If the cache is associated with a configuration or physical configuration, it is the top cell specified by the configuration.

Arguments

Value Returned

Example

Return the top view name of the current constraint cache:

ciCacheTopViewName(ciGetCellView())

=> "schematic"

or

ciCacheTopViewName(ciGetCellView())

=> "layout"

ciCacheTransfer

ciCacheTransfer(
u_fromCache
u_toCache
?conTypes s_conTypes
)
=> t / nil

Description

Transfers constraints from the source cache to the specified target cache. The transfer can be restricted to constraints of a specified type. It cannot be used to transfer constraints between two schematics or two layouts.
Note: Before you run ciCacheTransfer, ensure that the schematic and layout windows are open in XL or a higher tier.

Arguments

Value Returned

Examples

Transfers all constraints from the schematic to the layout:

schCache = (ciGetCellView (window 2))

layCache = (ciGetCellView (window 3)) 

Transfers all constraints from the schematic cache to the layout cache:

(ciCacheTransfer schCache layCache)

Transfers all netClass constraints from the schematic cache to the layout cache:

(ciCacheTransfer schCache layCache ?conTypes 'netClass)

Transfer netClass and alignment constraints from the schematic cache to the layout cache:

(ciCacheTransfer schCache layCache ?conTypes '(netClass alignment))

ciCacheTransferSelection

ciCacheTransferSelection( 
u_fromCache
u_toCache
)
=> t / nil

Description

Transfers the selected constraints and templates from the source cache to the target cache in a session run in XL or above tier. If there are no selected constraints in the source cache, all the constraints and templates from the source cache are transferred to an editable target cache. When a constraint is transferred, the template within which it exists is also transferred along with all the other constraints inside the template. Note: Before you run ciCacheTransferSelection, ensure that the schematic and layout windows are open in XL or above tier. The Constraint Manager assistant should also be open in the window from where the constraints need to be transferred.

Arguments

Value Returned

Examples

Consider that there are two caches bound together in an XL-tier session: from is the source cache and to is the target cache opened in edit mode.

The source cache is bound to a design for which libname, cellname, viewname are 'ether_adc45n', 'adc_cascode_opamp', and 'schematic'.

The target cache is bound to the layout design associated to the source design.

;; For all constraints transfer

;;Deselect everything in all designs

(let ((currentSelection (hsmGetSelectedSet)))

(when currentSelection

(hsmDeselect ?spec currentSelection)))

;;Transfer all constraints/templates from the source 'from' to the target 'to'

(ciCacheTransferSelection from to)

;; For partial constraint transfer

;; Deselect everything in all design

(let ((currentSelection (hsmGetSelectedSet)))

(when currentSelection

(hsmDeselect ?spec currentSelection)))

;;Select the first constraint found in the source cache

(hsmSelect ?spec  `(("(ether_adc45n.adc_cascode_opamp:schematic)"  (constraint ,(car from->constraints)))))

;;Transfer the selected constraint

(ciCacheTransferSelection from to)

ciCacheViewName

ciCacheViewName( 
u_cache
)
=> t_viewName

Description

Returns the view name of the specified constraint cache. The cache library, cell, and view refers to the schematic, configuration, physical configuration, or layout view that the constraint cache is associated with.

Arguments

Value Returned

Example

Return the view name of the current constraint cache:

ciCacheViewName(ciGetCellView())

=> "physConfig"

ciCheckConstraints

ciCheckConstraints( 
d_cellViewID
)
=> t / nil

Description

Runs the constraint checker on the passed schematic or layout cellview if the cellview contains constraints.

When the constraint checker is called for a schematic cellview, the constraint and template status checks start automatically based on the current settings in the Constraints tab of the Schematic Rules Check Setup form.

When the constraint checker is called for a layout cellview, the checks are performed through the PVS-CV licensed tool. Therefore, make sure that the Phys_Ver_Sys_Const_Validator (license number 96300) license has been checked out in addition to the Layout license. For more information, refer to Check Constraints (Layout) in The Constraint Manager Assistant chapter of the Virtuoso Unified Custom Constraints User Guide.

Arguments

Value Returned

Example

ciCheckConstraints(geGetEditCellView())

ciCombineInstNetsPins

ciCombineInstNetsPins( 
l_instsNetsPins
)
=> l_result

Description

This function is used within Circuit Prospector constraint generator expressions to turn a list of sub-lists into a single simple list. When the instsNetsPins information is represented as a list of sub-lists there is one sub-list each for instances, nets, pins, and instTerms. In addition, this function effectively flattens the sub-lists to leave a combined list of all the instances, nets, pins, and instTerms without sub-lists. The flattened list is in a form suitable to be used as the member list for ciConCreate.

To turn the result into a more manageable disembodied property list (DPL), see ciSeparateInstsNetsPins.

Arguments

Value Returned

Example

instsNetsPinsAsSubLists = '(("/MN5" "/MN2") ("/n5" "/gnd!") nil nil) 

ciCombineInstNetsPins(instsNetsPinsAsSubLists)
(("/MN5" 'inst)
("/MN2" 'inst)
("/n5" 'net)
("/gnd!" 'net))

ciConAppendOneMember

ciConAppendOneMember( 
u_constraint
l_member
)
=> t / nil

Description

Appends one constraint member to the given contstraint. The new member is added in the last position in the member list.

Arguments

Value Returned

Example

ciConAppendOneMember(con '("MN12" inst))

Appends an extra instance, MN12, to a constraint.

ciConBaseName

ciConBaseName( 
t_constraintName
)
=> baseName

Description

Extracts and returns the basename from the specified constraint name. A constraint name consists of the basename and the counter added as a suffix. For example, in the constraint name, myConstraint_2, the basename is myConstraint and the counter is _2.

Arguments

Value Returned

Example

cache = ciGetCellView()

conName = car(cache~>constraints~>name)

newUniqueName = ciNextConName(cache ciConBaseName(conName))

ciConCallbackIsRegistered

ciConCallbackIsRegistered( 
?name t_name
?type t_type
)
=> t / nil

Description

Checks whether a constraint callback has been registered.
See also ciConRegisterCallback, ciConUnregisterCallback, and ciConUpdateCallback.

Arguments

Value Returned

Examples

• If myTransferCallback is not registered as a callback, the function returns nil.
  

  ciConCallbackIsRegistered(?name 'myTransferCallback ?type 'ciConTransferCallback)

  nil

• If myTransferCallback was registered as a callback of type ciConTransferCallback by using the ciConRegisterCallback function, the ciConCallbackIsRegistered function returns t. This means that the myTransferCallback callback will be called before and after the constraints are transferred.
  

  ;;Register the callback.

  ciConRegisterCallback(?name 'myTransferCallback ?type 'ciConTransferCallback)

  t

  ;;Later, you can verify whether the callback was registered successfully.

  ciConCallbackIsRegistered(?name 'myTransferCallback ?type 'ciConTransferCallback)

  t

ciConCreate

ciConCreate( 
u_cache
d_constraintType
[ ?members l_memberList ]
[ ?params l_parameterList ]
[ ?name g_constraintName ]
[ ?axis g_axisName ]
[ ?note g_constraintNote ]
[ ?verbose g_verbose ]
)
=> u_constraint / nil

Description

Creates a new constraint.

Arguments

Value Returned

Examples

1. Creating a Symmetry constraint:
   

   ciConCreate(
    cache 'symmetry 
    ?members list(list("M1" 'inst) list("M2" 'inst)) 
    ?axis "vSym"
   ) 

   (If the specified axis does not exist then you might need to create it using the ciAxisCreate() API).

2. Creating a Modgen constraint:
   

   modgen=ciConCreate(
    cache 'modgen 
    ?members list(list("M1" 'inst) list("M2" 'inst)) 
    ?params list(list("numRows" 1) list("numCols" 2)
    ))

   In the example above, a Modgen constraint is generated with basic parameters. The parameters specify the Modgen member instances and the size of the array. Default values are used for parameters that are not specified, for example the symbol assignments.
   
   In Schematic, m-factored instances are not expanded. Therefore, the parameters specified pertain to the unexpanded values, such as rows and columns.
   You can generate a Modgen constraint with member parameters (in Layout):

   ?members 
   list(
   list("M1.1" 'inst list(list("row" 0) list("col" 0) list("abutment" 1)))
   list("M1.2" 'inst list(list("row" 0) list("col" 1) list("abutment" 1)))
   list("M2.1" 'inst list(list("row" 0) list("col" 2) list("abutment" 1)))
   list("M2.2" 'inst list(list("row" 0) list("col" 3) list("abutment" 1)))
   )

   As specified above, m-factored instances are not expanded in the schematic, which makes it difficult to specify member parameters for the expanded instances. However, you may specify multiple instances in such cases as follows:

   list(
   list("M1" ‘inst list(list("row" 0) list("col" 0) list("abutment" 1)))
   list("M1" ‘inst list(list("row" 0) list("col" 1) list("abutment" 1)))
   list("M2" ‘inst list(list("row" 0) list("col" 2) list("abutment" 1)))
   list("M2" ‘inst list(list("row" 0) list("col" 3) list("abutment" 1)))
   )

   Here, both M1 and M2 have an m-factor of 2. Also, the row and column assignment for each instance is given.
   You can also specify Modgens with dummy devices and associated parameters (in schematic):

   memberList = list( 
   list("gpdk045/nmos2v/layout" master (("row" 0) ("col" 0) ("abutment" 1)
   list("dummyNetToUse" 1) ("dummyParams" "((fingers 1) (fw 4u) (l 400n))")))
   list("M3" inst (("row" 0) ("col" 1) ("abutment" 1)))
   list("M2" inst (("row" 0) ("col" 2) ("abutment" 1)))
   list("M2" inst (("row" 0) ("col" 3) ("abutment" 1)))
   list("M3" inst (("row" 0) ("col" 4) ("abutment" 1)))
   list("gpdk045/nmos2v/layout" master (("row" 0) ("col" 5) ("abutment" 1)
   list("dummyNetToUse" 1) ("dummyParams" "((fingers 1) (fw 4u) (l 400n))")))
   list("gpdk045/nmos2v/layout" master (("row" 1) ("col" 0) ("abutment" 1)
   list("dummyNetToUse" 1) ("dummyParams" "((fingers 1) (fw 4u) (l 400n))")))
   list("M2" inst (("row" 1) ("col" 1) ("abutment" 1)))
   list("M3" inst (("row" 1) ("col" 2) ("abutment" 1)))
   list("M3" inst (("row" 1) ("col" 3) ("abutment" 1)))
   list("M2" inst (("row" 1) ("col" 4) ("abutment" 1)))
   list("gpdk045/nmos2v/layout" master (("row" 1) ("col" 5) ("abutment" 1)
   list("dummyNetToUse" 1) ("dummyParams" "((fingers 1) (fw 4u) (l 400n))")))
   list("vdd!" net) ;;; dummy net
   )

   modgen2 = ciConCreate(
   cache 'modgen
   ?members memberList
   ?params list(
   list("numRows" 2)
   list("numCols" 6)
   
   list("pattern" "mapping (( M2 X)  (M3 Y))")

    ); list)
   )

   In the above example, the pattern parameter is used to map symbols to alphabets.

   ciConCreate( d_cache  'modgen
   ?members list(
   list("R0" 'inst list( list("row" 5 ) list("col" 0 ) list("orient" "R0" )))
   list("R0" 'inst list( list("row" 4 ) list("col" 0 ) list("orient" "MY" )))
   list("R0" 'inst list( list("row" 1 ) list("col" 0 ) list("orient" "R0" )))
   list("R1" 'inst list( list("row" 0 ) list("col" 0 ) list("orient" "MY" )))
   list("R1" 'inst list( list("row" 2 ) list("col" 0 ) list("orient" "R0" )))
   list("R1" 'inst list( list("row" 3 ) list("col" 0 ) list("orient" "MY" )))

   );list

   ?params list(
   list( "numRows" 6 )
   list( "numCols" 1 )
   
   );ciConCreate

   As shown in the example above, you can specify members and parameters for deciding the placement order of the Modgen devices that are generated from schematic and where both R0 and R1 have an s-factor of 3.
   As shown in the example below, to add a dummy that has a master different from its neighbor, specify the additional dummyParamSource parameter.

   ("gpdk045/nmos2v_3/layout" master (("row" 0) ("col" 11) ("abutment" 1) ("dummyParamSource" "default")

   To specify dummy parameters, use the additional dummyParams parameter, as shown below:

   ("gpdk045/nmos2v_3/layout" master (("row" 0) ("col" 11) ("abutment" 1) ("dummyParamSource" "default")  ("dummyParams" "((fingers 1) (fw 4u) (l 400n))")))

   If specifying a dummy different from the neighbor, the dummyParams should be specified. Otherwise, the values of the dummy parameters (length, width, fingers etc.) will be set to minimum.
3. Creating a constraint using another existing constraint as its member:
   Suppose there are three instances outside of modgens, and three modgens (each having some number of instances). If you want to create an orientation constraint of only six objects, which includes these three instances and three modgens, you can use a syntax like the one shown below:

   ciConCreate(
    cache ?type orientation 
    ?members list( list("M1" 'inst) list("Modgen1" 'modgen)) 
    ?params list(list("restrictTo" list("R0" "MY")))
   )

   
   
   This type of constraint creation is supported for the objects listed in the design_object_type section.

ciConCreateExpanded

ciConCreateExpanded( 
u_cache
d_constraintType
[ ?members l_memberList]
[ ?params l_parameterList ]
[ ?name t_constraintName ]
[ ?axis t_axisName ]
[ ?note g_constraintNote ]
[ ?verbose g_verbose ]
)
=> l_constraints / nil

Description

Expands vector names into groups of vector bit names in a constraint specific manner (when a constraint’s member list contains vector names). Constraints are then created for each vector bit name grouping.

Arguments

Value Returned

Example

ciConCreateExpanded(cache 'symmetry ?members list(list("MN1<0:4>" 'inst)))

=> list( symmetry("MN1<0>", "MN1<4>"), symmetry("MN1<1>", "MN1<3>"), symmetry("MN1<2>")

ciConCreateExpanded(cache 'cluster ?members list(list("MN1<0:4>" 'inst)))

=> list( cluster("MN1<0>", "MN1<1>", "MN1<2>", "MN1<3>", "MN1<4>")

ciConDelete

ciConDelete( 
u_constraint
)
=> t / nil

Description

Deletes a constraint. After deleting the constraint, the u_constraint will be invalid.

Arguments

Value Returned

ciConDeleteAll

ciConDeleteAll( 
l_constraints
d_cvID
)
=> t / nil

Description

Deletes the specified constraints in a cellview.

Arguments

Value Returned

Example

Deletes all the constraints in the current cellview.

when(window = hiGetCurrentWindow()
  when(cellView = geGetEditCellView(window)
       ciConDeleteAll(ciCacheGet(cellView)->constraints cellView)
  )
)

ciConFind

ciConFind( 
u_cache
t_constraintName
)
=> u_constraint / nil

Description

Finds a constraint in a given cache.

Arguments

Value Returned

ciConGetAxisName

ciConGetAxisName( 
u_constraint
)
=> t_axisName / nil

Description

Returns, for a given constraint, the axis name if one is associated with the given constraint.

Arguments

Value Returned

ciConGetCache

ciConGetCache( 
u_constraint
)
=> cache_ID

Description

Returns the constraint cache that contains the given constraint.

Arguments

Value Returned

Example

ciConGetCache(conId) => cacheId

ciConGetComment

ciConGetComment( 
u_constraint
)
=> t_comment / nil

Description

Returns the comment parameter of a constraint.

Arguments

Value Returned

ciConGetCreatedTime

ciConGetCreatedTime( 
u_constraint
)
=> constraint_created_time / nil

Description

Returns the created time of a constraint.

Arguments

Value Returned

ciConGetMembersOfType

ciConGetMembersOfType( 
g_con
s_type
)
=> l_filteredList

Description

Returns the constraint member list filtered by the passed member type.

Arguments

Value Returned

Example

ciConGetMembersOfType(modgen 'inst)

Returns the instance members of the modgen, but will not return the net members (if the modgen has members of type net).

ciConGetName

ciConGetName( 
u_constraint
)
=> t_constraintName

Description

Returns the name of a constraint.

Arguments

Value Returned

ciConGetNote

ciConGetNote( 
u_constraint
)
=> t_note / nil

Description

Returns the note parameter of a constraint.

Arguments

Value Returned

ciConGetOwner

ciConGetOwner( 
u_constraint
)
=> l_lcv / nil

Description

Returns the library name, cell name, and view name of the cell where the passed constraint was created.

Arguments

Value Returned

Example

ciConGetOwner(u_constraint) 

=> ("amsPLL" "vco" "schematic")

ciConGetPriority

ciConGetPriority( 
u_constraint
)
=> x_priority

Description

Returns the priority value of a constraint.

Arguments

Value Returned

ciConGetStatus

ciConGetStatus( 
u_constraint
)
=> symbol / nil

Description

Returns the status of a constraint.

See also ciConSetStatus.

Arguments

Value Returned

Example

ciConSetStatus(cc 'disabled t)

ciConGetStatus(cc)
disabled

ciConGetType

ciConGetType( 
u_constraint
)
=> s_constraintTypeName

Description

Returns the constraint type symbol.

Arguments

Value Returned

Example

ciConSetStatus(cc 'disabled t)

ciConIsInContext

ciConIsInContext( 
u_constraint
)
=> t / nil

Description

Returns the current context status of a constraint. A constraint is in context if all its members are in the database. For example, a net member can become out of context if the net is deleted from the database.

Arguments

Value Returned

ciConIsOutOfContext

ciConIsOutOfContext( 
u_constraint
)
=> t / nil

Description

Returns the current context status of a constraint. A constraint is out of context if one or more of its members are not in the database. For example, a net member can become out of context if the net is deleted from the database.

Arguments

Value Returned

ciConIsOverridden

ciConIsOverridden( 
u_constraint
)
=> t / nil

Description

Returns whether a constraint has been overridden.

Arguments

Value Returned

ciConIsWritable

ciConIsWritable( 
u_constraint
)
=> t / nil

Description

Returns whether the constraint is writable.

Arguments

Value Returned

ciConListMembers

ciConListMembers( 
u_constraint
[ g_includeParameters ]
[ g_includeDefaults ]
)
=> l_memberList / nil

Description

Returns a list of constraint members and their member parameters, if any.

Arguments

Value Returned

Example

(ciConListMembers con) ;;

Includes all parameters, including defaults.

(ciConListMembers con nil) ;;

Do not include parameters.

ciConListMemberNames

ciConListMemberNames( 
u_constraint
)
=> l_memberList / nil

Description

Returns a list of strings where each string is a constraint member name. This function will only return member names as opposed to ciConListMembers which returns tuples containing member names and types.

Arguments

Value Returned

ciConListParams

ciConListParams( 
u_constraint
[ g_includeDefaults ]
)
=> l_parameterList / nil

Description

Returns all parameters for a constraint.

Arguments

Value Returned

ciConListParamNames

ciConListParamNames( 
u_constraint
)
=> l_parameterNames / nil

Description

Returns the legal parameter names for a given constraint.

Arguments

Value Returned

ciConListTemplates

ciConListTemplates( 
u_constraint
)
=> l_templateList / nil

Description

Returns the list of templates of which the given constraint is a member.

Arguments

Value Returned