CTRL + K
Stories
Apps
Agents
Bricks
Constellab Space LogoSpace
Login

gws_gena

Introduction
Getting Started
ID Card
Use Cases
Technical documentations
Version

ReconProto

ReconProto

Functions
__init__

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

add_connector

Add the connexion between 2 processes of the protocol self.add_connector(create >> 'robot', move << 'robot')

from_part : ConnectorPartSpec
[description]
to_part : ConnectorPartSpec
[description]
add_connectors

Add the connexion between processes of the protocol self.add_connectors([ (create >> 'robot', move << 'robot'), (move >> 'robot', eat << 'robot'), ])

connections : List[Tuple[ConnectorPartSpec, ConnectorPartSpec]]
[description]
add_interface

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

name : str
name of the interface
from_process : ProcessSpec
process that will be plugged to the interface
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

name : str
name of the interface
to_process : ProcessSpec
process_output_name : str
add_process

Add a process to this protocol. The process_type can be a task or a protocol

process_type : Type[Process]
[description]
instance_name : str
[description]
config_params : ConfigParamsDict
[description]
Return type : ProcessSpec
configure_protocol

Extend this method to configure the protocol ( In this method you can reate sub process, add connectors and configure interface and outerface

Here is a simpe exemple to configure a protocol

Add the processes

create: processSpec = self.register_process(RobotCreate, "create") move: processSpec = self.register_process(RobotMove, "move") eat: processSpec = self.register_process(RobotEat, "eat")

Add the connexion between processes

self.add_connectors([ (create >> 'robot', move << 'robot'), (move >> 'robot', eat << 'robot'), ])

Configure protocol interface and outerfaces

self.add_interface('robot', move_1, 'robot') self.add_outerface('robot', eat_2, 'robot')

get_create_config

DO NOT OVERIDE This methdo return the parameters to create the protocol

Return type : ProtocolCreateConfig
get_input_specs_self
Return type : InputSpecs
get_output_specs_self
Return type : OutputSpecs
get_process_spec

Get the process spec of the process with the given instance name

instance_name : str
Return type : ProcessSpec
classname @classmethod

Returns the name of the class

slugify : bool - False
True to slugify the class name if True
snakefy : bool - False
True to snakefy the class name if True
replace_uppercase : bool - False
Replace upper cases by "-" if True
Return type : str
full_classname @classmethod

Returns the full name of the class

slugify : bool - False
Slugify the returned class name if True
snakefy : bool - False
Snakefy the returned class name if True
Return type : str
get_brick_name @classmethod
Return type : str
get_brick_version @classmethod
Return type : Version
get_human_name @classmethod

Get the human name of the object

Return type : str
get_input_specs @classmethod

Get the input specs of the protocol

Return type : InputSpecs
get_output_specs @classmethod

Get the input specs of the protocol

Return type : OutputSpec
get_short_description @classmethod

Get the short description of the object

Return type : str
get_style @classmethod

Get the style of the object

Return type : TypingStyle
get_typing_name @classmethod

Get the typing name of the object Ex: 'RESOURCE.gws_core.Table'

Return type : str
get_typing_name_obj @classmethod
Return type : TypingNameObj
inheritors @classmethod

Get all the classes that inherit this class

Return type : List
instantiate_protocol @classmethod

Instantiate the protocol with the default config

Return type : Protocol