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

wspCreateWSP

wspCreateWSP (
d_cellViewId 
t_name 
[ ?offset n_offset ] 
[ ?repeatOffset g_repeatOffset ] 
[ ?shiftColor g_shiftColor ] 
[ ?allowedRepeatMode t_allowedRepeatMode ]
[ ?defaultRepeatMode t_defaultRepeatMode ]
[ ?wsspDef t_wsspDefName ]
n_width n_space [ repeat n_repeats ] [ wireType t_wireType ] [ color n_mask ] [ displayPacket t_displayPacket ]
)
=> d_wspId

Description

Creates a width spacing pattern (WSP) in the specified cellview. If the WSP already exists, it is replaced. This function creates simple WSPs and not nested lists. It checks the shapes for width, color, and wire type conformance to the active WSP on the specified layer or set. The active WSP can be for the global grid or a pattern region.

Arguments

d_cellViewId

Database ID of the cellview in which the WSP is created.

t_name

Name of the WSP.

?offset n_offset

Center-line offset of the first track. The default is 0.0.

?repeatOffset g_repeatOffset

The offset applied each time the pattern repeats. The default is t.

?shiftColor g_shiftColor

The track color shift when the pattern repeats. The default is nil.

?allowedRepeatMode t_allowedRepeatMode

Specifies the way the pattern can repeat. The choices are any, none, steppedOnly, or flippedOnly. The default is any.

?defaultRepeatMode t_defaultRepeatMode

Specifies the default repeat mode when the allowedRepeatMode is specified. The choices are noRepeat, stepped, flippedStartsWithOdd, or flippedStartsWithEven. The default is noRepeat.

?wsspDef t_wsspDefName

Specifies the pattern as allowed for the WSSPDef. If the WSSPDef was previously created without a default active, its creation is deferred and it is created along with this WSP.

n_width

Specifies the width of the track.

n_space

Specifies the center-line space to the next track.

n_repeats

Specifies the number of times the track repeats. The default is 1.

t_wireType

Specifies the type of wire.

t_color

Specifies the color of the track. The valid values are 1, 2, and 3.

t_displayPacket

Specifies the display packet name to be used for displaying the specified WSP track.

Value Returned

d_wspId

Database ID of the WSP.

Examples

wspCreateWSP(cv 
             "test" 
             ?offset 0.01 
             ?shiftColor t 
             ?allowedRepeatMode "steppedOnly" 
             ?defaultRepeatMode "stepped"
             0.030        0.060
             0.031      0.061  "repeat:2" 
    0.032   0.062     "color:1"            
             0.033      0.063           "wireType:vss1" "color:2"
    0.034   0.064   "color:1"      "displayPacket:myCustomTrackPacket"
    )    

Return to top
 ⠀
X