hpcflow.sdk.persistence.zarr.ZarrStoreElementIter#

class hpcflow.sdk.persistence.zarr.ZarrStoreElementIter(id_: 'int', is_pending: 'bool', element_ID: 'int', EARs_initialised: 'bool', EAR_IDs: 'Dict[int, List[int]]', data_idx: 'Dict[str, int]', schema_parameters: 'List[str]', loop_idx: 'Dict[str, int]' = <factory>)#

Bases: StoreElementIter

Methods

`append_EAR_IDs`	Return a copy, with additional EAR IDs.
`decode`	Initialise a StoreElementIter from persistent element iteration data
`encode`	Prepare store element iteration data for the persistent store.
`set_EARs_initialised`	Return a copy with EARs_initialised set to True.
`to_dict`	Prepare data for the user-facing ElementIteration object.
`update_loop_idx`	Return a copy, with the loop index updated.

Attributes

`id_`
`is_pending`
`element_ID`
`EARs_initialised`
`EAR_IDs`
`data_idx`
`schema_parameters`
`loop_idx`

Parameters:

id_ (int) –
is_pending (bool) –
element_ID (int) –
EARs_initialised (bool) –
EAR_IDs (Dict[int, List[int]]) –
data_idx (Dict[str, int]) –
schema_parameters (List[str]) –
loop_idx (Dict[str, int]) –

EAR_IDs: Dict[int, List[int]]#

EARs_initialised: bool#

append_EAR_IDs(pend_IDs)#

Return a copy, with additional EAR IDs.

Parameters:

self (AnySElementIter) –
pend_IDs (Dict[int, List[int]]) –

Return type:

AnySElementIter

data_idx: Dict[str, int]#

classmethod decode(iter_dat, attrs)#

Initialise a StoreElementIter from persistent element iteration data

Parameters:

iter_dat (List) –
attrs (Dict) –

Return type:

StoreElementIter

element_ID: int#

encode(attrs)#

Prepare store element iteration data for the persistent store.

This method mutates attrs.

Parameters:: attrs (Dict) –
Return type:: List

id_: int#

is_pending: bool#

loop_idx: Dict[str, int]#

schema_parameters: List[str]#

set_EARs_initialised()#

Return a copy with EARs_initialised set to True.

Parameters:: self (AnySElementIter) –
Return type:: AnySElementIter

to_dict(EARs)#: Prepare data for the user-facing ElementIteration object.

update_loop_idx(loop_idx)#

Return a copy, with the loop index updated.

Parameters:

self (AnySElementIter) –
loop_idx (Dict[str, int]) –

Return type:

AnySElementIter