Interface
-
class
itasca.interface.
Interface
- Objects of this type should not be created (instantiated) directly in Python. Use the module functions that return instances of this type.
-
element_find
(id: int) → Interface element. Get interface element with given ID number.
-
elements
() → Interface elements iterator object. Get an interface element interator object.
-
extra
(slot: int) → any. Get the interface extra data in the given slot.
-
group
([slot: str or int]) → str. Get the interface group name in a given slot.
-
group_remove
(group_name: str or int[, slot: str or int]) → bool. Remove from the given group from all group slots of the interface. 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 interface is part of. The keys of the dictionary are the slot names and the values are the group names.
-
id
() → int. Get the interface id.
-
in_group
(group_name: str or int[, slot: str or int]) → bool. Test if the interface is part of a given group. If the optional argument slot is given, only that slot is searched. Otherwise, all group slots are searched.
-
name
() → str or None. Get the interface name.
-
node_find
(id: int) → Interface node. Get interface node with given ID number.
-
nodes
() → Interface nodes iterator object. Get an interface node iterator object.
-
set_extra
(slot: int, value: any) → None. Set the interface extra data in the given slot.
-
set_group
(group_name: str or int[, slot: str or int]) → None. Set the interface group name in a given slot.
-
valid
() → bool. Returns True if this interface is live.
-
Was this helpful? ... | PFC © 2021, Itasca | Updated: Feb 25, 2024 |