ProtocolProxy - gws_core

This class can be used in a Jupyter Notebook to create and configure a protocol

To create it use the add_protocol method on another protocol

Functions

__INIT__

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

Parameters:

Name	Type	Default value	Description
protocol_model	`ProtocolModel`

ADD_CONNECTOR

Add a connector between to process of this protocol

Exemple : protocol.add_connector(create.get_output_port('robot'), sub_proto.get_input_port('robot_i')) OR protocol.add_connector(create >> 'robot', sub_proto << 'robot_i')

Parameters:

Name	Type	Default value	Description
out_port	`ProcessWithPort`
in_port	`ProcessWithPort`

ADD_CONNECTOR_NEW

Add a connector between to process of this protocol

Exemple : protocol.add_connector('create', 'robot', 'sub_proto','robot_i')

Parameters:

Name	Type	Default value	Description
from_process_name	`str`
from_port_name	`str`
to_process_name	`str`
to_port_name	`str`

ADD_CONNECTORS

Add multiple connector inside the protocol

Exemple : protocol.add_connectors([ (create >> 'robot', sub_proto << 'robot_i'), (sub_proto.get_output_port('robot_o'), robot_travel.get_input_port('robot')) ])

Parameters:

Name	Type	Default value	Description
connectors	`List`

ADD_EMPTY_PROTOCOL

Add an empty protocol to this protocol

Parameters:

Name	Type	Default value	Description
instance_name	`str`

Return type:

ProtocolProxy

ADD_INTERFACE

Add an interface to link an input of the protocol to the input of one of the protocol's process

Parameters:

Name	Type	Description
name	`str`	Name of the interface
from_process_name	`str`
process_input_name	`str`	Name of the process input to plug

ADD_OUTERFACE

Add an outerface to link the output of one of the protocol's process to the output of the protocol

Parameters:

Name	Type	Description
name	`str`	Name of the interface
to_process_name	`str`
process_ouput_name	`str`	Name of the process output to plug

ADD_OUTPUT

Add an output task to the protocol that receive the out_port resource

Parameters:

Name	Type	Default value	Description
instance_name	`str`		Instance name of the task
out_port	`ProcessWithPort`		Out_port connect to connect to the output task outport
flag_resource	`bool`	True	Flag the resource, defaults to true , optional

Return type:

TaskProxy

ADD_PROCESS

Add a process (task or protocol) to this protocol. This process is automatically saved in the database

Parameters:

Name	Type	Default value	Description
process_type	`Type`
instance_name	`str`
config_params	`Dict`

Return type:

ProcessProxy

ADD_PROTOCOL

Add a protocol from a protocol type

Parameters:

Name	Type	Default value	Description
protocol_type	`Type`
instance_name	`str`
config_params	`Dict`

Return type:

ProtocolProxy

ADD_RESOURCE

Add a resource to the protocol and connected it to the in_port

Parameters:

Name	Type	Description
instance_name	`str`	Instance name of the task
resource_model_id	`str`	The id of the resource model the source will provided as input
in_port	`ProcessWithPort`	The in port that should receive the resource. if none, the resource is added to the protocol without connection inport

Return type:

TaskProxy

ADD_SINK

Add an output task to the protocol that receive the out_port resource

Parameters:

Name	Type	Default value	Description
instance_name	`str`		Instance name of the task
out_port	`ProcessWithPort`		Out_port connect to connect to the output task outport
flag_resource	`bool`	True	Flag the resource, defaults to true , optional

Return type:

TaskProxy

ADD_SOURCE

Add a Source task to the protocol and connected it to the in_port

Parameters:

Name	Type	Description
instance_name	`str`	Instance name of the task
resource_model_id	`str`	The id of the resource model the source will provided as input
in_port	`ProcessWithPort`	The in port that should receive the resource inport

Return type:

TaskProxy

ADD_TASK

Add a task to this

Parameters:

Name	Type	Default value	Description
task_type	`Type`
instance_name	`str`
config_params	`Dict`

Return type:

TaskProxy

DELETE_INTERFACE

Delete an interface of the protocol

Parameters:

Name	Type	Default value	Description
name	`str`

DELETE_OUTERFACE

Delete an outerface of the protocol

Parameters:

Name	Type	Default value	Description
name	`str`

DELETE_PROCESS

Parameters:

Name	Type	Default value	Description
instance_name	`str`

GET_FIRST_INPORT

Return type:

ProcessWithPort

GET_FIRST_OUTPORT

Return type:

ProcessWithPort

GET_INPUT

retrieve the resource of the input

Parameters:

Name	Type	Default value	Description
name	`str`		[description]

Return type:

Resource

GET_INPUT_PORT

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

Parameters:

Name	Type	Default value	Description
port_name	`str`

Return type:

ProcessWithPort

GET_INPUT_RESOURCE_MODEL

retrieve the resource model of the input

Parameters:

Name	Type	Default value	Description
name	`str`		[description]

Return type:

ResourceModel

GET_MODEL

Return type:

ProtocolModel

GET_MODEL_ID

Return type:

str

GET_OUTPUT

retrieve the resource of the output

Parameters:

Name	Type	Default value	Description
name	`str`		[description]

Return type:

Resource

GET_OUTPUT_PORT

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

Parameters:

Name	Type	Default value	Description
port_name	`str`

Return type:

ProcessWithPort

GET_OUTPUT_RESOURCE_MODEL

retrieve the resource model of the output

Parameters:

Name	Type	Default value	Description
name	`str`		[description]

Return type:

ResourceModel

GET_PARAM

Parameters:

Name	Type	Default value	Description
name	`str`

Return type:

Any

GET_PROCESS

retreive a protocol or a task in this protocol

:raises Exception: [description]

Parameters:

Name	Type	Default value	Description
instance_name	`str`		[description]

Return type:

ProcessProxy

GET_PROCESS_TYPE

Return type:

Type[Process]

REFRESH

Return type:

ProcessProxy

RESET_CONFIG

SET_CONFIG_PARAMS

Set the config param values

Parameters:

Name	Type	Default value	Description
config_params	`Dict`

SET_INPUT

Set the resource of an input. If you want to manually set the input resource of a process

Parameters:

Name	Type	Default value	Description
name	`str`		[description]
resource	`Resource`		[description]

SET_PARAM

Set the param value

Parameters:

Name	Type	Default value	Description
param_name	`str`
value	`Any`

GET_BY_ID - @classmethod

Parameters:

Name	Type	Default value	Description
id	`str`

Return type:

ProtocolProxy