Package schrodinger :: Package tasks :: Module jobtasks :: Class CmdJobTask
[hide private]
[frames] | no frames]

Class CmdJobTask

                                    object --+            
                                             |            
ui.qt.appframework2.validation.ValidationMixin --+        
                                                 |        
                object --+                       |        
                         |                       |        
         sip.simplewrapper --+                   |        
                             |                   |        
                   sip.wrapper --+               |        
                                 |               |        
              PyQt5.QtCore.QObject --+           |        
                                     |           |        
                      parameters.Param --+       |        
                                         |       |        
                  parameters.CompoundParam --+   |        
                                             |   |        
                         parameters.ParamModel --+        
                                                 |        
                                tasks.AbstractTask --+    
                                                     |    
                                       AbstractJobTask --+
                                                         |
                                                        CmdJobTask

Nested Classes [hide private]

Inherited from parameters.CompoundParam: __metaclass__

Inherited from parameters.Param: NO_VALUE

Instance Methods [hide private]
 
_launchCmd(self, cmd)
bool
_start(self)
Override this method in subclasses to implement the actual task starting logic.
 
makeCmdList(self)
This is the main method that needs to be implemented to define a specific cmd job runner.

Inherited from AbstractJobTask: __init__, appendConfigFlags, fullCmdList, getSchrodingerRun, getWriteFilename, isRunning, job_configChanged, job_dirChanged, job_optionsChanged, makeSchrodingerCmd, start, updateStatusText, write

Inherited from AbstractJobTask (private): _getViewname, _makeCmdList, _writeCmd

Inherited from tasks.AbstractTask: __repr__, __str__, base_nameChanged, getName, nameChanged, postStart, preProcess, preValidate, reportValidation, setStatus, status, statusChanged, status_paramChanged

Inherited from ui.qt.appframework2.validation.ValidationMixin: runValidation

Inherited from ui.qt.appframework2.validation.ValidationMixin (private): _validate, _validateChildren

Inherited from parameters.CompoundParam: __eq__, __ne__, fromJson, isDefault, setValue, toDict, toJson

Inherited from parameters.CompoundParam (private): _defaultValue

Inherited from parameters.Param: __get__, __set__, ownerChain, valueChanged

Inherited from PyQt5.QtCore.QObject: __getattr__, blockSignals, childEvent, children, connectNotify, customEvent, deleteLater, destroyed, disconnect, disconnectNotify, dumpObjectInfo, dumpObjectTree, dynamicPropertyNames, event, eventFilter, findChild, findChildren, inherits, installEventFilter, isSignalConnected, isWidgetType, isWindowType, killTimer, metaObject, moveToThread, objectName, objectNameChanged, parent, property, pyqtConfigure, receivers, removeEventFilter, sender, senderSignalIndex, setObjectName, setParent, setProperty, signalsBlocked, startTimer, thread, timerEvent, tr

Inherited from sip.simplewrapper: __new__

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __subclasshook__

Class Variables [hide private]

Inherited from AbstractJobTask: job_config, job_dir, job_options

Inherited from tasks.AbstractTask: base_name, name, status_param

Inherited from parameters.Param: DataClass, is_abstract

Inherited from PyQt5.QtCore.QObject: staticMetaObject

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

_start(self)

 

Override this method in subclasses to implement the actual task starting logic. This is called after all preprocessing and validation have passed.

Returns: bool
whether the task was succesfully started
Overrides: tasks.AbstractTask._start
(inherited documentation)

makeCmdList(self)

 

This is the main method that needs to be implemented to define a specific cmd job runner. It should just return a complete cmd list for the job to be launched. Standard job options should be left off.

Overrides: AbstractJobTask.makeCmdList