beam_set

class granoo3.lib.beam_set

Bases: granoo3.lib.beam_list

an advanced named list of beam. The set supports automatic registering and unregistering of objects

Methods Summary

add(arg1, arg2)	add an item to the set
clear(arg1)	clear the set
clear_and_delete(arg1)	clear the set and delete all the referenced objects
contain(arg1, arg2)	check if the set contains an object
erase(arg1, arg2)	erase an item from the set
exist(arg1)	check if a set with a given ID exists
get(arg1)	get a given set with its string ID
get_id(arg1)	get the ID of the set
glob()	get the global set which references all the items
info(arg1)	get an info string
is_global(arg1)	check if the set is the global set
new(arg1)	build new object
set_id(arg1, arg2)	set the ID of the set
size(arg1)	get the size of the number, i.e, the number of referenced objects
smart_add(arg1, arg2)	add an item if the item is not already registered by the set
smart_erase(arg1, arg2)	erase an item if the item is registered

Methods Documentation

add((beam_set)arg1, (beam)arg2) → None[STATIC]

add an item to the set

clear((beam_set)arg1) → None[STATIC]

clear the set

clear_and_delete((beam_set)arg1) → None[STATIC]

clear the set and delete all the referenced objects

contain((beam_set)arg1, (beam)arg2) → bool[STATIC]

check if the set contains an object

erase((beam_set)arg1, (beam)arg2) → None[STATIC]

erase an item from the set

static exist((str)arg1) → bool[STATIC]

check if a set with a given ID exists

static get((str)arg1) → beam_set[STATIC]

get a given set with its string ID

get_id((beam_set)arg1) → str[STATIC]

get the ID of the set

static glob() → beam_set[STATIC]

get the global set which references all the items

info((beam_set)arg1) → str[STATIC]

get an info string

is_global((beam_set)arg1) → bool[STATIC]

check if the set is the global set

static new((str)arg1) → beam_set[STATIC]

build new object

set_id((beam_set)arg1, (str)arg2) → None[STATIC]

set the ID of the set

size((beam_set)arg1) → int[STATIC]

get the size of the number, i.e, the number of referenced objects

smart_add((beam_set)arg1, (beam)arg2) → None[STATIC]

add an item if the item is not already registered by the set

smart_erase((beam_set)arg1, (beam)arg2) → None[STATIC]

erase an item if the item is registered