IDictionary#

class carb.dictionary.IDictionary#

Bases: pybind11_object

Methods

__init__(*args, **kwargs)

create_item(self, arg0, arg1, arg2)

destroy_item(self, arg0)

get(self, base_item[, path])

get_array_length(self, arg0)

get_as_bool(self, arg0)

get_as_float(self, arg0)

get_as_int(self, arg0)

get_as_string(self, base_item[, path])

get_dict_copy(self, base_item[, path])

Creates python object from the supplied dictionary at path (supplied item is unchanged).

get_item(self, base_item[, path])

get_item_child_by_index(self, arg0, arg1)

get_item_child_by_index_mutable(self, arg0, arg1)

get_item_child_count(self, arg0)

get_item_mutable(self, base_item[, path])

get_item_name(self, base_item[, path])

get_item_parent(self, arg0)

get_item_parent_mutable(self, arg0)

get_item_type(self, arg0)

get_preferred_array_type(self, arg0)

is_accessible_as(self, arg0, arg1)

is_accessible_as_array_of(self, arg0, arg1)

readLock(self, arg0)

set(self, item, path, value)

set_bool(self, arg0, arg1)

set_bool_array(self, arg0, arg1)

set_float(self, arg0, arg1)

set_float_array(self, arg0, arg1)

set_int(self, arg0, arg1)

set_int_array(self, arg0, arg1)

set_string(self, arg0, arg1)

set_string_array(self, arg0, arg1)

unlock(self, arg0)

update(self, arg0, arg1, arg2, arg3, arg4)

writeLock(self, arg0)

__init__(*args, **kwargs)#
create_item(
self: carb.dictionary._dictionary.IDictionary,
arg0: object,
arg1: str,
arg2: carb.dictionary._dictionary.ItemType,
) → carb.dictionary._dictionary.Item#
destroy_item(
self: carb.dictionary._dictionary.IDictionary,
arg0: carb.dictionary._dictionary.Item,
) → None#
get(
self: carb.dictionary._dictionary.IDictionary,
base_item: carb.dictionary._dictionary.Item,
path: str = '',
) → object#
get_array_length(
self: carb.dictionary._dictionary.IDictionary,
arg0: carb.dictionary._dictionary.Item,
) → int#
get_as_bool(
self: carb.dictionary._dictionary.IDictionary,
arg0: carb.dictionary._dictionary.Item,
) → bool#
get_as_float(
self: carb.dictionary._dictionary.IDictionary,
arg0: carb.dictionary._dictionary.Item,
) → float#
get_as_int(
self: carb.dictionary._dictionary.IDictionary,
arg0: carb.dictionary._dictionary.Item,
) → int#
get_as_string(
self: carb.dictionary._dictionary.IDictionary,
base_item: carb.dictionary._dictionary.Item,
path: str = '',
) → str#
get_dict_copy(
self: carb.dictionary._dictionary.IDictionary,
base_item: carb.dictionary._dictionary.Item,
path: str = '',
) → object#

Creates python object from the supplied dictionary at path (supplied item is unchanged). Item is calculated via the path relative to the base item.

Parameters:

  • base_item – The base item.

  • path – Path, relative to the base item - to the item

Returns:

Python object with copies of the item data.

get_item(
self: carb.dictionary._dictionary.IDictionary,
base_item: carb.dictionary._dictionary.Item,
path: str = '',
) → carb.dictionary._dictionary.Item#
get_item_child_by_index(
self: carb.dictionary._dictionary.IDictionary,
arg0: carb.dictionary._dictionary.Item,
arg1: int,
) → carb.dictionary._dictionary.Item#
get_item_child_by_index_mutable(
self: carb.dictionary._dictionary.IDictionary,
arg0: carb.dictionary._dictionary.Item,
arg1: int,
) → carb.dictionary._dictionary.Item#
get_item_child_count(
self: carb.dictionary._dictionary.IDictionary,
arg0: carb.dictionary._dictionary.Item,
) → int#
get_item_mutable(
self: carb.dictionary._dictionary.IDictionary,
base_item: carb.dictionary._dictionary.Item,
path: str = '',
) → carb.dictionary._dictionary.Item#
get_item_name(
self: carb.dictionary._dictionary.IDictionary,
base_item: carb.dictionary._dictionary.Item,
path: str = '',
) → str#
get_item_parent(
self: carb.dictionary._dictionary.IDictionary,
arg0: carb.dictionary._dictionary.Item,
) → carb.dictionary._dictionary.Item#
get_item_parent_mutable(
self: carb.dictionary._dictionary.IDictionary,
arg0: carb.dictionary._dictionary.Item,
) → carb.dictionary._dictionary.Item#
get_item_type(
self: carb.dictionary._dictionary.IDictionary,
arg0: carb.dictionary._dictionary.Item,
) → carb.dictionary._dictionary.ItemType#
get_preferred_array_type(
self: carb.dictionary._dictionary.IDictionary,
arg0: carb.dictionary._dictionary.Item,
) → carb.dictionary._dictionary.ItemType#
is_accessible_as(
self: carb.dictionary._dictionary.IDictionary,
arg0: carb.dictionary._dictionary.ItemType,
arg1: carb.dictionary._dictionary.Item,
) → bool#
is_accessible_as_array_of(
self: carb.dictionary._dictionary.IDictionary,
arg0: carb.dictionary._dictionary.ItemType,
arg1: carb.dictionary._dictionary.Item,
) → bool#
readLock(
self: carb.dictionary._dictionary.IDictionary,
arg0: carb.dictionary._dictionary.Item,
) → None#
set(
self: carb.dictionary._dictionary.IDictionary,
item: carb.dictionary._dictionary.Item,
path: str = '',
value: handle,
) → None#
set_bool(
self: carb.dictionary._dictionary.IDictionary,
arg0: carb.dictionary._dictionary.Item,
arg1: bool,
) → None#
set_bool_array(
self: carb.dictionary._dictionary.IDictionary,
arg0: carb.dictionary._dictionary.Item,
arg1: List[bool],
) → None#
set_float(
self: carb.dictionary._dictionary.IDictionary,
arg0: carb.dictionary._dictionary.Item,
arg1: float,
) → None#
set_float_array(
self: carb.dictionary._dictionary.IDictionary,
arg0: carb.dictionary._dictionary.Item,
arg1: List[float],
) → None#
set_int(
self: carb.dictionary._dictionary.IDictionary,
arg0: carb.dictionary._dictionary.Item,
arg1: int,
) → None#
set_int_array(
self: carb.dictionary._dictionary.IDictionary,
arg0: carb.dictionary._dictionary.Item,
arg1: List[int],
) → None#
set_string(
self: carb.dictionary._dictionary.IDictionary,
arg0: carb.dictionary._dictionary.Item,
arg1: str,
) → None#
set_string_array(
self: carb.dictionary._dictionary.IDictionary,
arg0: carb.dictionary._dictionary.Item,
arg1: List[str],
) → None#
unlock(
self: carb.dictionary._dictionary.IDictionary,
arg0: carb.dictionary._dictionary.Item,
) → None#
update(
self: carb.dictionary._dictionary.IDictionary,
arg0: carb.dictionary._dictionary.Item,
arg1: str,
arg2: carb.dictionary._dictionary.Item,
arg3: str,
arg4: object,
) → None#
writeLock(
self: carb.dictionary._dictionary.IDictionary,
arg0: carb.dictionary._dictionary.Item,
) → None#