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

gpeCreateTrunkChain

gpeCreateTrunkChain(
?trunks l_trunks
?anchorIndex n_anchorIndex
[ ?trunkDirection { horizontal | vertical } ]
[ ?offsetDirection { positive | negative } ]
[ ?anchorPoint t_anchorPoint ]
[ ?anchorReference t_anchorReference ]
[ ?centerInChannel { t | nil } ]
[ ?template l_template ]
[ ?verbose { t | nil } ]
)
=> g_trunkChainObject / nil

Description

Creates trunk chain entries based on the specified identifiers from the sandbox. It is recommended to use only one of the optional arguments. If none of the optional arguments is provided, all trunk chains available in the Modgen are listed. If multiple optional arguments are provided, the return value is the intersection of all the sets.

Arguments

?trunks l_trunks

Lists the trunk entries for which trunk chains must be created.

?anchorIndex n_anchorIndex

Specifies the row or column number for placing the anchor index.

?trunkDirection { horizontal | vertical }

Specifies the trunk direction.

?offsetDirection { positive | negative }

Specifies the default trunk offset direction.

?anchorPoint t_anchorPoint

Specifies the location of the anchor point on the anchor instance. Valid values are topRight, bottomLeft, and center.

?anchorReference t_anchorReference

Specifies a reference layer or layer-purpose pair on the anchor on which the trunk chain must start.

?centerInChannel { t | nil }

Specifies whether the trunk chain must be centered in the channel indicated by the ?anchorIndex value. When set to nil, the ?offset value specified in the call to the gpeCreateTrunkEntries function, which was used to create the trunks, is used to space the trunk chain from the anchor instance.

?template l_template

Specifies a trunk chain entry, which serves as a template.

?verbose { t | nil }

Controls the display of warning messages.

Value Returned

g_trunkChainObject

Returns the list of Modgen sandbox trunk chains that were created. 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.

gpeCreateTrunkChain(?trunks trunks ?anchorIndex 0 ?trunkDirection "horizontal" ?offsetDirection "positive" ?anchorPoint "topRight" ?anchorReference "Metal1")

Return to top
 ⠀
X