CTRL + K
Apps
Stories
Agents
Bricks
Constellab Space LogoSpace
Login
Back to bricks list
Introduction
Getting Started
ID Card
Use Cases
Technical documentations
Version

Flat twin

RESOURCE
Typing name :  RESOURCE.gws_gena.FlatTwin Brick :  gws_gena
Parent :
Twin

Flat digital twin of cell metabolism

FlatTwin

A flat digital twin of cell metabolism

Views
RESOURCES LISTDefault view
List the resources
VIEW RESOURCE
View the complete resource as json
SUMMARY
JSONVIEW
Functions
__INIT__

Constructor, please do not overwrite this method, use the init method instead Leave the constructor without parameters.

ADD_CONTEXT

Add a context to the twin

ctx : Context
related_network : Network - None
A network related to the context
ADD_NETWORK

Add a network to the twin

network : Network
The network to add
related_context : Context - None
A context related to the network
ADD_RESOURCE

Add a resource to the set

resource : Resource
resource to Add
unique_name : str - None
name used to store the resource in the dict. It must be unique. The resource can be retrieve by calling the get_resource method with the name. If not provided, the resource name is used
create_new_resource : bool - True
If true, a new resource is created when saving the resource. Otherwise it doesn't create a new resource but references it. In this case the resource must be an input of the task that created the ResourceSet and the resource must have been saved before
ADD_TECHNICAL_INFO

Add technical information on the resource. Technical info are useful to set additional information on the resource.

technical_info : TechnicalInfo
technical information to add (key, value)
CHECK_RESOURCE

You can redefine this method to define custom logic to check this resource. If there is a problem with the resource, return a string that define the error, otherwise return None This method is called on output resources of a task. If there is an error returned, the task will be set to error and next proceses will not be run. It is also call when uploading a resource (usually for files or folder), if there is an error returned, the resource will not be uploaded

Return type : Union[str, NoneType]
CLEAR_RESOURCES
CLONE

Clone the resource to create a new instance with a new id. It copies the RFields.

Return type : ResourceType
COPY

Copy the twin

Return type : FlatTwin
DUMPS

Dump the twin

DUMPS_FLAT

Generate a flat dump of the twin

Return type : dict
FLATTEN

Flatten the twin

Return type : FlatTwin
GET_DEFAULT_NAME

You can redefine this method to set a name of the resource. When saving the resource the name will be saved automatically This can be useful to distinguish this resource from another one or to search for the resource

Return type : str
GET_FLAT_CONTEXT

Get the flat context

GET_FLAT_NETWORK

Get the flat network

GET_RESOURCE
resource_name : str
Return type : Resource
GET_RESOURCE_IDS
Return type : Set
GET_RESOURCE_MODELS
Return type : List
GET_RESOURCES
Return type : Dict
GET_RESOURCES_AS_SET
Return type : Set
GET_SUMMARY
GET_TECHNICAL_INFO

Get the technical information of the resource

key : str
key of the technical information
Return type : TechnicalInfo
INIT

This can be overwritten to perform custom initialization of the resource. This method is called just after the init (constructor) of the resource. The default values of RFields are set before this method is called.

REMOVE_ALL_CONTEXTS

Remove all the contexts

RESOURCE_EXISTS
resource_name : str
Return type : Resource