Base abstract class for Process and Protocol
:param Viewable: [description] :type Viewable: [type]
config: Config
data: Dict[str, Any]
error_info: ProcessErrorInfo
layout: ProtocolLayout
progress_bar: ProgressBar
scenario: Scenario
status: ProcessStatus
style: TypingStyle
Constructor
Adds a connector to the pfrotocol.
str
str
str
str
Connector
List
str
str
str
IOface
Dict
Dict
str
str
str
IOface
Dict
Dict
Adds a process to the protocol.
ProcessModel
str
Return True if all the processes are in draft
bool
Return True if all the processes are in success
bool
bool
- True
bool
- True
remove the connector which right side is connected to the specified port of the specified process return the list of deleted connectors
str
str
Optional
remove the connector which left side is connected to the specified port of the specified process It can remove multiple connectors if there are multiple connectors connected to the same port Return the list of deleted connectors
str
str
bool
- False
Generate a unique interface name
str
Generate a unique outerface name
str
Generate a unique instance name from an instance_name by adding _1 or _2... to the end of the instance name
str
str
Returns all the next processes of a process in this protocol and parent protocols.
str
bool
- True
bool
- False
Set
Return all the processes of the protocol and its sub protocols, sorted by start date
List
str
bool
Returns a connector by the destination process and port
str
str
Optional
Returns a connector by the destination process and port
str
str
List
Calculate the current progress of the protocol. It excludes the auto run processes and count finished processes as 100% and running processes as their progress
ScenarioProgressDTO
Returns the next processes of a process.
str
Set
Returns the previous processes of a process.
str
Set
Optional[ProcessErrorInfo]
List
Return the execution time of the process
float
Return the graph json object
ProtocolMinimumDTO
Set
return the instance name in the context
str
Return the instance path
str
Returns the interfaces linked to a process
str
List
Return the last message of the process
Optional[ProgressBarMessageDTO]
Return the name of the process
str
Returns the outerface linked to the process with the given name
str
List
Returns a process by its name.
str
ProcessModel
Returns a process by its instance path.
str
ProcessModel
Type[Process]
Typing
Return the last message of the process
float
return a string with the information up to the main protocol
str
Return the running process, go through all the sub protocols
Optional
Return True if the protocol has finished processes (except the auto run processes)
bool
Returns the port of the inputs by its name.
str
InPort
List
bool
- True
ProtocolSubProcessBuilder
Return true if the process is automatically run when added to a protocol
bool
Return true if the process is enable in sub protocol
bool
return true if the process is of type InputTask
bool
Returns True if the input poort the process is an interface of the protocol
str
bool
Returns True if the input poort the process is an outerface of the protocol
str
bool
return true if the process is of type OutputTask
bool
bool
bool
Returns True if the model is saved in db, False otherwise
bool
ProcessErrorInfo
ProcessRunException
str
Returns the port of the outputs by its name.
str
OutPort
Return True if the port of the process is an interface of the protocol
str
Any
bool
ProcessModel
bool
ModelType
Refresh the graph json object inside the data from the dump method
Refresh the status of the protocol based on the status of its processes
bool
- True
Remove an interface
str
Remove the interface linked the process with the given name
str
str
Remove the outerfaces linked to the process with the given name
str
str
Method to replace each Input process with an interface and each Output process with an outerface. It does not replace on sub protocols
Run the process and save its state in the database.
Run all the auto run processes of the protocol
Method to run a single process of the protocol
str
Override save to save the inputs and outputs
'ProcessModel'
ProtocolModel
Save the process run stat. If it's a autorun process, it doesnt save.
Set the config object
Config
Set a value of the config
str
Any
Set the config values
ConfigParamsDict
ProcessErrorInfo
Set the inputs from a DTO
IODTO
bool
- False
Set the inputs from specs
IOSpecs
Dict
Dict
Set the outputs from a DTO
IODTO
bool
- False
Set the outputs from specs
IOSpecs
Sets the parent protocol of the process
ProtocolModel
Type[Process]
Any
Return the config DTO
bool
- False
ProcessConfigDTO
ProcessDTO
Return the minium json to recognize this process
ProcessMinimumDTO
bool
- False
ProtocolGraphConfigDTO
ProtocolDTO
ProtocolFullDTO
ProtocolMinimumDTO
Any
Method call after all the table are inited
Useful when use DeferredForeignKey to create the foreign key manually latter
Method call after the table is created
Usefull to create the full text indexes
Any
Any
bool
- True
bool
- True
Any
Any
bool
- True
bool
- True
Any
Any
Any
Any
Any
Returns the name of the class
bool
- False
bool
- False
bool
- False
str
Returns True if the column exists in the table
str
bool
Any
Create a foreign key for a Foreign key field only if the foreign key does not exists
ForeignKeyField
Method to create a full text index
List
str
Create model table
Any
Drop model table
Execute a raw SQL query. Can use the [TABLE_NAME] to replace by the table name
str
Any
Any
str
bool
Returns the full name of the class
bool
- False
bool
- False
str
Any
Any
str
Optional
Get by ID and throw 404 error if object not found
str
ModelType
List
List
DatabaseProxy
Returns the (current) DbManager of this model
Type
Any
Any
Returns the table name of this class
str
Any
Returns True if the index exists in the table
str
bool
Get all the classes that inherit this class
List
Any
Any
Any
Any
Any
Any
Any
Any
Any
Any
Any
Any
Performs full-text search on the field. Must be overrided by child class to work
str
str
ModelSelect
Any
Any
Any
Any
Any
Any
Any