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

gpeSetMap

gpeSetMap(
u_sandbox
g_map
[ ?verbose { t | nil } ]
)
=> t / nil

Description

Updates the symbol mapping without using individual map entries. When a sandbox map DPL is specified, the current mapping of instances is replaced with the mapping specified by the provided map DPL. Symbol mapping can also be updated by providing a list of lists of strings. The first string in each sub-list holds the schematic name of an instance and the second string holds its updated mapping.

Arguments

u_sandbox

Specifies the Modgen sandbox object.

g_map

Specifies the new mapping information. The value can be either a Modgen sandbox map DPL or a list of lists of strings, where the first string is the schematic name and the second string is the layout name.

Example: list(list("NM0" "A") list("NM1" "B") list("NM2" "C"))

?verbose { t | nil }

Controls the display of warning messages.

Value Returned

t

Indicates that the Modgen sandbox map DPL was set or updated.

nil

Indicates that the Modgen sandbox map DPL could not be set or updated.

Example

Here, sbox is assigned to the value returned by gpeEditSandbox. map1 and map2 identify Modgen sandbox map DPLs. The value for map1 is determined by calling gpeGetMap using sbox as the argument. The value for map2 is assigned manually.

sbox = gpeEditSandbox()
=> pe:#####
map1 = gpeGetMap(sbox)
map2 = list( list("NM0" "A") list("NM1" "B") list("NM2" "C") )

In the following example, sbox and map2 values (defined above) are passed as arguments to gpeSetMap:

gpeSetMap(sbox map2)
=> t

In the following example, sbox and map1 values (defined above) are passed as arguments to gpeSetMap:

gpeSetMap(sbox map1)
=> t

Return to top
 ⠀
X