hpcflow.sdk.core.parameters.SchemaOutput

class hpcflow.sdk.core.parameters.SchemaOutput(parameter, propagation_mode=ParameterPropagationMode.IMPLICIT)

Bases: SchemaParameter

A Parameter as outputted from particular task.

Methods

from_json_like	Make an instance of this class from JSON (or YAML) data.
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.

Attributes

input_or_output	Whether this is an input or output.
name	The name of the parameter.
propagation_mode	How this output propagates.
typ	The type code of the parameter.
parameter	The basic parameter this supplies.

Parameters:

• parameter (Parameter) –

• propagation_mode (ParameterPropagationMode) –

classmethod from_json_like(json_like, shared_data=None)

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

Parameters:

• json_like (Union[Dict, List]) – The data to deserialise.

• shared_data (Optional[Dict[str, ObjectList]]) – Shared context data.

Return type:

The deserialised object.

property input_or_output

Whether this is an input or output. Always output.

property name

The name of the parameter.

parameter: Parameter

The basic parameter this supplies.

propagation_mode: ParameterPropagationMode = 0

How this output propagates.

to_dict()

Serialize this object as a dictionary.

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.

property typ

The type code of the parameter.