Product Documentation
Virtuoso Layout Suite SKILL Reference
Product Version IC23.1, November 2023

wspWSSPDefSetAllowedPatterns

wspWSSPDefSetAllowedPatterns(
d_cellViewId 
t_wsspDefName
l_patternNames
[ ?keepGroups g_keepGroups ]
)
=> t / nil

Description

Sets the allowed patterns for a widthSpacingSnapPatternDefs (WSSPDef) in the specified cellview. If the WSSPDef is enabled as global, the patterns apply to the global grid of the WSSPDef and to any regions for the WSSPDef for which the allowed patterns are not overridden.

This function sets a list of width spacing pattern (WSP) names as the allowed patterns. By default, this function deletes any allowed pattern groups. So, the set of allowed patterns is identical to the list of pattern names specified in the l_patternNames argument. You can set the allowed WSP and keep the allowed pattern groups using the g_keepGroups argument.

Arguments

d_cellViewId

Database ID of the cellview.

t_wsspDefName

The name of the WSSPDef.

l_patternNames

List of pattern names.

g_keepGroups

Specifies whether to keep the allowed pattern groups.

Value Returned

t

The allowed pattern is set for the WSSPDef.

nil

The allowed pattern is not set for the WSSPDef.

Example

wspWSSPDefSetAllowedPatterns(geGetEditCellView() "M1_H_90_80" list("WSP1"))

Return to top
 ⠀
X