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

gpeGetTrunkChains

gpeGetTrunkChains(
u_sandbox
[ ?anchorIndex n_anchorIndex ]
[ ?trunkDirection t_trunkDirection ]
[ ?offsetDirection t_offsetDirection ]
[ ?anchorPoint t_anchorPoint ]
[ ?verbose { t | nil } ]
)
=> l_trunksChains / nil

Description

Returns a list of trunk chains based on the specified identifiers. If none of the optional arguments are provided, all trunkChains available in the Modgen are listed. If multiple optional arguments are provided, the return value is the intersection of all the sets.

Arguments

u_sandbox

Specifies the Modgen sandbox object to query.

?anchorIndex n_anchorIndex

Specifies the row or column number for the anchor index.

?trunkDirection t_trunkDirection

Specifies the trunk direction. Valid values are vertical and horizontal.

?offsetDirection t_offsetDirection

Specifies the direction in which the offset is measured. Valid values are positive and negative.

?anchorPoint t_anchorpoint

Indicates the location of the anchor point. Valid values are topRight and bottomLeft.

?verbose { t | nil }

Controls the display of warning messages.

Value Returned

l_trunksChains

Returns a list of trunk chains. Each trunk chain is represented as a disembodied property list with anchor properties and list of trunk DPLs.

nil

The command was unsuccessful.

Example

Creates a trunk chain based on the specified arguments:

gpeGetTrunkChains(sandbox ?anchorIndex 1)

Return to top
 ⠀
X