hpcflow.sdk.typing.ParamSource

class hpcflow.sdk.typing.ParamSource

Bases: TypedDict

A parameter source descriptor.

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

type	Parameter type name.
EAR_ID	EAR ID.
task_insert_ID	Task insertion ID.
action_idx	Action index.
element_idx	Element index.
element_set_idx	Element set index.
run_idx	Element action run index.
sequence_idx	Sequence index.
task_idx	Task index.
value_class_method	Name of method used to create the parameter's value(s).

EAR_ID: int

EAR ID.

action_idx: int

Action index.

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

copy() → a shallow copy of D

element_idx: int

Element index.

element_set_idx: int

Element set index.

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

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.

run_idx: int

Element action run index.

sequence_idx: int

Sequence index.

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.

task_idx: int

Task index.

task_insert_ID: int

Task insertion ID.

type: str

Parameter type name.

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]

value_class_method: str

Name of method used to create the parameter’s value(s).

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