Package Task :: Module Base :: Class Task

Class Task

          object --+            
                   |            
Tools.Base.TaskTools --+        
                       |        
     Tools.Output.Output --+    
                           |    
          object --+       |    
                   |       |    
Tools.Base.TaskTools --+   |    
                       |   |    
       Tools.Input.Input --+    
                           |    
          object --+       |    
                   |       |    
Tools.Base.TaskTools --+   |    
                       |   |    
         Tools.View.View --+    
                           |    
          object --+       |    
                   |       |    
Tools.Base.TaskTools --+   |    
                       |   |    
       Tools.Utils.Utils --+    
                           |    
          object --+       |    
                   |       |    
Tools.Base.TaskTools --+   |    
                       |   |    
     Tools.System.System --+    
                           |    
                   Tools.All --+
                               |
                  object --+   |
                           |   |
               UIElement.UIE --+
                               |
                              Task

Most base class for all Tasks that execute in a Perk. Stores a string identifying a particular class instance. Implements UIElement to provide information to the user about its purpose even though it is not managed by the UIRegistrar.

Instance Methods

[hide private]

__init__(self, ident)
Stores the Task identifier.

source code

boolean

execute(self, **kwargs)
Executes this Task in response to an event.

source code

update(self, **kwargs)
Allows this Task to update itself in response to an event that was consumed by another Task that executed before it.

source code

string

getIdentity(self)
Gets the unique string identity assigned to this Task.

source code

Perk

getPerk(self)
Gets the Perk in which this Task was registered.

source code

string

getPath(self)
Returns: Absolute path location of the module containing the implementor of this interface

source code

Inherited from Tools.Output.Output: getBrlEllipsisSizes, getBrlMissingCellCount, getClosestLang, getMagROI, getOutputDevice, getPerkIdealOutput, getStyle, getStyleSetting, getStyleVal, inhibitMayStop, mayStop, play, say, sayApp, sayChar, sayColor, sayConfirm, sayCount, sayDesc, sayError, sayFont, sayHotkey, sayIndex, sayInfo, sayItem, sayLabel, sayLevel, sayName, sayRole, saySection, sayState, sayStatus, sayTextAttrs, sayValue, sayValueExtents, sayWindow, sayWord, send, setBrlCaretPosition, setBrlTruncate, setMagGoto, setPerkIdealOutput, setStyleVal, stopAll, stopNow

Inherited from Tools.Input.Input: addInputModifiers, getInputDevice, registerCommand, removeInputModifiers, unregisterCommand

Inherited from Tools.View.View: compareAncestorRoles, copyAccText, cutAccText, deleteAccText, deselectAccText, doAction, findAccByName, findAccByObjId, findAccByPredicate, findAccByRole, getAccActionDescs, getAccActionKeys, getAccActionNames, getAccAllTextAttrs, getAccAnchorCount, getAccAppLocale, getAccAtRowColumn, getAccAttrs, getAccCaret, getAccClickKey, getAccColumn, getAccColumnHeader, getAccCount, getAccDefTextAttrs, getAccDesc, getAccFloatValue, getAccFloatValueExtents, getAccFocus, getAccFromPath, getAccIndex, getAccLabel, getAccLevel, getAccName, getAccPosInSet, getAccPosition, getAccRelations, getAccRole, getAccRoleName, getAccRow, getAccRowHeader, getAccSetSize, getAccTableExtents, getAccText, getAccTextAttr, getAccTextBetween, getAccTextLength, getAccTextSelection, getAccTextSelectionCount, getAccURI, getAccVisualExtents, getAccVisualPoint, getAllSelected, getAppName, getCharText, getChildAcc, getCurrItem, getCurrRow, getCurrWord, getEndAcc, getEndOfHardLine, getFirstPeerAcc, getFirstSelected, getItemText, getLastAccUnder, getLastChar, getLastKey, getLastPeerAcc, getLastWord, getNextAcc, getNextChar, getNextItem, getNextPeerAcc, getNextRow, getNextWord, getParentAcc, getPointerPOR, getPrevAcc, getPrevChar, getPrevItem, getPrevPeerAcc, getPrevRow, getPrevWord, getRootAcc, getStartOfHardLine, getStateText, getViewRootAcc, getWindowTitle, getWordText, hasAccRole, hasAccState, hasOneAccRole, hasOneAccState, inhibitAutoPointer, insertAccText, iterAncestorAccs, iterNextAccs, iterNextItems, iterPrevAccs, iterPrevItems, leftClickPOR, mouseEventPOR, moveToEnd, moveToItemStart, moveToPOR, moveToPointer, moveToRoot, pasteAccText, selectAccText, setAccCaret, setAccDeselected, setAccFocus, setAccPOR, setAccSelected, setAccText, setAccTextAttrs, setAllDeselected, setAllSelected, setPointerPOR

