hpcflow.sdk.persistence.base.StoreElement

class hpcflow.sdk.persistence.base.StoreElement(id_, is_pending, index, es_idx, seq_idx, src_idx, task_ID, iteration_IDs)

Bases: object

Parameters:

• index (int) – Index of the element within its parent task.

• iteration_IDs (List[int]) – IDs of element-iterations that belong to this element.

• id_ (int) –

• is_pending (bool) –

• es_idx (int) –

• seq_idx (Dict[str, int]) –

• src_idx (Dict[str, int]) –

• task_ID (int) –

Methods

append_iteration_IDs	Return a copy, with additional iteration IDs.
decode	Initialise a StoreElement from store element data
encode	Prepare store element data for the persistent store.
to_dict	Prepare data for the user-facing Element object.

Attributes

id_
is_pending
index
es_idx
seq_idx
src_idx
task_ID
iteration_IDs

append_iteration_IDs(pend_IDs)

Return a copy, with additional iteration IDs.

Parameters:

• self (AnySElement) –

• pend_IDs (List[int]) –

Return type:

AnySElement

classmethod decode(elem_dat)

Initialise a StoreElement from store element data

Parameters:

elem_dat (Dict) –

Return type:

StoreElement

encode()

Prepare store element data for the persistent store.

Return type:

Dict

es_idx: int

id_: int

index: int

is_pending: bool

iteration_IDs: List[int]

seq_idx: Dict[str, int]

src_idx: Dict[str, int]

task_ID: int

to_dict(iters)

Prepare data for the user-facing Element object.