Public Member Functions | |
| def | __init__ |
| def | addAction |
| def | getDescription |
| def | printActionList |
| def | run |
| def | setDescription |
| def | validateReactionReferences |
Public Attributes | |
| actionList | |
| currentItem | |
| description | |
| editReturnValues | |
| pause | |
Private Member Functions | |
| def | __getElement |
| def | __getIndex |
| def | __hasElement |
| def | __waitOnPause |
A CobTask is a list of CobActions or other CobTasks. Each list element consists of a unique identifier, the CobAction itself and a dictionary which relates each possible return value of the current CobAction to the identifier of the next CobAction to be processed. The run-routine also provides means to check, if the script is generally in PAUSE-status.
Definition at line 21 of file cob_actions.py.
| def cob_actions::CobTask::__getElement | ( | self, | ||
| identifier | ||||
| ) | [private] |
Definition at line 156 of file cob_actions.py.
| def cob_actions::CobTask::__getIndex | ( | self, | ||
| identifier | ||||
| ) | [private] |
Definition at line 168 of file cob_actions.py.
| def cob_actions::CobTask::__hasElement | ( | self, | ||
| identifier | ||||
| ) | [private] |
Definition at line 162 of file cob_actions.py.
| def cob_actions::CobTask::__init__ | ( | self, | ||
| description | ||||
| ) |
Definition at line 28 of file cob_actions.py.
| def cob_actions::CobTask::__waitOnPause | ( | self | ) | [private] |
Definition at line 174 of file cob_actions.py.
| def cob_actions::CobTask::addAction | ( | self, | ||
| identifier, | ||||
| action, | ||||
| parameterTuple, | ||||
background = False, |
||||
reactionDict = None | ||||
| ) |
generate one row in the actionList which is a list itself
-> [uniqueIdentifier, CobAction, backgroundFlag, {returnValue: next uniqueIdentifier,...}Definition at line 104 of file cob_actions.py.
| def cob_actions::CobTask::getDescription | ( | self | ) |
Definition at line 134 of file cob_actions.py.
| def cob_actions::CobTask::printActionList | ( | self, | ||
indent = 0 | ||||
| ) |
print action list in a human readable form including subtasks
Definition at line 137 of file cob_actions.py.
| def cob_actions::CobTask::run | ( | self | ) |
The elements of the actionList are executed one by one. Depending on the return value, the appropriate reaction is chosen and the next element is processed
Definition at line 35 of file cob_actions.py.
| def cob_actions::CobTask::setDescription | ( | self, | ||
| description | ||||
| ) |
Definition at line 131 of file cob_actions.py.
| def cob_actions::CobTask::validateReactionReferences | ( | self | ) |
Check if all references in the reaction dicts lead someware
Definition at line 193 of file cob_actions.py.
Definition at line 30 of file cob_actions.py.
Definition at line 31 of file cob_actions.py.
Definition at line 29 of file cob_actions.py.
Definition at line 33 of file cob_actions.py.
Definition at line 32 of file cob_actions.py.