matflow.ParameterValue

class matflow.ParameterValue

Bases: ParameterValue

The value handler for a parameter.

Intended to be subclassed.

Methods

dump_element_group_to_HDF5_group	Write a list (from an element group) of parameter values to an HDF5 group.
dump_to_HDF5_group	Write this parameter value to an HDF5 group.
prepare_JSON_dump	Prepare this parameter value for serialisation as JSON.
save_from_HDF5_group	Extract a parameter value from an HDF5 group.
save_from_JSON	Extract a parameter value from JSON data.
to_dict	Serialise this parameter value as a dictionary.

classmethod dump_element_group_to_HDF5_group(objs, group)

Write a list (from an element group) of parameter values to an HDF5 group.

Parameters:

• objs (list[ParameterValue]) –

• group (Group) –

dump_to_HDF5_group(group)

Write this parameter value to an HDF5 group.

Parameters:

group (Group) –

prepare_JSON_dump()

Prepare this parameter value for serialisation as JSON.

Return type:

dict[str, Any]

classmethod save_from_HDF5_group(group, param_id, workflow)

Extract a parameter value from an HDF5 group.

Parameters:

• group (Group) –

• param_id (int) –

• workflow (Workflow) –

classmethod save_from_JSON(data, param_id, workflow)

Extract a parameter value from JSON data.

Parameters:

• param_id (int | list[int]) –

• workflow (Workflow) –

to_dict()

Serialise this parameter value as a dictionary.

Return type:

dict[str, Any]