Inherited from Tools.Utils.Utils: convertPOSIXToIANA, getColorString

Inherited from Tools.System.System: associateDevice, associateMonitor, associatePerk, blockNTasks, chainTask, disassociateDevice, disassociateMonitor, disassociatePerk, doTask, getAnchorPerkClassName, getAnchorTaskId, getChooserClassNames, getChooserDescriptions, getChooserMetadata, getChooserNames, getDeviceClassNames, getDeviceDescriptions, getDeviceMetadata, getDeviceNames, getDeviceState, getEventTasks, getHistory, getMonitorClassNames, getMonitorDescriptions, getMonitorMetadata, getMonitorNames, getNamedTask, getPerkByName, getPerkClassNames, getPerkDescriptions, getPerkHistory, getPerkMetadata, getPerkNames, getPerkSetting, getPerkSettingVal, getPerkState, getPerkTaskNames, getPerkVar, getProfileName, getTaskHistory, getTempVal, getTierEventTasks, getTierNamedTask, getTierTaskNames, insertPerk, loadAllMonitors, loadChooser, loadMonitor, popPerk, popThisPerk, pushPerk, refreshDevices, registerConstants, registerTask, reloadPerks, setPerkSettingVal, setPerkVar, setTempVal, unchainTask, unloadAllMonitors, unloadChooser, unloadMonitor, unregisterTask

Inherited from Tools.System.System (private): _getClassNames, _getDescriptions, _getNames, _getUIEInstances

Inherited from Tools.Base.TaskTools: close, init, postClose, postExecute, preExecute, preInit

Inherited from Tools.Base.TaskTools (private): _changeDefaultOutput

Inherited from UIElement.UIE: getClassName, getDescription, getName

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Class Variables

[hide private]

Inherited from Tools.Output.Output: may_stop

Inherited from Tools.View.View (private): _state_descriptions

Instance Variables

[hide private]

string

ident
Programmatic identifier for this Task

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, ident)
(Constructor)

source code

Stores the Task identifier.

Parameters:

ident (string) - Programmatic identifier

Overrides: Tools.Base.TaskTools.__init__

execute(self, **kwargs)

source code

Executes this Task in response to an event. Called by Tier.Tier._executeTask.

Parameters:

kwargs (dictionary) - Dictionary containing parameters passed to a task.

Returns: boolean

Should processing continue? Always returns True by default.

update(self, **kwargs)

source code

Allows this Task to update itself in response to an event that was consumed by another Task that executed before it. Called by Tier.Tier._executeTask.

Parameters:

kwargs (dictionary) - Dictionary containing parameters passed to a task.

getIdentity(self)

source code

Gets the unique string identity assigned to this Task.

Returns: string

Identity of this Task

Raises:

ValueError - When ident is None, meaning this Task has no unique identity

getPerk(self)

source code

Gets the Perk in which this Task was registered.

Returns: Perk: Reference to the Perk

getPath(self)

source code

Returns: string: Absolute path location of the module containing the implementor of this interface
Overrides: UIElement.UIE.getPath

Class Task

__init__(self, ident) (Constructor)

execute(self, **kwargs)

update(self, **kwargs)

getIdentity(self)

getPerk(self)

getPath(self)

init(self, ident)
(Constructor)