contact.groupmap

Syntax

m := contact.groupmap(s<,slot,stype>)

Get active contacts that belong to a group. A map is returned where the keys are the active contact ID numbers and the values are the active contact pointers. The arguments s and slot may be specified as strings or indices*. If slot is not specified, then all slots are queried.

One may optionally specify a contact class (i.e., ‘ball-ball’) or type (i.e., ‘mechanical’) as the last argument.

Returns:

Returns:	m - map of active contacts
Arguments:	s - group name or index* slot - slot name or index* stype - optional contact class name or type

m - map of active contacts

Arguments:

s - group name or index*

slot - slot name or index*

stype - optional contact class name or type

Note

*Use the group.find and group.find.slot intrinsics to obtain group and slot indices, respectively, and for further information.

Use of the group logic is described in Groups.