gpeCreateAbutEntries
gpeCreateAbutEntries(
[ ?rows l_rows ]
[ ?cols l_columns ]
[ ?abutType l_abutType ]
[ ?template l_template ]
[ ?verbose { t | nil } ]
)
=> l_abutEntry / nil
Description
Creates a list of abut entries that are in line with the information in the arguments.
Arguments
|
?rows l_rows
|
|
|
Specifies the rows to be abutted. Valid formats are:
-
An integer representing a specific row.
-
A list or a range of rows. Each entry in the list must either be an integer or a list of one or two integers.
Examples:
rows = list(1 3 5) ==> rows 1, 3, and 5 are abutted.
rows = list( list(0 4) ) ==> rows 0, 1, 2, 3, and 4 are abutted.
rows = list( list(5) ) ==> row 5 is abutted.
rows = list(0 list(1 3) list(4) ) => rows 0, 1, 2, 3, 4 and 5 are abutted.
If not specified, all rows are abutted.
|
|
?cols l_columns
|
|
|
Specifies the columns to be abutted. It is a list of lists of integers that specify the range (start end) of the columns to be abutted. In the following example, columns 0 to 2 and columns 5 to 7 are abutted:
cols = list( list(0 2) list(5 7) )
If not specified, all columns are abutted.
|
|
?abutType l_abutType
|
|
|
Specifies how abutment must be performed. You typically create the abutType using the gpeCreateAbutType API. Valid values are either a DPL or a string that specifies an abutment type that is present in the placement. If an invalid abutment type string is provided, the default type is used.
|
|
?template l_template
|
|
|
Specifies a Modgen abutment entry, which serves as a template.
|
|
?verbose { t | nil }
|
Controls the display of warning messages.
|
Value Returned
|
l_abutEntry
|
A list of abutment entries. Each abutment entry is a DPL.
|
|
nil
|
Could not create a Modgen sandbox abutment entry.
|
Example
Creates a Modgen sandbox abutment entry with the specified arguments:
gpeCreateAbutEntries(?rows list(0:6) ?cols list(list(0 6)))
Return to top
