Product Documentation
Virtuoso Studio Design Environment SKILL Reference
Product Version IC23.1, November 2023

dbCreateGroup

dbCreateGroup( 
d_cellViewID 
t_groupName 
l_groupType 
[ t_groupDefName ]
) 
=> d_group / nil

Description

Creates a group of the specified group definition in the specified cellview. If a group definition is not specified, a traditional, unrestricted group is created, which allows all types of objects and all types of groups as members and can exist in any database.

Arguments

d_cellViewID

The database object.

t_groupName

Name of the group to be created.

l_groupType

List of group attributes.
Valid values:
collection or set—to define the attribute groupType.

ordered or unordered—to define the attribute ordered.

nonUniqueName or uniqueName—to define the attribute uniqueName.

deleteNever, deleteFirst, or deleteLast—to define the attribute deleteWhen.

For more information on valid values of l_groupType see Database Access Function Argument Types.

t_groupDefName

Name of a group definition. The specified group definition must already exist. If the specified groupDef is an invalid string or does not exist, the function fails to create the group and returns nil.

Built-in groupDefs include: unrestricted, diffNetPair, net, matchedNet, nestedNet, and symmtericNet

Value Returned

d_group

The dbObject of the group if the creation is successful.

nil

The group is not created.

Examples

dbCreateGroup(cv "myGroup1" list("set" "ordered"))

Creates the DM4 group myGroup1 of the groupDef unrestricted in the cv cellview with the specified attributes.

dbCreateGroup(cv "myGroup2" list("collection" "ordered") "net")

Creates the DM4 group myGroup2 of the groupDef net in the cv cellview with the specified attributes.

Related Topics

Group Creation and Modification Functions


Return to top
 ⠀
X