zone.face.group

Syntax

s := zone.face.group(z,iside<,slot>)
zone.face.group(z,iside<,slot>) := s

Get/set the group name associated with the face identified by z and iside in slot slot. On set, the slot Default is assumed if not provided. On get, the return string encodes all group/slot assignments present on the face, in the format “SlotName=GroupName,SlotName=GroupName”. Use of the group logic is described in Groups.

A group pointer and a slot index may be provided instead of a string. This is more efficient, which may be significant if this call is being made a large number of times. See the group.find and group.find.slot functions.

Returns:

s - the group name in the slot, or “None” if no group was assigned

Accepts:

s - the group name to assign to the slot; if “None” is used, the group name will be cleared

Arguments:

z - a zone pointer

iside - side of the zone indicating the face, from 1 to 6

slot - an optional slot specification; if not given, the slot Default is assumed on set, on get all group/slot assignments are returned