hpcflow.sdk.core.object_list.ParametersList#

class hpcflow.sdk.core.object_list.ParametersList(_objects)#

A list-like container for parameters with dot-notation access by parameter type.

Parameters:: _objects (list[Parameter]) – The parameters in this list.

Methods

`add_object`	Add an object to this list.
`add_objects`	Add multiple objects to the list.
`from_json_like`	Make an instance of this class from JSON (or YAML) data.
`get`	Get an object from this list that matches the given criteria.
`get_all`	Overridden to provide a default Parameter object if none exists.
`list_attrs`	Get a tuple of the unique access-attribute values of the constituent objects.
`to_dict`	Serialize this object as a dictionary.
`to_json_like`	Serialize this object as an object structure that can be trivially converted to JSON.

add_object(obj, index=-1, skip_duplicates=False)#: Add an object to this list.

add_objects(objs, index=-1, skip_duplicates=False)#: Add multiple objects to the list.

classmethod from_json_like(json_like, shared_data=None, is_hashed=False)#

Make an instance of this class from JSON (or YAML) data.

Parameters:

json_like – The data to deserialise.
shared_data – Shared context data.
is_hashed (bool) – If True, accept a dict whose keys are hashes of the dict values.

Return type:

The deserialised object.

get(access_attribute_value=None, **kwargs)#: Get an object from this list that matches the given criteria.

get_all(access_attribute_value=None, **kwargs)#: Overridden to provide a default Parameter object if none exists.

list_attrs()#: Get a tuple of the unique access-attribute values of the constituent objects.

to_json_like(dct=None, shared_data=None, exclude=None, path=None)#: Serialize this object as an object structure that can be trivially converted to JSON. Note that YAML can also be produced from the result of this method; it just requires a different final serialization step.