ProtocolModel
Base abstract class for Process and Protocol
:param Viewable: [description] :type Viewable: [type]
config: Configdata: Dict[str, Any]error_info: ProcessErrorInfolayout: ProtocolLayoutparent_protocol_id: strprogress_bar: ProgressBarscenario: Scenariostatus: ProcessStatusstyle: TypingStyleConstructor
Adds a connector to the pfrotocol.
strstrstrstrConnectorListstrstrstrIOfaceDictDictstrstrstrIOfaceDictDictAdds a process to the protocol.
ProcessModelstrReturn True if all the processes are in draft
boolReturn True if all the processes are in success
boolReturn true if the process can be auto run now.
boolbool - Truebool - Trueremove the connector which right side is connected to the specified port of the specified process return the list of deleted connectors
strstrOptionalremove 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
strstrbool - FalseGenerate a unique interface name
strGenerate a unique outerface name
strGenerate a unique instance name from an instance_name by adding _1 or _2... to the end of the instance name
strstrReturns all the next processes of a process in this protocol and parent protocols.
strbool - Truebool - FalseSetReturn all the processes of the protocol and its sub protocols, sorted by start date
ListstrboolReturns a connector by the destination process and port
strstrOptionalReturns a connector by the destination process and port
strstrListCalculate the current progress of the protocol. It excludes the auto run processes and count finished processes as 100% and running processes as their progress
ScenarioProgressDTOReturns the next processes of a process.
strSetReturns the previous processes of a process.
strSetOptional[ProcessErrorInfo]ListReturn the execution time of the process
floatReturn the graph json object
ProtocolMinimumDTOSetreturn the instance name in the context
strReturn the instance path
strReturns the interfaces linked to a process
strListReturn the last message of the process
Optional[ProgressBarMessageDTO]Return the name of the process
strReturns the outerface linked to the process with the given name
strListReturns a process by its name.
strProcessModelReturns a process by its instance path.
strProcessModelType[Process]Optional[Typing]DictReturn the last message of the process
floatreturn a string with the information up to the main protocol
strReturn the running process, go through all the sub protocols
OptionalReturn True if the protocol has finished processes (except the auto run processes)
boolReturns the port of the inputs by its name.
strInPortListbool - TrueReturn true if the process is automatically run when added to a protocol
boolReturn true if the process is enable in sub protocol
boolreturn true if the process is of type InputTask
boolReturns True if the input poort the process is an interface of the protocol
strboolReturns True if the input poort the process is an outerface of the protocol
strboolreturn true if the process is of type OutputTask
boolboolboolReturns True if the model is saved in db, False otherwise
boolProcessErrorInfoProcessRunExceptionstrReturns the port of the outputs by its name.
strOutPortReturn True if the port of the process is an interface of the protocol
strAnyboolProcessModelboolCheck if the process typing exists
boolModelTypeRefresh 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 - TrueRemove an interface
strRemove the interface linked the process with the given name
strstrRemove the outerfaces linked to the process with the given name
strstrMethod 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
strOverride save to save the inputs and outputs
'ProcessModel'ProtocolModelSave the process run stat. If it's a autorun process, it doesnt save.
Set the config object
ConfigSet a value of the config
strAnySet the config values
ConfigParamsDictProcessErrorInfoSet the inputs from a DTO
IODTObool - FalseSet the inputs from specs
IOSpecsDictDictSet the outputs from a DTO
IODTObool - FalseSet the outputs from specs
IOSpecsSets the parent protocol of the process
ProtocolModelType[Process]AnyReturn the config DTO
bool - FalseProcessConfigDTOProcessDTOReturn the minium json to recognize this process
ProcessMinimumDTObool - FalseProtocolGraphConfigDTOProtocolDTOProtocolFullDTOProtocolMinimumDTOAnyCreate the foreign keys because it was deffered
Method call after the table is created
Usefull to create the full text indexes
AnyAnybool - Truebool - TrueAnyAnybool - Truebool - TrueAnyAnyAnyAnyAnyReturns the name of the class
bool - Falsebool - Falsebool - FalsestrReturns True if the column exists in the table
strboolAnyCreate a foreign key for a Foreign key field only if the foreign key does not exists
ForeignKeyFieldMethod to create a full text index
ListstrCreate model table
AnyDrop model table
Execute a raw SQL query. Can use the [TABLE_NAME] to replace by the table name
strAnyAnystrboolReturns the full name of the class
bool - Falsebool - FalsestrAnyAnystrOptionalGet by ID and throw 404 error if object not found
strModelTypeListListGet all the processes by parent protocol id
strList['ProcessModel']DatabaseProxyReturns the (current) DbManager of this model
TypeAnyAnyReturns the table name of this class
strAnyReturns True if the index exists in the table
strboolGet all the classes that inherit this class
ListAnyAnyAnyAnyAnyAnyAnyAnyAnyAnyAnyAnyPerforms full-text search on the field. Must be overrided by child class to work
strstrModelSelectAnyAnyAnyAnyAnyAnyAny