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

gpeCreateGridEntry

gpeCreateGridEntry(
[ ?row x_row ]
[ ?col x_col ]
[ ?name t_name ]
[ ?dummyConfig l_dummyConfig ]
[ ?orientation t_orientation ]
[ ?hAlign l_hAlign ]
[ ?vAlign l_vAlign ]
[ ?template l_template ]
[ ?verbose { t | nil } ]
)
=> l_gridEntry / nil

Description

Creates a Modgen sandbox grid entry DPL for an instance or a dummy. A grid entry can represent either an instance or a dummy.

Arguments

?row x_row

Specifies the grid entry row index.

?col x_col

Specifies the grid entry column index.

?name t_name

Specifies the name of the symbol or schematic that contains the instance.

?dummyConfig l_dummyConfig

Specifies the dummy configuration returned by running the gpeCreateDummyConfig function.

Specify either ?name or ?dummyConfig because these arguments are mutually exclusive.

?orientation t_orientation

Specifies the orientation of the entry. Valid values are: "R0", "R90", "R180", "R270", "MX", "MY", "MXR90", "MYR90".

?hAlign l_hAlign

Indicates a horizontal alignment of the instance returned by running gpeCreateAlignment.

?vAlign l_vAlign

Indicates a vertical alignment of the instance returned by running gpeCreateAlignment.

?template l_template

Specifies the value for arguments, if not provided.

?verbose { t | nil }

Controls the display of warning messages.

Value Returned

l_gridEntry

Returns the Modgen sandbox grid entry DPL created.

nil

Could not create a Modgen sandbox grid entry DPL.

Example

In the following examples, Modgen sandbox grid entry DPLs are created based on the specified arguments. Here, a grid entry DPL is created for an instance with name M9:

gridEntry = gpeCreateGridEntry(?row 0 ?col 0 ?name "M9" ?orientation "R270")
=> (nil name "M9" col 0 row 0 orient "R270")

Here, a grid entry DPL is created for a dummy, which is configured according to the dummyConfig DPL:

dummyConfig = gpeCreateDummyConfig(?source '(0 1))
=> (nil src_index (0 1) type "lcv")
dummyEntry = gpeCreateGridEntry(?row 0 ?col 0 ?dummyConfig dummyConfig)
=> (nil col 0 row 0 symbol "*" type "dummy" dummyConfig (nil src_index (0 1) type "lcv"))

Return to top
 ⠀
X