Attach

class itasca.attach.Attach

Objects of this type should not be created (instantiated) directly in Python. Use the module functions that return instances of this type.

extra(slot: int) → any.

Get the attach extra data in the given slot.

group([slot: str]) → str.

Get the attach group name in a given slot.

group_remove(group_name: str) → bool.

Remove from the given group from all group slots of the attach. One argument of type string, giving the group name, is required. The return value is a bool which is True if the group was removed from any slot, otherwise False.

groups() → {slot: group_name}.

Get a dictionary describing which groups this attach is part of. The keys of the dictionary are the slot names and the values are the group names.

id() → int.

Get the attach id.

in_group(group_name: str[, slot: str]) → bool.

Test if the attach is part of a given group. If the optional argument slot is given, only that slot is searched. Otherwise, all group slots are searched.

set_extra(slot: int, value: any) → None.

Set the attach extra data in the given slot.

set_group(group_name: str[, slot: str]) → None.

Set the attach group name in a given slot.

valid() → bool.

Returns True if this attach is live.