hpcflow.sdk.persistence.types.IterMeta

class hpcflow.sdk.persistence.types.IterMeta

Bases: TypedDict

The kwargs supported for a StoreElementIter.

Methods

clear
copy
fromkeys	Create a new dictionary with keys from iterable and values set to value.
get	Return the value for key if key is in the dictionary, else default.
items
keys
pop	If the key is not found, return the default if given; otherwise, raise a KeyError.
popitem	Remove and return a (key, value) pair as a 2-tuple.
setdefault	Insert key with a value of default if key is not in the dictionary.
update	If E is present and has a .keys() method, then does: for k in E.keys(): D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]
values

Attributes

data_idx	The index of the iteration.
EAR_IDs	The EARs associated with the iteration.
EARs_initialised	Whether the EARs have been initialised.
element_ID	The ID of the element.
loop_idx	The loops containing the iteration.
schema_parameters	The schema parameters being iterated over.

EAR_IDs: dict[int, list[int]]

The EARs associated with the iteration.

EARs_initialised: bool

Whether the EARs have been initialised.

clear() → None.  Remove all items from D.

copy() → a shallow copy of D

data_idx: DataIndex

The index of the iteration.

element_ID: int

The ID of the element.

fromkeys(value=None, /)

Create a new dictionary with keys from iterable and values set to value.

get(key, default=None, /)

Return the value for key if key is in the dictionary, else default.

items() → a set-like object providing a view on D's items

keys() → a set-like object providing a view on D's keys

loop_idx: dict[str, int]

The loops containing the iteration.

pop(k[, d]) → v, remove specified key and return the corresponding value.

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem()

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

schema_parameters: list[str]

The schema parameters being iterated over.

setdefault(key, default=None, /)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update([E, ]**F) → None.  Update D from mapping/iterable E and F.

If E is present and has a .keys() method, then does: for k in E.keys(): D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values() → an object providing a view on D's values