Package schrodinger :: Package tasks :: Module jobtasks :: Class AbstractJobTask

Class AbstractJobTask

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

Known Subclasses:

CmdJobTask

Nested Classes

[hide private]

Inherited from parameters.CompoundParam: __metaclass__

Inherited from parameters.Param: NO_VALUE

Instance Methods

[hide private]

__init__(self, *args, **kwargs)
x.__init__(...) initializes x; see help(type(x)) for signature

_getViewname(self)

start(self)
Start this task.

write(self)

_writeCmd(self, cmdlist)
Writes the given cmd to disk.

getWriteFilename(self)

isRunning(self)

makeSchrodingerCmd(self, *args)
Builds a $SCHRODINGER command string from all the args passed in.

getSchrodingerRun(self)
Returns the correct version of the $SCHRODINGER/run string.

fullCmdList(self)
Returns the full cmd list for the job.

_makeCmdList(self)
Gets the cmdlist and appends the standard flags.

makeCmdList(self)
Implement this to generate a cmdlist.

appendConfigFlags(self, cmdlist)

updateStatusText(self)

job_configChanged(...)

job_dirChanged(...)

job_optionsChanged(...)

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

Inherited from tasks.AbstractTask (private): _start

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 parameters.Param (private): _getValue, _propagateSignal, _setValue

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]

job_options = <JobOptions:job_options>

job_config = <JobConfig:job_config>

job_dir = <StringParam:job_dir>

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]

init(self, *args, **kwargs)
(Constructor)

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__: (inherited documentation)

start(self)

Start this task. This includes any preprocessing and validation checks. Any failures will prevent the task from running.

Overrides: tasks.AbstractTask.start: (inherited documentation)

isRunning(self)

Overrides: tasks.AbstractTask.isRunning

makeSchrodingerCmd(self, *args)

Builds a $SCHRODINGER command string from all the args passed in. The resulting string is suitable for use in a cmdlist and formatted for use in starting or writing the job depending on self.run_mode. In START mode, the $SCHRODINGER environment variable will be expanded. In WRITE mode, it will stay as $SCHRODINGER and the path will be delimited with linux-style forward slashes.

Example: self.makeSchrodingerCmd('utilities', 'my_utility') will return "${SCHRODINGER}/utilities/my_utility" in WRITE mode.

getSchrodingerRun(self)

Returns the correct version of the $SCHRODINGER/run string. This will depend on whether the intent is to start or to write the job.

fullCmdList(self)

Returns the full cmd list for the job. This will take into account the run_mode specified in the job_config.

_makeCmdList(self)

Gets the cmdlist and appends the standard flags. This will also do an explicit str cast on every element of the cmdlist.

makeCmdList(self)

Implement this to generate a cmdlist. This cmdlist will be used for write functionality.

Class AbstractJobTask

__init__(self, *args, **kwargs) (Constructor)

start(self)

isRunning(self)

makeSchrodingerCmd(self, *args)

getSchrodingerRun(self)

fullCmdList(self)

_makeCmdList(self)

makeCmdList(self)

init(self, *args, **kwargs)
(Constructor)