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

gpeAbutGridEntries

gpeAbutGridEntries(
u_sandbox
l_gridEntries
[ ?abutType { x_abutType | t_abutTypeName } ]
[ ?verbose { t | nil } ]
)
=> t / nil

Description

Abuts the specified list of instances or indexes using the given abutment type in the given sandbox object.

Arguments

u_sandbox

Specifies the Modgen sandbox object.

l_gridEntries

Includes a list of entries that are specified by indexes.

Example: '( '(1 1) '(1 2) ...)

[ ?abutType { x_abutType | t_abutTypeName } ]

Specifies the abutment type, which is either a number or the abutment type name. If not specified, the default abutment type is used.

?verbose { t | nil }

Controls the display of warning messages.

Value Returned

t

The instances were abutted.

nil

The command was unsuccessful.

Example

Makes the Modgen sandbox sb editable and turns on the synchronization mode. gpeAbutGridEntires is then used to abut a specified list of instances.

> sb = gpeEditSandbox()
> gpeAbutGridEntries(sb list(list(1 0) list(1 1)) ?abutType "type0" ?verbose t)
> gpeSyncSandbox(sb)

Return to top
 ⠀
X