gpeGetGridEntries

gpeGetGridEntries(
u_sandbox
[ ?row x_row ]
[ ?col x_col ]
[ ?name t_name ]
[ ?verbose { t | nil } ]
)
=> l_gridEntries / nil

Description

Returns a list of grid entries from the Modgen sandbox that match the specified identifiers. If you specify multiple identifiers, then the function returns a list of instances that satisfy all requirements.

Arguments

u_sandbox	Specifies the Modgen sandbox object.
?row x_row	Identifies the row from which all l_gridEntries must be retrieved.
?col x_col	Identifies the column from which all l_gridEntries must be retrieved. You can use this argument along with ?row to get a single entry.
?name t_name
	Specifies the symbol, schematic, or layout name from which l_gridEntries must be retrieved.
?verbose { t | nil }
	Controls the display of warning messages.

Value Returned

l_gridEntries	Returns one or more Modgen sandbox grid entries in the form of a DPL with parameters: col, row, type, orient, symbol, name, inst, dummyConfig, hAlign, vAlign.
nil	The command was unsuccessful.

Example

In the following example, the value of sb is determined by calling gpeEditSandbox. This value is then passed as an argument in three different examples. In the first example, the Modgen sandbox object and the row and column values are specified.

sb = gpeEditSandbox()

gpeGetGridEntries(sb ?row 0 ?col 1)

In the following example, the argument list includes the Modgen sandbox object and the schematic name.

gpeGetGridEntries(sb ?name "PM1.18")

Here, the argument list includes the Modgen sandbox object and the row number.

gpeGetGridEntries(sb ?row 1)

In the following example, the argument list includes the Modgen sandbox object and the column number.

gpeGetGridEntries(sb ?col 1)

Return to top