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

gpeAddDummy

gpeAddDummy(
u_sandbox
t_direction
[ ?n x_rowsCols ]
[ ?dummyConfig l_dummyConfig ]
[ ?verbose { t | nil } ]
)
=> t / nil

Description

Adds the specified number of dummy rows or columns in the given direction to the specified Modgen sandbox object.

The dummy configuration entry, if specified, is used to configure the default entries. The master for the generated dummy entries is set to either the dummy configuration entry, which provides the master lib:cell:view specification, or the grid entries. Even if the dummy configuration entry specifies the source, the value is ignored and source is calculated based on the grid entries.

Arguments

u_sandbox

Specifies the Modgen sandbox object.

t_direction

Indicates the side of the sandbox grid to which dummy rows or columns must be added. Valid values are: top, bottom, left, and right.

?n x_rowCols

Specifies the number of dummy rows or columns to be added.

?dummyConfig l_dummyConfig

Specifies a DPL that indicates how the dummy entries must be configured.

?verbose { t | nil }

Controls the display of warning messages.

Value Returned

t

The dummy rows or columns were added.

nil

The command was unsuccessful.

Example

Defines a Modgen sandbox sbox, and then adds dummy rows to the left side of the sandbox:

sbox = gpeEditSandbox()
gpeAddDummy(sbox "left")
=> t

Return to top
 ⠀
X