ProcessProxy

Functions

__init__

Initialize self. See help(type(self)) for accurate signature.

process_model : ProcessModel

add_dynamic_input_port

Add a dynamic input port to the process.

port_spec_dto : IOSpecDTO | None

Optional specification for the new port

Return type : ProcessWithPort

add_dynamic_output_port

Add a dynamic output port to the process.

port_spec_dto : IOSpecDTO | None

Optional specification for the new port

Return type : ProcessWithPort

add_dynamic_param

Add a dynamic parameter specification to the process.

config_spec_name : str

Name of the dynamic config spec (e.g. 'params')

param_name : str

Name of the parameter to add

spec_dto : ParamSpecDTO

Specification of the parameter

delete_dynamic_input_port

Delete a dynamic input port from the process.

port_name : str

Name of the port to delete

delete_dynamic_output_port

Delete a dynamic output port from the process.

port_name : str

Name of the port to delete

delete_process

Delete the process from its parent protocol. If the process is not in draft status, it is reset first.

get_first_inport

Return type : ProcessWithPort

get_first_outport

Return type : ProcessWithPort

get_input

Retrieve the resource of the input.

name : str

name of the input port

resource_type : type[ResourceType] | None

if provided, check that the resource is of this type and return it as this type

Return type : Resource | ResourceType | None

get_input_port

Access input port information of a process to create connectors in protocol

port_name : str

Return type : ProcessWithPort

get_input_ports

Access all input port information of a process to create connectors in protocol

Return type : list[ProcessWithPort]

get_input_resource_model

retrieve the resource model of the input

name : str

name of the input port

Return type : ResourceModel | None

get_model

Return type : ProcessModel

get_model_id

Return type : str

get_output

Retrieve the resource of the output.

name : str

name of the output port

resource_type : type[ResourceType] | None

if provided, check that the resource is of this type and return it as this type

Return type : Resource | ResourceType | None

get_output_port

Access output port information of a process to create connectors in protocol

port_name : str

Return type : ProcessWithPort

get_output_ports

Access all output port information of a process to create connectors in protocol

Return type : list[ProcessWithPort]

get_output_resource_model

retrieve the resource model of the output

name : str

name of the output port

Return type : ResourceModel | None

get_param

name : str

Return type : Any

get_process_type

Return type : type[Process]

has_dynamic_inputs

Return type : bool

has_dynamic_outputs

Return type : bool

has_parent_protocol

Return type : bool

is_input_task

Return type : bool

is_output_task

Return type : bool

refresh

Return type : ProcessProxy

remove_dynamic_param

Remove a dynamic parameter specification from the process.

config_spec_name : str

Name of the dynamic config spec (e.g. 'params')

param_name : str

Name of the parameter to remove

reset_config

reset_process

Reset the process, clearing its execution results and impacted entities.

set_config_params

Set the config param values

config_params : ConfigParamsDict

set_param

Set the param value

param_name : str

value : ParamValue

update_dynamic_input_port

Update the specification of a dynamic input port.

port_name : str

Name of the port to update

port_spec_dto : IOSpecDTO

New specification for the port

update_dynamic_output_port

Update the specification of a dynamic output port.

port_name : str

Name of the port to update

port_spec_dto : IOSpecDTO

New specification for the port

update_dynamic_param

Update a dynamic parameter specification of the process.

config_spec_name : str

Name of the dynamic config spec (e.g. 'params')

param_name : str

Name of the parameter to update

spec_dto : ParamSpecDTO

New specification of the parameter

Have you developed a brick?