hpcflow.app.SchemaOutput#
- class hpcflow.app.SchemaOutput(parameter, propagation_mode=ParameterPropagationMode.IMPLICIT)#
Bases:
SchemaOutput
A Parameter as outputted from particular task.
Methods
Make an instance of this class from JSON (or YAML) data.
Serialize this object as a dictionary.
Serialize this object as an object structure that can be trivially converted to JSON.
Attributes
Whether this is an input or output.
The name of the parameter.
How this output propagates.
The type code of the parameter.
The basic parameter this supplies.
- Parameters:
parameter (Parameter) –
propagation_mode (ParameterPropagationMode) –
- app = BaseApp(name='hpcFlow', version='0.2.0a180')#
- 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.
- 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.