gpeCreateMatchGroupEntry
gpeCreateMatchGroupEntry(
d_matchGroupID
[ ?twigMatchType t_twigMatchType ]
[ ?trunkMatchType t_trunkMatchType ]
[ ?verbose { t | nil } ]
)
=> t / nil
Description
Creates a DPL that represents a matched group. The DPL can then be added to a Modgen sandbox object using the gpeAddMatchGroups function.
Arguments
|
d_matchGroupID
|
Specifies the ID of the matched group for which a matched group entry must be created.
|
|
?twigMatchType t_twigMatchType
|
|
|
Specifies the criteria based on which twigs must be matched. Valid values are:
-
lengthenOnly: Matching is done by lengthening the geometries associated with the twigs. -
widenOnly: Matching is done by widening the geometries associated with the twigs. -
lengthenFirst: Matching is done by first attempting to lengthen the geometries. If that is unsuccessful, then the geometries are widened. -
widenFirst: Matching is done by first attempting to widen the geometries. If that is unsuccessful, then the geometries are lengthened.
|
|
?trunkMatchType t_trunkMatchType
|
|
|
Specifies the criteria based on which trunks must be matched. Valid value is:
-
matchLength: Matching is done by adjusting the length of the selected trunks such that they are equal.
|
|
?verbose { t | nil }
|
|
|
Controls the display of warning messages.
|
Value Returned
|
t
|
A matched group entry was created.
|
|
nil
|
The command was unsuccessful.
|
Example
In the following example, matched group entries mg1 and mg2 are created. Both twig and trunk match types are specified for mg1, whereas only the twig match type is specified for mg2. These matched groups are then passed as parameters for gpeAddMatchGroups.
mg1 = gpeCreateMatchGroupEntry(0 ?twigMatchType "widenFirst"
?trunkMatchType "matchLength")
mg2 = gpeCreateMatchGroupEntry(1 ?twigMatchType "widenOnly")
gpeAddMatchGroups(sandbox list(mg1 mg2))
Return to top
