iblviewer.collection

Classes

Collection

class Collection

Bases: collections.OrderedDict

current = None

current_key_id = 0

targets = []

get_current_key()

Get the current key that maps to the current object

set_current(target)

Set the current data

Parameters

key_or_id – A valid key or an int or the data

object itself

next(loop=False)

Set the next data as current one

Parameters

loop – Whether looping is enabled, which means that if next value is out of range, we start back at 0

previous(loop=False)

Set the previous data as current one

Parameters

loop – Whether looping is enabled, which means that if previous value is out of range, we go to -1 in a backward loop

store(data, data_id=None, replace_existing=True, set_current=False)

Store a data

Parameters

• data – data instance

• data_id – data id, a unique string if possible. If it’s not a unique string, it will be appended a number so that it’s unique.

• replace_existing – Whether any existing data with the same id is replaced or not

• set_current – Whether the newly stored data is set as the current one

Returns

The new data_id or None

get_or_create(data_id, data_class=None)

Get a data from a dictionary of data or create it if none found. This method works only with datas that have a name (str) property.

Parameters

• data_id – Either a data name or its id

• data_class – The class of the data

Returns

A data of type data_class

get_keys()

Get all data ids

find_keys(id_or_subid)

Get all ids/keys that have the given param as a substring

get_new_name(obj)

Get a new name derived from an object’s class name :return: String

get_name(*args)

Get given arguments separated by underscores as a single string :return: String